Stripe

Online payment processing for internet businesses

stripe.com ↗

Version

2026-03-25.dahlia

OpenAPI

3.0.0

Endpoints

587

Schemas

1359

Updated

about 6 hours ago

Payments payments billing finance

Use this API in your AI agent

Query structured spec data via REST or MCP. Get exactly what your agent needs.

Get API Key

Server URLs

https://api.stripe.com/

Authentication

basic bearer

Endpoints

Clear filters

GET POST PUT PATCH DELETE

Account 1 endpoints

GET /v1/account Retrieve account

Retrieves the details of an account.

operationId: GetAccount

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/account

Accounts 11 endpoints

GET /v1/accounts List all connected accounts

Returns a list of accounts connected to your platform via <a href="/docs/connect">Connect</a>. If you’re not a platform, the list is empty.

operationId: GetAccounts

Parameters

Name	In	Required	Type	Description
created	query	optional		Only return connected accounts that were created during the given date interval.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/accounts

GET /v1/accounts/{account} Retrieve account

Retrieves the details of an account.

operationId: GetAccountsAccount

Parameters

Name	In	Required	Type	Description
account	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/accounts/{account}

GET /v1/accounts/{account}/bank_accounts/{id} Retrieve an external account

Retrieve a specified external account for a given account.

operationId: GetAccountsAccountBankAccountsId

Parameters

Name	In	Required	Type	Description
account	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string	Unique identifier for the external account to be retrieved.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/accounts/{account}/bank_accounts/{id}

GET /v1/accounts/{account}/capabilities List all account capabilities

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

operationId: GetAccountsAccountCapabilities

Parameters

Name	In	Required	Type	Description
account	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/accounts/{account}/capabilities

GET /v1/accounts/{account}/capabilities/{capability} Retrieve an Account Capability

Retrieves information about the specified Account Capability.

operationId: GetAccountsAccountCapabilitiesCapability

Parameters

Name	In	Required	Type	Description
account	path	required	string
capability	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/accounts/{account}/capabilities/{capability}

GET /v1/accounts/{account}/external_accounts List all external accounts

List external accounts for an account.

operationId: GetAccountsAccountExternalAccounts

Parameters

Name	In	Required	Type	Description
account	path	required	string
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
object	query	optional	string	Filter external accounts according to a particular object type.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/accounts/{account}/external_accounts

GET /v1/accounts/{account}/external_accounts/{id} Retrieve an external account

Retrieve a specified external account for a given account.

operationId: GetAccountsAccountExternalAccountsId

Parameters

Name	In	Required	Type	Description
account	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string	Unique identifier for the external account to be retrieved.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/accounts/{account}/external_accounts/{id}

GET /v1/accounts/{account}/people List all persons

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

operationId: GetAccountsAccountPeople

Parameters

Name	In	Required	Type	Description
account	path	required	string
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
relationship	query	optional	object	Filters on the list of people returned based on the person's relationship to the account's company.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/accounts/{account}/people

GET /v1/accounts/{account}/people/{person} Retrieve a person

Retrieves an existing person.

operationId: GetAccountsAccountPeoplePerson

Parameters

Name	In	Required	Type	Description
account	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.
person	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/accounts/{account}/people/{person}

GET /v1/accounts/{account}/persons List all persons

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

operationId: GetAccountsAccountPersons

Parameters

Name	In	Required	Type	Description
account	path	required	string
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
relationship	query	optional	object	Filters on the list of people returned based on the person's relationship to the account's company.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/accounts/{account}/persons

GET /v1/accounts/{account}/persons/{person} Retrieve a person

Retrieves an existing person.

operationId: GetAccountsAccountPersonsPerson

Parameters

Name	In	Required	Type	Description
account	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.
person	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/accounts/{account}/persons/{person}

Applepay 2 endpoints

GET /v1/apple_pay/domains

List apple pay domains.

operationId: GetApplePayDomains

Parameters

Name	In	Required	Type	Description
domain_name	query	optional	string
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/apple_pay/domains

GET /v1/apple_pay/domains/{domain}

Retrieve an apple pay domain.

operationId: GetApplePayDomainsDomain

Parameters

Name	In	Required	Type	Description
domain	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/apple_pay/domains/{domain}

Applicationfees 4 endpoints

GET /v1/application_fees List all application fees

Returns a list of application fees you’ve previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.

operationId: GetApplicationFees

Parameters

Name	In	Required	Type	Description
charge	query	optional	string	Only return application fees for the charge specified by this charge ID.
created	query	optional		Only return applications fees that were created during the given date interval.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/application_fees

GET /v1/application_fees/{fee}/refunds/{id} Retrieve an application fee refund

By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.

operationId: GetApplicationFeesFeeRefundsId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
fee	path	required	string
id	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/application_fees/{fee}/refunds/{id}

GET /v1/application_fees/{id} Retrieve an application fee

Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.

operationId: GetApplicationFeesId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/application_fees/{id}

GET /v1/application_fees/{id}/refunds List all application fee refunds

You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the <code>limit</code> and <code>starting_after</code> parameters to page through additional refunds.

operationId: GetApplicationFeesIdRefunds

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/application_fees/{id}/refunds

Apps 2 endpoints

GET /v1/apps/secrets List secrets

List all secrets stored on the given scope.

operationId: GetAppsSecrets

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
scope	query	required	object	Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/apps/secrets

GET /v1/apps/secrets/find Find a Secret

Finds a secret in the secret store by name and scope.

operationId: GetAppsSecretsFind

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
name	query	required	string	A name for the secret that's unique within the scope.
scope	query	required	object	Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/apps/secrets/find

Balance 3 endpoints

GET /v1/balance Retrieve balance

Retrieves the current account balance, based on the authentication that was used to make the request. For a sample request, see <a href="/docs/connect/account-balances#accounting-for-negative-balances">Accounting for negative balances</a>.

operationId: GetBalance

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/balance

GET /v1/balance/history List all balance transactions

Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first. Note that this endpoint was previously called “Balance history” and used the path <code>/v1/balance/history</code>.

operationId: GetBalanceHistory

Parameters

Name	In	Required	Type	Description
created	query	optional		Only return transactions that were created during the given date interval.
currency	query	optional	string	Only return transactions in a certain currency. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
payout	query	optional	string	For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.
source	query	optional	string	Only returns transactions associated with the given object.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
type	query	optional	string	Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `reserve_hold`, `reserve_release`, `stripe_fee`, `stripe_fx_fee`, `stripe_balance_payment_debit`, `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/balance/history

GET /v1/balance/history/{id} Retrieve a balance transaction

Retrieves the balance transaction with the given ID. Note that this endpoint previously used the path <code>/v1/balance/history/:id</code>.

operationId: GetBalanceHistoryId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/balance/history/{id}

Balancesettings 1 endpoints

GET /v1/balance_settings Retrieve balance settings

Retrieves balance settings for a given connected account. Related guide: <a href="/connect/authentication">Making API calls for connected accounts</a>

operationId: GetBalanceSettings

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/balance_settings

Balancetransactions 2 endpoints

GET /v1/balance_transactions List all balance transactions

operationId: GetBalanceTransactions

Parameters

Name	In	Required	Type	Description
created	query	optional		Only return transactions that were created during the given date interval.
currency	query	optional	string	Only return transactions in a certain currency. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
payout	query	optional	string	For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.
source	query	optional	string	Only returns transactions associated with the given object.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
type	query	optional	string	Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `reserve_hold`, `reserve_release`, `stripe_fee`, `stripe_fx_fee`, `stripe_balance_payment_debit`, `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/balance_transactions

GET /v1/balance_transactions/{id} Retrieve a balance transaction

Retrieves the balance transaction with the given ID. Note that this endpoint previously used the path <code>/v1/balance/history/:id</code>.

operationId: GetBalanceTransactionsId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/balance_transactions/{id}

Billing 10 endpoints

GET /v1/billing/alerts List billing alerts

Lists billing active and inactive alerts

operationId: GetBillingAlerts

Parameters

Name	In	Required	Type	Description
alert_type	query	optional	string	Filter results to only include this type of alert.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
meter	query	optional	string	Filter results to only include alerts with the given meter.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/billing/alerts

GET /v1/billing/alerts/{id} Retrieve a billing alert

Retrieves a billing alert given an ID

operationId: GetBillingAlertsId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/billing/alerts/{id}

GET /v1/billing/credit_balance_summary Retrieve the credit balance summary for a customer

Retrieves the credit balance summary for a customer.

operationId: GetBillingCreditBalanceSummary

Parameters

Name	In	Required	Type	Description
customer	query	optional	string	The customer whose credit balance summary you're retrieving.
customer_account	query	optional	string	The account representing the customer whose credit balance summary you're retrieving.
expand	query	optional	array	Specifies which fields in the response should be expanded.
filter	query	required	object	The filter criteria for the credit balance summary.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/billing/credit_balance_summary

GET /v1/billing/credit_balance_transactions List credit balance transactions

Retrieve a list of credit balance transactions.

operationId: GetBillingCreditBalanceTransactions

Parameters

Name	In	Required	Type	Description
credit_grant	query	optional	string	The credit grant for which to fetch credit balance transactions.
customer	query	optional	string	The customer whose credit balance transactions you're retrieving.
customer_account	query	optional	string	The account representing the customer whose credit balance transactions you're retrieving.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/billing/credit_balance_transactions

GET /v1/billing/credit_balance_transactions/{id} Retrieve a credit balance transaction

Retrieves a credit balance transaction.

operationId: GetBillingCreditBalanceTransactionsId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string	Unique identifier for the object.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/billing/credit_balance_transactions/{id}

GET /v1/billing/credit_grants List credit grants

Retrieve a list of credit grants.

operationId: GetBillingCreditGrants

Parameters

Name	In	Required	Type	Description
customer	query	optional	string	Only return credit grants for this customer.
customer_account	query	optional	string	Only return credit grants for this account representing the customer.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/billing/credit_grants

GET /v1/billing/credit_grants/{id} Retrieve a credit grant

Retrieves a credit grant.

operationId: GetBillingCreditGrantsId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string	Unique identifier for the object.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/billing/credit_grants/{id}

GET /v1/billing/meters List billing meters

Retrieve a list of billing meters.

operationId: GetBillingMeters

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
status	query	optional	string	Filter results to only include meters with the given status.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/billing/meters

GET /v1/billing/meters/{id} Retrieve a billing meter

Retrieves a billing meter given an ID.

operationId: GetBillingMetersId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/billing/meters/{id}

GET /v1/billing/meters/{id}/event_summaries List billing meter event summaries

Retrieve a list of billing meter event summaries.

operationId: GetBillingMetersIdEventSummaries

Parameters

Name	In	Required	Type	Description
customer	query	required	string	The customer for which to fetch event summaries.
end_time	query	required	integer	The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string	Unique identifier for the object.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
start_time	query	required	integer	The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
value_grouping_window	query	optional	string	Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. For hourly granularity, start and end times must align with hour boundaries (e.g., 00:00, 01:00, ..., 23:00). For daily granularity, start and end times must align with UTC day boundaries (00:00 UTC).

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/billing/meters/{id}/event_summaries

Billingportal 2 endpoints

GET /v1/billing_portal/configurations List portal configurations

Returns a list of configurations that describe the functionality of the customer portal.

operationId: GetBillingPortalConfigurations

Parameters

Name	In	Required	Type	Description
active	query	optional	boolean	Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations).
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
is_default	query	optional	boolean	Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration).
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/billing_portal/configurations

GET /v1/billing_portal/configurations/{configuration} Retrieve a portal configuration

Retrieves a configuration that describes the functionality of the customer portal.

operationId: GetBillingPortalConfigurationsConfiguration

Parameters

Name	In	Required	Type	Description
configuration	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/billing_portal/configurations/{configuration}

Charges 6 endpoints

GET /v1/charges List all charges

Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.

operationId: GetCharges

Parameters

Name	In	Required	Type	Description
created	query	optional		Only return charges that were created during the given date interval.
customer	query	optional	string	Only return charges for the customer specified by this customer ID.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
payment_intent	query	optional	string	Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
transfer_group	query	optional	string	Only return charges for this transfer group, limited to 100.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/charges

GET /v1/charges/search Search charges

Search for charges you’ve previously created using Stripe’s <a href="/docs/search#search-query-language">Search Query Language</a>. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

operationId: GetChargesSearch

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
page	query	optional	string	A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
query	query	required	string	The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for charges](https://docs.stripe.com/search#query-fields-for-charges).

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/charges/search

GET /v1/charges/{charge} Retrieve a charge

Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.

operationId: GetChargesCharge

Parameters

Name	In	Required	Type	Description
charge	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/charges/{charge}

GET /v1/charges/{charge}/dispute

Retrieve a dispute for a specified charge.

operationId: GetChargesChargeDispute

Parameters

Name	In	Required	Type	Description
charge	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/charges/{charge}/dispute

GET /v1/charges/{charge}/refunds List all refunds

You can see a list of the refunds belonging to a specific charge. Note that the 10 most recent refunds are always available by default on the charge object. If you need more than those 10, you can use this API method and the <code>limit</code> and <code>starting_after</code> parameters to page through additional refunds.

operationId: GetChargesChargeRefunds

Parameters

Name	In	Required	Type	Description
charge	path	required	string
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/charges/{charge}/refunds

GET /v1/charges/{charge}/refunds/{refund}

Retrieves the details of an existing refund.

operationId: GetChargesChargeRefundsRefund

Parameters

Name	In	Required	Type	Description
charge	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.
refund	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/charges/{charge}/refunds/{refund}

Checkout 3 endpoints

GET /v1/checkout/sessions List all Checkout Sessions

Returns a list of Checkout Sessions.

operationId: GetCheckoutSessions

Parameters

Name	In	Required	Type	Description
created	query	optional		Only return Checkout Sessions that were created during the given date interval.
customer	query	optional	string	Only return the Checkout Sessions for the Customer specified.
customer_account	query	optional	string	Only return the Checkout Sessions for the Account specified.
customer_details	query	optional	object	Only return the Checkout Sessions for the Customer details specified.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
payment_intent	query	optional	string	Only return the Checkout Session for the PaymentIntent specified.
payment_link	query	optional	string	Only return the Checkout Sessions for the Payment Link specified.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
status	query	optional	string	Only return the Checkout Sessions matching the given status.
subscription	query	optional	string	Only return the Checkout Session for the subscription specified.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/checkout/sessions

GET /v1/checkout/sessions/{session} Retrieve a Checkout Session

Retrieves a Checkout Session object.

operationId: GetCheckoutSessionsSession

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
session	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/checkout/sessions/{session}

GET /v1/checkout/sessions/{session}/line_items Retrieve a Checkout Session's line items

When retrieving a Checkout Session, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

operationId: GetCheckoutSessionsSessionLineItems

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
session	path	required	string
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/checkout/sessions/{session}/line_items

Climate 6 endpoints

GET /v1/climate/orders List orders

Lists all Climate order objects. The orders are returned sorted by creation date, with the most recently created orders appearing first.

operationId: GetClimateOrders

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/climate/orders

GET /v1/climate/orders/{order} Retrieve an order

Retrieves the details of a Climate order object with the given ID.

operationId: GetClimateOrdersOrder

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
order	path	required	string	Unique identifier of the order.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/climate/orders/{order}

GET /v1/climate/products List products

Lists all available Climate product objects.

operationId: GetClimateProducts

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/climate/products

GET /v1/climate/products/{product} Retrieve a product

Retrieves the details of a Climate product with the given ID.

operationId: GetClimateProductsProduct

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
product	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/climate/products/{product}

GET /v1/climate/suppliers List suppliers

Lists all available Climate supplier objects.

operationId: GetClimateSuppliers

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/climate/suppliers

GET /v1/climate/suppliers/{supplier} Retrieve a supplier

Retrieves a Climate supplier object.

operationId: GetClimateSuppliersSupplier

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
supplier	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/climate/suppliers/{supplier}

Confirmationtokens 1 endpoints

GET /v1/confirmation_tokens/{confirmation_token} Retrieve a ConfirmationToken

Retrieves an existing ConfirmationToken object

operationId: GetConfirmationTokensConfirmationToken

Parameters

Name	In	Required	Type	Description
confirmation_token	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/confirmation_tokens/{confirmation_token}

Countryspecs 2 endpoints

GET /v1/country_specs List Country Specs

Lists all Country Spec objects available in the API.

operationId: GetCountrySpecs

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/country_specs

GET /v1/country_specs/{country} Retrieve a Country Spec

Returns a Country Spec for a given Country code.

operationId: GetCountrySpecsCountry

Parameters

Name	In	Required	Type	Description
country	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/country_specs/{country}

Coupons 2 endpoints

GET /v1/coupons List all coupons

Returns a list of your coupons.

operationId: GetCoupons

Parameters

Name	In	Required	Type	Description
created	query	optional		A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/coupons

GET /v1/coupons/{coupon} Retrieve a coupon

Retrieves the coupon with the given ID.

operationId: GetCouponsCoupon

Parameters

Name	In	Required	Type	Description
coupon	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/coupons/{coupon}

Creditnotes 5 endpoints

GET /v1/credit_notes List all credit notes

Returns a list of credit notes.

operationId: GetCreditNotes

Parameters

Name	In	Required	Type	Description
created	query	optional		Only return credit notes that were created during the given date interval.
customer	query	optional	string	Only return credit notes for the customer specified by this customer ID.
customer_account	query	optional	string	Only return credit notes for the account representing the customer specified by this account ID.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
invoice	query	optional	string	Only return credit notes for the invoice specified by this invoice ID.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/credit_notes

GET /v1/credit_notes/preview Preview a credit note

Get a preview of a credit note without creating it.

operationId: GetCreditNotesPreview

Parameters

Name	In	Required	Type	Description
amount	query	optional	integer	The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
credit_amount	query	optional	integer	The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
effective_at	query	optional	integer	The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
email_type	query	optional	string	Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.
expand	query	optional	array	Specifies which fields in the response should be expanded.
invoice	query	required	string	ID of the invoice.
lines	query	optional	array	Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
memo	query	optional	string	The credit note's memo appears on the credit note PDF.
metadata	query	optional	object	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
out_of_band_amount	query	optional	integer	The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
reason	query	optional	string	Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
refund_amount	query	optional	integer	The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
refunds	query	optional	array	Refunds to link to this credit note.
shipping_cost	query	optional	object	When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/credit_notes/preview

GET /v1/credit_notes/preview/lines Retrieve a credit note preview's line items

When retrieving a credit note preview, you’ll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.

operationId: GetCreditNotesPreviewLines

Parameters

Name	In	Required	Type	Description
amount	query	optional	integer	The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
credit_amount	query	optional	integer	The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
effective_at	query	optional	integer	The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
email_type	query	optional	string	Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
invoice	query	required	string	ID of the invoice.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
lines	query	optional	array	Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
memo	query	optional	string	The credit note's memo appears on the credit note PDF.
metadata	query	optional	object	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
out_of_band_amount	query	optional	integer	The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
reason	query	optional	string	Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
refund_amount	query	optional	integer	The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
refunds	query	optional	array	Refunds to link to this credit note.
shipping_cost	query	optional	object	When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/credit_notes/preview/lines

GET /v1/credit_notes/{credit_note}/lines Retrieve a credit note's line items

When retrieving a credit note, you’ll get a lines property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

operationId: GetCreditNotesCreditNoteLines

Parameters

Name	In	Required	Type	Description
credit_note	path	required	string
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/credit_notes/{credit_note}/lines

GET /v1/credit_notes/{id} Retrieve a credit note

Retrieves the credit note object with the given identifier.

operationId: GetCreditNotesId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/credit_notes/{id}

Customers 18 endpoints

GET /v1/customers List all customers

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.

operationId: GetCustomers

Parameters

Name	In	Required	Type	Description
created	query	optional		Only return customers that were created during the given date interval.
email	query	optional	string	A case-sensitive filter on the list based on the customer's `email` field. The value must be a string.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
test_clock	query	optional	string	Provides a list of customers that are associated with the specified test clock. The response will not include customers with test clocks if this parameter is not set.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/customers

GET /v1/customers/search Search customers

Search for customers you’ve previously created using Stripe’s <a href="/docs/search#search-query-language">Search Query Language</a>. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

operationId: GetCustomersSearch

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
page	query	optional	string	A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
query	query	required	string	The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for customers](https://docs.stripe.com/search#query-fields-for-customers).

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/customers/search

GET /v1/customers/{customer} Retrieve a customer

Retrieves a Customer object.

operationId: GetCustomersCustomer

Parameters

Name	In	Required	Type	Description
customer	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/customers/{customer}

GET /v1/customers/{customer}/balance_transactions List customer balance transactions

Returns a list of transactions that updated the customer’s <a href="/docs/billing/customer/balance">balances</a>.

operationId: GetCustomersCustomerBalanceTransactions

Parameters

Name	In	Required	Type	Description
created	query	optional		Only return customer balance transactions that were created during the given date interval.
customer	path	required	string
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
invoice	query	optional	string	Only return transactions that are related to the specified invoice.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/customers/{customer}/balance_transactions

GET /v1/customers/{customer}/balance_transactions/{transaction} Retrieve a customer balance transaction

Retrieves a specific customer balance transaction that updated the customer’s <a href="/docs/billing/customer/balance">balances</a>.

operationId: GetCustomersCustomerBalanceTransactionsTransaction

Parameters

Name	In	Required	Type	Description
customer	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.
transaction	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/customers/{customer}/balance_transactions/{transaction}

GET /v1/customers/{customer}/cash_balance Retrieve a cash balance

Retrieves a customer’s cash balance.

operationId: GetCustomersCustomerCashBalance

Parameters

Name	In	Required	Type	Description
customer	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/customers/{customer}/cash_balance

GET /v1/customers/{customer}/cash_balance_transactions List cash balance transactions

Returns a list of transactions that modified the customer’s <a href="/docs/payments/customer-balance">cash balance</a>.

operationId: GetCustomersCustomerCashBalanceTransactions

Parameters

Name	In	Required	Type	Description
customer	path	required	string
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/customers/{customer}/cash_balance_transactions

GET /v1/customers/{customer}/cash_balance_transactions/{transaction} Retrieve a cash balance transaction

Retrieves a specific cash balance transaction, which updated the customer’s <a href="/docs/payments/customer-balance">cash balance</a>.

operationId: GetCustomersCustomerCashBalanceTransactionsTransaction

Parameters

Name	In	Required	Type	Description
customer	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.
transaction	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/customers/{customer}/cash_balance_transactions/{transaction}

GET /v1/customers/{customer}/discount

operationId: GetCustomersCustomerDiscount

Parameters

Name	In	Required	Type	Description
customer	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/customers/{customer}/discount

GET /v1/customers/{customer}/payment_methods List a Customer's PaymentMethods

Returns a list of PaymentMethods for a given Customer

operationId: GetCustomersCustomerPaymentMethods

Parameters

Name	In	Required	Type	Description
allow_redisplay	query	optional	string	This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.
customer	path	required	string
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
type	query	optional	string	An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/customers/{customer}/payment_methods

GET /v1/customers/{customer}/payment_methods/{payment_method} Retrieve a Customer's PaymentMethod

Retrieves a PaymentMethod object for a given Customer.

operationId: GetCustomersCustomerPaymentMethodsPaymentMethod

Parameters

Name	In	Required	Type	Description
customer	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.
payment_method	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/customers/{customer}/payment_methods/{payment_method}

GET /v1/customers/{customer}/sources

List sources for a specified customer.

operationId: GetCustomersCustomerSources

Parameters

Name	In	Required	Type	Description
customer	path	required	string
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
object	query	optional	string	Filter sources according to a particular object type.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/customers/{customer}/sources

GET /v1/customers/{customer}/sources/{id}

Retrieve a specified source for a given customer.

operationId: GetCustomersCustomerSourcesId

Parameters

Name	In	Required	Type	Description
customer	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/customers/{customer}/sources/{id}

GET /v1/customers/{customer}/subscriptions List active subscriptions

You can see a list of the customer’s active subscriptions. Note that the 10 most recent active subscriptions are always available by default on the customer object. If you need more than those 10, you can use the limit and starting_after parameters to page through additional subscriptions.

operationId: GetCustomersCustomerSubscriptions

Parameters

Name	In	Required	Type	Description
customer	path	required	string
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/customers/{customer}/subscriptions

GET /v1/customers/{customer}/subscriptions/{subscription_exposed_id} Retrieve a subscription

Retrieves the subscription with the given ID.

operationId: GetCustomersCustomerSubscriptionsSubscriptionExposedId

Parameters

Name	In	Required	Type	Description
customer	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.
subscription_exposed_id	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/customers/{customer}/subscriptions/{subscription_exposed_id}

GET /v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount

operationId: GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount

Parameters

Name	In	Required	Type	Description
customer	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.
subscription_exposed_id	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount

GET /v1/customers/{customer}/tax_ids List all Customer tax IDs

Returns a list of tax IDs for a customer.

operationId: GetCustomersCustomerTaxIds

Parameters

Name	In	Required	Type	Description
customer	path	required	string
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/customers/{customer}/tax_ids

GET /v1/customers/{customer}/tax_ids/{id} Retrieve a Customer tax ID

Retrieves the <code>tax_id</code> object with the given identifier.

operationId: GetCustomersCustomerTaxIdsId

Parameters

Name	In	Required	Type	Description
customer	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/customers/{customer}/tax_ids/{id}

Disputes 2 endpoints

GET /v1/disputes List all disputes

Returns a list of your disputes.

operationId: GetDisputes

Parameters

Name	In	Required	Type	Description
charge	query	optional	string	Only return disputes associated to the charge specified by this charge ID.
created	query	optional		Only return disputes that were created during the given date interval.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
payment_intent	query	optional	string	Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/disputes

GET /v1/disputes/{dispute} Retrieve a dispute

Retrieves the dispute with the given ID.

operationId: GetDisputesDispute

Parameters

Name	In	Required	Type	Description
dispute	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/disputes/{dispute}

Entitlements 4 endpoints

GET /v1/entitlements/active_entitlements List all active entitlements

Retrieve a list of active entitlements for a customer

operationId: GetEntitlementsActiveEntitlements

Parameters

Name	In	Required	Type	Description
customer	query	required	string	The ID of the customer.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/entitlements/active_entitlements

GET /v1/entitlements/active_entitlements/{id} Retrieve an active entitlement

Retrieve an active entitlement

operationId: GetEntitlementsActiveEntitlementsId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string	The ID of the entitlement.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/entitlements/active_entitlements/{id}

GET /v1/entitlements/features List all features

Retrieve a list of features

operationId: GetEntitlementsFeatures

Parameters

Name	In	Required	Type	Description
archived	query	optional	boolean	If set, filter results to only include features with the given archive status.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
lookup_key	query	optional	string	If set, filter results to only include features with the given lookup_key.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/entitlements/features

GET /v1/entitlements/features/{id} Retrieve a feature

Retrieves a feature

operationId: GetEntitlementsFeaturesId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string	The ID of the feature.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/entitlements/features/{id}

Events 2 endpoints

GET /v1/events List all events

List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in <a href="https://docs.stripe.com/api/events/object">event object</a> <code>api_version</code> attribute (not according to your current Stripe API version or <code>Stripe-Version</code> header).

operationId: GetEvents

Parameters

Name	In	Required	Type	Description
created	query	optional		Only return events that were created during the given date interval.
delivery_success	query	optional	boolean	Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
type	query	optional	string	A string containing a specific event name, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property.
types	query	optional	array	An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass either `type` or `types`, but not both.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/events

GET /v1/events/{id} Retrieve an event

Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook.

operationId: GetEventsId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/events/{id}

Exchangerates 2 endpoints

GET /v1/exchange_rates List all exchange rates

[Deprecated] The <code>ExchangeRate</code> APIs are deprecated. Please use the <a href="https://docs.stripe.com/payments/currencies/localize-prices/fx-quotes-api">FX Quotes API</a> instead. Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.

operationId: GetExchangeRates

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with the exchange rate for currency X your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and total number of supported payout currencies, and the default is the max.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with the exchange rate for currency X, your subsequent call can include `starting_after=X` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/exchange_rates

GET /v1/exchange_rates/{rate_id} Retrieve an exchange rate

[Deprecated] The <code>ExchangeRate</code> APIs are deprecated. Please use the <a href="https://docs.stripe.com/payments/currencies/localize-prices/fx-quotes-api">FX Quotes API</a> instead. Retrieves the exchange rates from the given currency to every supported currency.

operationId: GetExchangeRatesRateId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
rate_id	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/exchange_rates/{rate_id}

Filelinks 2 endpoints

GET /v1/file_links List all file links

Returns a list of file links.

operationId: GetFileLinks

Parameters

Name	In	Required	Type	Description
created	query	optional		Only return links that were created during the given date interval.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
expired	query	optional	boolean	Filter links by their expiration status. By default, Stripe returns all links.
file	query	optional	string	Only return links for the given file.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/file_links

GET /v1/file_links/{link} Retrieve a file link

Retrieves the file link with the given ID.

operationId: GetFileLinksLink

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
link	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/file_links/{link}

Files 2 endpoints

GET /v1/files List all files

Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.

operationId: GetFiles

Parameters

Name	In	Required	Type	Description
created	query	optional		Only return files that were created during the given date interval.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
purpose	query	optional	string	Filter queries by the file purpose. If you don't provide a purpose, the queries return unfiltered files.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/files

GET /v1/files/{file} Retrieve a file

Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to <a href="/docs/file-upload#download-file-contents">access file contents</a>.

operationId: GetFilesFile

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
file	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/files/{file}

Financialconnections 6 endpoints

GET /v1/financial_connections/accounts List Accounts

Returns a list of Financial Connections <code>Account</code> objects.

operationId: GetFinancialConnectionsAccounts

Parameters

Name	In	Required	Type	Description
account_holder	query	optional	object	If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
session	query	optional	string	If present, only return accounts that were collected as part of the given session.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/financial_connections/accounts

GET /v1/financial_connections/accounts/{account} Retrieve an Account

Retrieves the details of an Financial Connections <code>Account</code>.

operationId: GetFinancialConnectionsAccountsAccount

Parameters

Name	In	Required	Type	Description
account	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/financial_connections/accounts/{account}

GET /v1/financial_connections/accounts/{account}/owners List Account Owners

Lists all owners for a given <code>Account</code>

operationId: GetFinancialConnectionsAccountsAccountOwners

Parameters

Name	In	Required	Type	Description
account	path	required	string
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
ownership	query	required	string	The ID of the ownership object to fetch owners from.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/financial_connections/accounts/{account}/owners

GET /v1/financial_connections/sessions/{session} Retrieve a Session

Retrieves the details of a Financial Connections <code>Session</code>

operationId: GetFinancialConnectionsSessionsSession

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
session	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/financial_connections/sessions/{session}

GET /v1/financial_connections/transactions List Transactions

Returns a list of Financial Connections <code>Transaction</code> objects.

operationId: GetFinancialConnectionsTransactions

Parameters

Name	In	Required	Type	Description
account	query	required	string	The ID of the Financial Connections Account whose transactions will be retrieved.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
transacted_at	query	optional		A filter on the list based on the object `transacted_at` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:
transaction_refresh	query	optional	object	A filter on the list based on the object `transaction_refresh` field. The value can be a dictionary with the following options:

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/financial_connections/transactions

GET /v1/financial_connections/transactions/{transaction} Retrieve a Transaction

Retrieves the details of a Financial Connections <code>Transaction</code>

operationId: GetFinancialConnectionsTransactionsTransaction

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
transaction	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/financial_connections/transactions/{transaction}

Forwarding 2 endpoints

GET /v1/forwarding/requests List all ForwardingRequests

Lists all ForwardingRequest objects.

operationId: GetForwardingRequests

Parameters

Name	In	Required	Type	Description
created	query	optional	object	Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values.
ending_before	query	optional	string	A pagination cursor to fetch the previous page of the list. The value must be a ForwardingRequest ID.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A pagination cursor to fetch the next page of the list. The value must be a ForwardingRequest ID.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/forwarding/requests

GET /v1/forwarding/requests/{id} Retrieve a ForwardingRequest

Retrieves a ForwardingRequest object.

operationId: GetForwardingRequestsId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/forwarding/requests/{id}

Identity 4 endpoints

GET /v1/identity/verification_reports List VerificationReports

List all verification reports.

operationId: GetIdentityVerificationReports

Parameters

Name	In	Required	Type	Description
client_reference_id	query	optional	string	A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
created	query	optional		Only return VerificationReports that were created during the given date interval.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
type	query	optional	string	Only return VerificationReports of this type
verification_session	query	optional	string	Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/identity/verification_reports

GET /v1/identity/verification_reports/{report} Retrieve a VerificationReport

Retrieves an existing VerificationReport

operationId: GetIdentityVerificationReportsReport

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
report	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/identity/verification_reports/{report}

GET /v1/identity/verification_sessions List VerificationSessions

Returns a list of VerificationSessions

operationId: GetIdentityVerificationSessions

Parameters

Name	In	Required	Type	Description
client_reference_id	query	optional	string	A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
created	query	optional		Only return VerificationSessions that were created during the given date interval.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
related_customer	query	optional	string	Customer ID
related_customer_account	query	optional	string	The ID of the Account representing a customer.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
status	query	optional	string	Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://docs.stripe.com/identity/how-sessions-work).

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/identity/verification_sessions

GET /v1/identity/verification_sessions/{session} Retrieve a VerificationSession

Retrieves the details of a VerificationSession that was previously created. When the session status is <code>requires_input</code>, you can use this method to retrieve a valid <code>client_secret</code> or <code>url</code> to allow re-submission.

operationId: GetIdentityVerificationSessionsSession

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
session	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/identity/verification_sessions/{session}

Invoicepayments 2 endpoints

GET /v1/invoice_payments List all payments for an invoice

When retrieving an invoice, there is an includable payments property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of payments.

operationId: GetInvoicePayments

Parameters

Name	In	Required	Type	Description
created	query	optional		Only return invoice payments that were created during the given date interval.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
invoice	query	optional	string	The identifier of the invoice whose payments to return.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
payment	query	optional	object	The payment details of the invoice payments to return.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
status	query	optional	string	The status of the invoice payments to return.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/invoice_payments

GET /v1/invoice_payments/{invoice_payment} Retrieve an InvoicePayment

Retrieves the invoice payment with the given ID.

operationId: GetInvoicePaymentsInvoicePayment

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
invoice_payment	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/invoice_payments/{invoice_payment}

Invoicerenderingtemplates 2 endpoints

GET /v1/invoice_rendering_templates List all invoice rendering templates

List all templates, ordered by creation date, with the most recently created template appearing first.

operationId: GetInvoiceRenderingTemplates

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
status	query	optional	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/invoice_rendering_templates

GET /v1/invoice_rendering_templates/{template} Retrieve an invoice rendering template

Retrieves an invoice rendering template with the given ID. It by default returns the latest version of the template. Optionally, specify a version to see previous versions.

operationId: GetInvoiceRenderingTemplatesTemplate

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
template	path	required	string
version	query	optional	integer

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/invoice_rendering_templates/{template}

Invoiceitems 2 endpoints

GET /v1/invoiceitems List all invoice items

Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.

operationId: GetInvoiceitems

Parameters

Name	In	Required	Type	Description
created	query	optional		Only return invoice items that were created during the given date interval.
customer	query	optional	string	The identifier of the customer whose invoice items to return. If none is provided, returns all invoice items.
customer_account	query	optional	string	The identifier of the account representing the customer whose invoice items to return. If none is provided, returns all invoice items.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
invoice	query	optional	string	Only return invoice items belonging to this invoice. If none is provided, all invoice items will be returned. If specifying an invoice, no customer identifier is needed.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
pending	query	optional	boolean	Set to `true` to only show pending invoice items, which are not yet attached to any invoices. Set to `false` to only show invoice items already attached to invoices. If unspecified, no filter is applied.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/invoiceitems

GET /v1/invoiceitems/{invoiceitem} Retrieve an invoice item

Retrieves the invoice item with the given ID.

operationId: GetInvoiceitemsInvoiceitem

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
invoiceitem	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/invoiceitems/{invoiceitem}

Invoices 4 endpoints

GET /v1/invoices List all invoices

You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.

operationId: GetInvoices

Parameters

Name	In	Required	Type	Description
collection_method	query	optional	string	The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`.
created	query	optional		Only return invoices that were created during the given date interval.
customer	query	optional	string	Only return invoices for the customer specified by this customer ID.
customer_account	query	optional	string	Only return invoices for the account representing the customer specified by this account ID.
due_date	query	optional
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
status	query	optional	string	The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://docs.stripe.com/billing/invoices/workflow#workflow-overview)
subscription	query	optional	string	Only return invoices for the subscription specified by this subscription ID.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/invoices

GET /v1/invoices/search Search invoices

Search for invoices you’ve previously created using Stripe’s <a href="/docs/search#search-query-language">Search Query Language</a>. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

operationId: GetInvoicesSearch

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
page	query	optional	string	A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
query	query	required	string	The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for invoices](https://docs.stripe.com/search#query-fields-for-invoices).

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/invoices/search

GET /v1/invoices/{invoice} Retrieve an invoice

Retrieves the invoice with the given ID.

operationId: GetInvoicesInvoice

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
invoice	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/invoices/{invoice}

GET /v1/invoices/{invoice}/lines Retrieve an invoice's line items

When retrieving an invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

operationId: GetInvoicesInvoiceLines

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
invoice	path	required	string
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/invoices/{invoice}/lines

Issuing 17 endpoints

GET /v1/issuing/authorizations List all authorizations

Returns a list of Issuing <code>Authorization</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

operationId: GetIssuingAuthorizations

Parameters

Name	In	Required	Type	Description
card	query	optional	string	Only return authorizations that belong to the given card.
cardholder	query	optional	string	Only return authorizations that belong to the given cardholder.
created	query	optional		Only return authorizations that were created during the given date interval.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
status	query	optional	string	Only return authorizations with the given status. One of `pending`, `closed`, or `reversed`.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/issuing/authorizations

GET /v1/issuing/authorizations/{authorization} Retrieve an authorization

Retrieves an Issuing <code>Authorization</code> object.

operationId: GetIssuingAuthorizationsAuthorization

Parameters

Name	In	Required	Type	Description
authorization	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/issuing/authorizations/{authorization}

GET /v1/issuing/cardholders List all cardholders

Returns a list of Issuing <code>Cardholder</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

operationId: GetIssuingCardholders

Parameters

Name	In	Required	Type	Description
created	query	optional		Only return cardholders that were created during the given date interval.
email	query	optional	string	Only return cardholders that have the given email address.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
phone_number	query	optional	string	Only return cardholders that have the given phone number.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
status	query	optional	string	Only return cardholders that have the given status. One of `active`, `inactive`, or `blocked`.
type	query	optional	string	Only return cardholders that have the given type. One of `individual` or `company`.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/issuing/cardholders

GET /v1/issuing/cardholders/{cardholder} Retrieve a cardholder

Retrieves an Issuing <code>Cardholder</code> object.

operationId: GetIssuingCardholdersCardholder

Parameters

Name	In	Required	Type	Description
cardholder	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/issuing/cardholders/{cardholder}

GET /v1/issuing/cards List all cards

Returns a list of Issuing <code>Card</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

operationId: GetIssuingCards

Parameters

Name	In	Required	Type	Description
cardholder	query	optional	string	Only return cards belonging to the Cardholder with the provided ID.
created	query	optional		Only return cards that were issued during the given date interval.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
exp_month	query	optional	integer	Only return cards that have the given expiration month.
exp_year	query	optional	integer	Only return cards that have the given expiration year.
expand	query	optional	array	Specifies which fields in the response should be expanded.
last4	query	optional	string	Only return cards that have the given last four digits.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
personalization_design	query	optional	string
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
status	query	optional	string	Only return cards that have the given status. One of `active`, `inactive`, or `canceled`.
type	query	optional	string	Only return cards that have the given type. One of `virtual` or `physical`.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/issuing/cards

GET /v1/issuing/cards/{card} Retrieve a card

Retrieves an Issuing <code>Card</code> object.

operationId: GetIssuingCardsCard

Parameters

Name	In	Required	Type	Description
card	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/issuing/cards/{card}

GET /v1/issuing/disputes List all disputes

Returns a list of Issuing <code>Dispute</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

operationId: GetIssuingDisputes

Parameters

Name	In	Required	Type	Description
created	query	optional		Only return Issuing disputes that were created during the given date interval.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
status	query	optional	string	Select Issuing disputes with the given status.
transaction	query	optional	string	Select the Issuing dispute for the given transaction.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/issuing/disputes

GET /v1/issuing/disputes/{dispute} Retrieve a dispute

Retrieves an Issuing <code>Dispute</code> object.

operationId: GetIssuingDisputesDispute

Parameters

Name	In	Required	Type	Description
dispute	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/issuing/disputes/{dispute}

GET /v1/issuing/personalization_designs List all personalization designs

Returns a list of personalization design objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

operationId: GetIssuingPersonalizationDesigns

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
lookup_keys	query	optional	array	Only return personalization designs with the given lookup keys.
preferences	query	optional	object	Only return personalization designs with the given preferences.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
status	query	optional	string	Only return personalization designs with the given status.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/issuing/personalization_designs

GET /v1/issuing/personalization_designs/{personalization_design} Retrieve a personalization design

Retrieves a personalization design object.

operationId: GetIssuingPersonalizationDesignsPersonalizationDesign

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
personalization_design	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/issuing/personalization_designs/{personalization_design}

GET /v1/issuing/physical_bundles List all physical bundles

Returns a list of physical bundle objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

operationId: GetIssuingPhysicalBundles

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
status	query	optional	string	Only return physical bundles with the given status.
type	query	optional	string	Only return physical bundles with the given type.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/issuing/physical_bundles

GET /v1/issuing/physical_bundles/{physical_bundle} Retrieve a physical bundle

Retrieves a physical bundle object.

operationId: GetIssuingPhysicalBundlesPhysicalBundle

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
physical_bundle	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/issuing/physical_bundles/{physical_bundle}

GET /v1/issuing/settlements/{settlement} Retrieve a settlement

Retrieves an Issuing <code>Settlement</code> object.

operationId: GetIssuingSettlementsSettlement

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
settlement	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/issuing/settlements/{settlement}

GET /v1/issuing/tokens List all issuing tokens for card

Lists all Issuing <code>Token</code> objects for a given card.

operationId: GetIssuingTokens

Parameters

Name	In	Required	Type	Description
card	query	required	string	The Issuing card identifier to list tokens for.
created	query	optional		Only return Issuing tokens that were created during the given date interval.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
status	query	optional	string	Select Issuing tokens with the given status.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/issuing/tokens

GET /v1/issuing/tokens/{token} Retrieve an issuing token

Retrieves an Issuing <code>Token</code> object.

operationId: GetIssuingTokensToken

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
token	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/issuing/tokens/{token}

GET /v1/issuing/transactions List all transactions

Returns a list of Issuing <code>Transaction</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

operationId: GetIssuingTransactions

Parameters

Name	In	Required	Type	Description
card	query	optional	string	Only return transactions that belong to the given card.
cardholder	query	optional	string	Only return transactions that belong to the given cardholder.
created	query	optional		Only return transactions that were created during the given date interval.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
type	query	optional	string	Only return transactions that have the given type. One of `capture` or `refund`.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/issuing/transactions

GET /v1/issuing/transactions/{transaction} Retrieve a transaction

Retrieves an Issuing <code>Transaction</code> object.

operationId: GetIssuingTransactionsTransaction

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
transaction	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/issuing/transactions/{transaction}

Linkaccountsessions 1 endpoints

GET /v1/link_account_sessions/{session} Retrieve a Session

Retrieves the details of a Financial Connections <code>Session</code>

operationId: GetLinkAccountSessionsSession

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
session	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/link_account_sessions/{session}

Linkedaccounts 3 endpoints

GET /v1/linked_accounts List Accounts

Returns a list of Financial Connections <code>Account</code> objects.

operationId: GetLinkedAccounts

Parameters

Name	In	Required	Type	Description
account_holder	query	optional	object	If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
session	query	optional	string	If present, only return accounts that were collected as part of the given session.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/linked_accounts

GET /v1/linked_accounts/{account} Retrieve an Account

Retrieves the details of an Financial Connections <code>Account</code>.

operationId: GetLinkedAccountsAccount

Parameters

Name	In	Required	Type	Description
account	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/linked_accounts/{account}

GET /v1/linked_accounts/{account}/owners List Account Owners

Lists all owners for a given <code>Account</code>

operationId: GetLinkedAccountsAccountOwners

Parameters

Name	In	Required	Type	Description
account	path	required	string
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
ownership	query	required	string	The ID of the ownership object to fetch owners from.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/linked_accounts/{account}/owners

Mandates 1 endpoints

GET /v1/mandates/{mandate} Retrieve a Mandate

Retrieves a Mandate object.

operationId: GetMandatesMandate

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
mandate	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/mandates/{mandate}

Paymentattemptrecords 2 endpoints

GET /v1/payment_attempt_records List Payment Attempt Records

List all the Payment Attempt Records attached to the specified Payment Record.

operationId: GetPaymentAttemptRecords

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
payment_record	query	required	string	The ID of the Payment Record.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/payment_attempt_records

GET /v1/payment_attempt_records/{id} Retrieve a Payment Attempt Record

Retrieves a Payment Attempt Record with the given ID

operationId: GetPaymentAttemptRecordsId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string	The ID of the Payment Attempt Record.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/payment_attempt_records/{id}

Paymentintents 4 endpoints

GET /v1/payment_intents List all PaymentIntents

Returns a list of PaymentIntents.

operationId: GetPaymentIntents

Parameters

Name	In	Required	Type	Description
created	query	optional		A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options.
customer	query	optional	string	Only return PaymentIntents for the customer that this customer ID specifies.
customer_account	query	optional	string	Only return PaymentIntents for the account representing the customer that this ID specifies.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/payment_intents

GET /v1/payment_intents/search Search PaymentIntents

Search for PaymentIntents you’ve previously created using Stripe’s <a href="/docs/search#search-query-language">Search Query Language</a>. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

operationId: GetPaymentIntentsSearch

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
page	query	optional	string	A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
query	query	required	string	The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for payment intents](https://docs.stripe.com/search#query-fields-for-payment-intents).

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/payment_intents/search

GET /v1/payment_intents/{intent} Retrieve a PaymentIntent

Retrieves the details of a PaymentIntent that has previously been created. You can retrieve a PaymentIntent client-side using a publishable key when the <code>client_secret</code> is in the query string. If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the <a href="#payment_intent_object">payment intent</a> object reference for more details.

operationId: GetPaymentIntentsIntent

Parameters

Name	In	Required	Type	Description
client_secret	query	optional	string	The client secret of the PaymentIntent. We require it if you use a publishable key to retrieve the source.
expand	query	optional	array	Specifies which fields in the response should be expanded.
intent	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/payment_intents/{intent}

GET /v1/payment_intents/{intent}/amount_details_line_items List all PaymentIntent LineItems

Lists all LineItems of a given PaymentIntent.

operationId: GetPaymentIntentsIntentAmountDetailsLineItems

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
intent	path	required	string
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/payment_intents/{intent}/amount_details_line_items

Paymentlinks 3 endpoints

GET /v1/payment_links List all payment links

Returns a list of your payment links.

operationId: GetPaymentLinks

Parameters

Name	In	Required	Type	Description
active	query	optional	boolean	Only return payment links that are active or inactive (e.g., pass `false` to list all inactive payment links).
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/payment_links

GET /v1/payment_links/{payment_link} Retrieve payment link

Retrieve a payment link.

operationId: GetPaymentLinksPaymentLink

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
payment_link	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/payment_links/{payment_link}

GET /v1/payment_links/{payment_link}/line_items Retrieve a payment link's line items

When retrieving a payment link, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

operationId: GetPaymentLinksPaymentLinkLineItems

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
payment_link	path	required	string
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/payment_links/{payment_link}/line_items

Paymentmethodconfigurations 2 endpoints

GET /v1/payment_method_configurations List payment method configurations

List payment method configurations

operationId: GetPaymentMethodConfigurations

Parameters

Name	In	Required	Type	Description
application	query	optional		The Connect application to filter by.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/payment_method_configurations

GET /v1/payment_method_configurations/{configuration} Retrieve payment method configuration

Retrieve payment method configuration

operationId: GetPaymentMethodConfigurationsConfiguration

Parameters

Name	In	Required	Type	Description
configuration	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/payment_method_configurations/{configuration}

Paymentmethoddomains 2 endpoints

GET /v1/payment_method_domains List payment method domains

Lists the details of existing payment method domains.

operationId: GetPaymentMethodDomains

Parameters

Name	In	Required	Type	Description
domain_name	query	optional	string	The domain name that this payment method domain object represents.
enabled	query	optional	boolean	Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements or Embedded Checkout
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/payment_method_domains

GET /v1/payment_method_domains/{payment_method_domain} Retrieve a payment method domain

Retrieves the details of an existing payment method domain.

operationId: GetPaymentMethodDomainsPaymentMethodDomain

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
payment_method_domain	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/payment_method_domains/{payment_method_domain}

Paymentmethods 2 endpoints

GET /v1/payment_methods List PaymentMethods

Returns a list of all PaymentMethods.

operationId: GetPaymentMethods

Parameters

Name	In	Required	Type	Description
allow_redisplay	query	optional	string	This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.
customer	query	optional	string	The ID of the customer whose PaymentMethods will be retrieved.
customer_account	query	optional	string	The ID of the Account whose PaymentMethods will be retrieved.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
type	query	optional	string	Filters the list by the object `type` field. Unfiltered, the list returns all payment method types except `custom`. If your integration expects only one type of payment method in the response, specify that type value in the request to reduce your payload.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/payment_methods

GET /v1/payment_methods/{payment_method} Retrieve a PaymentMethod

Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use <a href="/docs/api/payment_methods/customer">Retrieve a Customer’s PaymentMethods</a>

operationId: GetPaymentMethodsPaymentMethod

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
payment_method	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/payment_methods/{payment_method}

Paymentrecords 1 endpoints

GET /v1/payment_records/{id} Retrieve a Payment Record

Retrieves a Payment Record with the given ID

operationId: GetPaymentRecordsId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string	The ID of the Payment Record.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/payment_records/{id}

Payouts 2 endpoints

GET /v1/payouts List all payouts

Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.

operationId: GetPayouts

Parameters

Name	In	Required	Type	Description
arrival_date	query	optional		Only return payouts that are expected to arrive during the given date interval.
created	query	optional		Only return payouts that were created during the given date interval.
destination	query	optional	string	The ID of an external account - only return payouts sent to this external account.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
status	query	optional	string	Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/payouts

GET /v1/payouts/{payout} Retrieve a payout

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.

operationId: GetPayoutsPayout

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
payout	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/payouts/{payout}

Plans 2 endpoints

GET /v1/plans List all plans

Returns a list of your plans.

operationId: GetPlans

Parameters

Name	In	Required	Type	Description
active	query	optional	boolean	Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans).
created	query	optional		A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
product	query	optional	string	Only return plans for the given product.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/plans

GET /v1/plans/{plan} Retrieve a plan

Retrieves the plan with the given ID.

operationId: GetPlansPlan

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
plan	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/plans/{plan}

Prices 3 endpoints

GET /v1/prices List all prices

Returns a list of your active prices, excluding <a href="/docs/products-prices/pricing-models#inline-pricing">inline prices</a>. For the list of inactive prices, set <code>active</code> to false.

operationId: GetPrices

Parameters

Name	In	Required	Type	Description
active	query	optional	boolean	Only return prices that are active or inactive (e.g., pass `false` to list all inactive prices).
created	query	optional		A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
currency	query	optional	string	Only return prices for the given currency.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
lookup_keys	query	optional	array	Only return the price with these lookup_keys, if any exist. You can specify up to 10 lookup_keys.
product	query	optional	string	Only return prices for the given product.
recurring	query	optional	object	Only return prices with these recurring fields.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
type	query	optional	string	Only return prices of type `recurring` or `one_time`.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/prices

GET /v1/prices/search Search prices

Search for prices you’ve previously created using Stripe’s <a href="/docs/search#search-query-language">Search Query Language</a>. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

operationId: GetPricesSearch

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
page	query	optional	string	A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
query	query	required	string	The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for prices](https://docs.stripe.com/search#query-fields-for-prices).

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/prices/search

GET /v1/prices/{price} Retrieve a price

Retrieves the price with the given ID.

operationId: GetPricesPrice

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
price	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/prices/{price}

Products 5 endpoints

GET /v1/products List all products

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.

operationId: GetProducts

Parameters

Name	In	Required	Type	Description
active	query	optional	boolean	Only return products that are active or inactive (e.g., pass `false` to list all inactive products).
created	query	optional		Only return products that were created during the given date interval.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
ids	query	optional	array	Only return products with the given IDs. Cannot be used with [starting_after](https://api.stripe.com#list_products-starting_after) or [ending_before](https://api.stripe.com#list_products-ending_before).
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
shippable	query	optional	boolean	Only return products that can be shipped (i.e., physical, not digital products).
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
url	query	optional	string	Only return products with the given url.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/products

GET /v1/products/search Search products

Search for products you’ve previously created using Stripe’s <a href="/docs/search#search-query-language">Search Query Language</a>. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

operationId: GetProductsSearch

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
page	query	optional	string	A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
query	query	required	string	The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for products](https://docs.stripe.com/search#query-fields-for-products).

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/products/search

GET /v1/products/{id} Retrieve a product

Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.

operationId: GetProductsId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/products/{id}

GET /v1/products/{product}/features List all features attached to a product

Retrieve a list of features for a product

operationId: GetProductsProductFeatures

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
product	path	required	string
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/products/{product}/features

GET /v1/products/{product}/features/{id} Retrieve a product_feature

Retrieves a product_feature, which represents a feature attachment to a product

operationId: GetProductsProductFeaturesId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string	The ID of the product_feature.
product	path	required	string	The ID of the product.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/products/{product}/features/{id}

Promotioncodes 2 endpoints

GET /v1/promotion_codes List all promotion codes

Returns a list of your promotion codes.

operationId: GetPromotionCodes

Parameters

Name	In	Required	Type	Description
active	query	optional	boolean	Filter promotion codes by whether they are active.
code	query	optional	string	Only return promotion codes that have this case-insensitive code.
coupon	query	optional	string	Only return promotion codes for this coupon.
created	query	optional		A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
customer	query	optional	string	Only return promotion codes that are restricted to this customer.
customer_account	query	optional	string	Only return promotion codes that are restricted to this account representing the customer.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/promotion_codes

GET /v1/promotion_codes/{promotion_code} Retrieve a promotion code

Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing <code>code</code> use <a href="/docs/api/promotion_codes/list">list</a> with the desired <code>code</code>.

operationId: GetPromotionCodesPromotionCode

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
promotion_code	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/promotion_codes/{promotion_code}

Quotes 5 endpoints

GET /v1/quotes List all quotes

Returns a list of your quotes.

operationId: GetQuotes

Parameters

Name	In	Required	Type	Description
customer	query	optional	string	The ID of the customer whose quotes you're retrieving.
customer_account	query	optional	string	The ID of the account representing the customer whose quotes you're retrieving.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
status	query	optional	string	The status of the quote.
test_clock	query	optional	string	Provides a list of quotes that are associated with the specified test clock. The response will not include quotes with test clocks if this and the customer parameter is not set.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/quotes

GET /v1/quotes/{quote} Retrieve a quote

Retrieves the quote with the given ID.

operationId: GetQuotesQuote

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
quote	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/quotes/{quote}

GET /v1/quotes/{quote}/computed_upfront_line_items Retrieve a quote's upfront line items

When retrieving a quote, there is an includable <a href="https://stripe.com/docs/api/quotes/object#quote_object-computed-upfront-line_items">computed.upfront.line_items</a> property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.

operationId: GetQuotesQuoteComputedUpfrontLineItems

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
quote	path	required	string
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/quotes/{quote}/computed_upfront_line_items

GET /v1/quotes/{quote}/line_items Retrieve a quote's line items

When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

operationId: GetQuotesQuoteLineItems

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
quote	path	required	string
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/quotes/{quote}/line_items

GET /v1/quotes/{quote}/pdf Download quote PDF

Download the PDF for a finalized quote. Explanation for special handling can be found <a href="https://docs.stripe.com/quotes/overview#quote_pdf">here</a>

operationId: GetQuotesQuotePdf

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
quote	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/quotes/{quote}/pdf

Radar 6 endpoints

GET /v1/radar/early_fraud_warnings List all early fraud warnings

Returns a list of early fraud warnings.

operationId: GetRadarEarlyFraudWarnings

Parameters

Name	In	Required	Type	Description
charge	query	optional	string	Only return early fraud warnings for the charge specified by this charge ID.
created	query	optional		Only return early fraud warnings that were created during the given date interval.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
payment_intent	query	optional	string	Only return early fraud warnings for charges that were created by the PaymentIntent specified by this PaymentIntent ID.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/radar/early_fraud_warnings

GET /v1/radar/early_fraud_warnings/{early_fraud_warning} Retrieve an early fraud warning

Retrieves the details of an early fraud warning that has previously been created. Please refer to the <a href="#early_fraud_warning_object">early fraud warning</a> object reference for more details.

operationId: GetRadarEarlyFraudWarningsEarlyFraudWarning

Parameters

Name	In	Required	Type	Description
early_fraud_warning	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/radar/early_fraud_warnings/{early_fraud_warning}

GET /v1/radar/value_list_items List all value list items

Returns a list of <code>ValueListItem</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

operationId: GetRadarValueListItems

Parameters

Name	In	Required	Type	Description
created	query	optional		Only return items that were created during the given date interval.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
value	query	optional	string	Return items belonging to the parent list whose value matches the specified value (using an "is like" match).
value_list	query	required	string	Identifier for the parent value list this item belongs to.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/radar/value_list_items

GET /v1/radar/value_list_items/{item} Retrieve a value list item

Retrieves a <code>ValueListItem</code> object.

operationId: GetRadarValueListItemsItem

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
item	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/radar/value_list_items/{item}

GET /v1/radar/value_lists List all value lists

Returns a list of <code>ValueList</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

operationId: GetRadarValueLists

Parameters

Name	In	Required	Type	Description
alias	query	optional	string	The alias used to reference the value list when writing rules.
contains	query	optional	string	A value contained within a value list - returns all value lists containing this value.
created	query	optional		Only return value lists that were created during the given date interval.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/radar/value_lists

GET /v1/radar/value_lists/{value_list} Retrieve a value list

Retrieves a <code>ValueList</code> object.

operationId: GetRadarValueListsValueList

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
value_list	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/radar/value_lists/{value_list}

Refunds 2 endpoints

GET /v1/refunds List all refunds

Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object.

operationId: GetRefunds

Parameters

Name	In	Required	Type	Description
charge	query	optional	string	Only return refunds for the charge specified by this charge ID.
created	query	optional		Only return refunds that were created during the given date interval.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
payment_intent	query	optional	string	Only return refunds for the PaymentIntent specified by this ID.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/refunds

GET /v1/refunds/{refund} Retrieve a refund

Retrieves the details of an existing refund.

operationId: GetRefundsRefund

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
refund	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/refunds/{refund}

Reporting 4 endpoints

GET /v1/reporting/report_runs List all Report Runs

Returns a list of Report Runs, with the most recent appearing first.

operationId: GetReportingReportRuns

Parameters

Name	In	Required	Type	Description
created	query	optional		Only return Report Runs that were created during the given date interval.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/reporting/report_runs

GET /v1/reporting/report_runs/{report_run} Retrieve a Report Run

Retrieves the details of an existing Report Run.

operationId: GetReportingReportRunsReportRun

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
report_run	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/reporting/report_runs/{report_run}

GET /v1/reporting/report_types List all Report Types

Returns a full list of Report Types.

operationId: GetReportingReportTypes

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/reporting/report_types

GET /v1/reporting/report_types/{report_type} Retrieve a Report Type

Retrieves the details of a Report Type. (Certain report types require a <a href="https://stripe.com/docs/keys#test-live-modes">live-mode API key</a>.)

operationId: GetReportingReportTypesReportType

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
report_type	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/reporting/report_types/{report_type}

Reviews 2 endpoints

GET /v1/reviews List all open reviews

Returns a list of <code>Review</code> objects that have <code>open</code> set to <code>true</code>. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

operationId: GetReviews

Parameters

Name	In	Required	Type	Description
created	query	optional		Only return reviews that were created during the given date interval.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/reviews

GET /v1/reviews/{review} Retrieve a review

Retrieves a <code>Review</code> object.

operationId: GetReviewsReview

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
review	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/reviews/{review}

Setupattempts 1 endpoints

GET /v1/setup_attempts List all SetupAttempts

Returns a list of SetupAttempts that associate with a provided SetupIntent.

operationId: GetSetupAttempts

Parameters

Name	In	Required	Type	Description
created	query	optional		A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
setup_intent	query	required	string	Only return SetupAttempts created by the SetupIntent specified by this ID.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/setup_attempts

Setupintents 2 endpoints

GET /v1/setup_intents List all SetupIntents

Returns a list of SetupIntents.

operationId: GetSetupIntents

Parameters

Name	In	Required	Type	Description
attach_to_self	query	optional	boolean	If present, the SetupIntent's payment method will be attached to the in-context Stripe Account. It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.
created	query	optional		A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
customer	query	optional	string	Only return SetupIntents for the customer specified by this customer ID.
customer_account	query	optional	string	Only return SetupIntents for the account specified by this customer ID.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
payment_method	query	optional	string	Only return SetupIntents that associate with the specified payment method.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/setup_intents

GET /v1/setup_intents/{intent} Retrieve a SetupIntent

Retrieves the details of a SetupIntent that has previously been created. Client-side retrieval using a publishable key is allowed when the <code>client_secret</code> is provided in the query string. When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the <a href="#setup_intent_object">SetupIntent</a> object reference for more details.

operationId: GetSetupIntentsIntent

Parameters

Name	In	Required	Type	Description
client_secret	query	optional	string	The client secret of the SetupIntent. We require this string if you use a publishable key to retrieve the SetupIntent.
expand	query	optional	array	Specifies which fields in the response should be expanded.
intent	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/setup_intents/{intent}

Shippingrates 2 endpoints

GET /v1/shipping_rates List all shipping rates

Returns a list of your shipping rates.

operationId: GetShippingRates

Parameters

Name	In	Required	Type	Description
active	query	optional	boolean	Only return shipping rates that are active or inactive.
created	query	optional		A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
currency	query	optional	string	Only return shipping rates for the given currency.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/shipping_rates

GET /v1/shipping_rates/{shipping_rate_token} Retrieve a shipping rate

Returns the shipping rate object with the given ID.

operationId: GetShippingRatesShippingRateToken

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
shipping_rate_token	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/shipping_rates/{shipping_rate_token}

Sigma 2 endpoints

GET /v1/sigma/scheduled_query_runs List all scheduled query runs

Returns a list of scheduled query runs.

operationId: GetSigmaScheduledQueryRuns

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/sigma/scheduled_query_runs

GET /v1/sigma/scheduled_query_runs/{scheduled_query_run} Retrieve a scheduled query run

Retrieves the details of an scheduled query run.

operationId: GetSigmaScheduledQueryRunsScheduledQueryRun

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
scheduled_query_run	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/sigma/scheduled_query_runs/{scheduled_query_run}

Sources 4 endpoints

GET /v1/sources/{source} Retrieve a source

Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.

operationId: GetSourcesSource

Parameters

Name	In	Required	Type	Description
client_secret	query	optional	string	The client secret of the source. Required if a publishable key is used to retrieve the source.
expand	query	optional	array	Specifies which fields in the response should be expanded.
source	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/sources/{source}

GET /v1/sources/{source}/mandate_notifications/{mandate_notification} Retrieve a Source MandateNotification

Retrieves a new Source MandateNotification.

operationId: GetSourcesSourceMandateNotificationsMandateNotification

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
mandate_notification	path	required	string
source	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/sources/{source}/mandate_notifications/{mandate_notification}

GET /v1/sources/{source}/source_transactions

List source transactions for a given source.

operationId: GetSourcesSourceSourceTransactions

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
source	path	required	string
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/sources/{source}/source_transactions

GET /v1/sources/{source}/source_transactions/{source_transaction} Retrieve a source transaction

Retrieve an existing source transaction object. Supply the unique source ID from a source creation request and the source transaction ID and Stripe will return the corresponding up-to-date source object information.

operationId: GetSourcesSourceSourceTransactionsSourceTransaction

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
source	path	required	string
source_transaction	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/sources/{source}/source_transactions/{source_transaction}

Subscriptionitems 2 endpoints

GET /v1/subscription_items List all subscription items

Returns a list of your subscription items for a given subscription.

operationId: GetSubscriptionItems

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
subscription	query	required	string	The ID of the subscription whose items will be retrieved.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/subscription_items

GET /v1/subscription_items/{item} Retrieve a subscription item

Retrieves the subscription item with the given ID.

operationId: GetSubscriptionItemsItem

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
item	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/subscription_items/{item}

Subscriptionschedules 2 endpoints

GET /v1/subscription_schedules List all schedules

Retrieves the list of your subscription schedules.

operationId: GetSubscriptionSchedules

Parameters

Name	In	Required	Type	Description
canceled_at	query	optional		Only return subscription schedules that were created canceled the given date interval.
completed_at	query	optional		Only return subscription schedules that completed during the given date interval.
created	query	optional		Only return subscription schedules that were created during the given date interval.
customer	query	optional	string	Only return subscription schedules for the given customer.
customer_account	query	optional	string	Only return subscription schedules for the given account.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
released_at	query	optional		Only return subscription schedules that were released during the given date interval.
scheduled	query	optional	boolean	Only return subscription schedules that have not started yet.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/subscription_schedules

GET /v1/subscription_schedules/{schedule} Retrieve a schedule

Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.

operationId: GetSubscriptionSchedulesSchedule

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
schedule	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/subscription_schedules/{schedule}

Subscriptions 3 endpoints

GET /v1/subscriptions List subscriptions

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify <code>status=canceled</code>.

operationId: GetSubscriptions

Parameters

Name	In	Required	Type	Description
automatic_tax	query	optional	object	Filter subscriptions by their automatic tax settings.
collection_method	query	optional	string	The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`.
created	query	optional		Only return subscriptions that were created during the given date interval.
current_period_end	query	optional		Only return subscriptions whose minimum item current_period_end falls within the given date interval.
current_period_start	query	optional		Only return subscriptions whose maximum item current_period_start falls within the given date interval.
customer	query	optional	string	The ID of the customer whose subscriptions you're retrieving.
customer_account	query	optional	string	The ID of the account representing the customer whose subscriptions you're retrieving.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
price	query	optional	string	Filter for subscriptions that contain this recurring price ID.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
status	query	optional	string	The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://docs.stripe.com/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.
test_clock	query	optional	string	Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/subscriptions

GET /v1/subscriptions/search Search subscriptions

Search for subscriptions you’ve previously created using Stripe’s <a href="/docs/search#search-query-language">Search Query Language</a>. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

operationId: GetSubscriptionsSearch

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
page	query	optional	string	A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
query	query	required	string	The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for subscriptions](https://docs.stripe.com/search#query-fields-for-subscriptions).

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/subscriptions/search

GET /v1/subscriptions/{subscription_exposed_id} Retrieve a subscription

Retrieves the subscription with the given ID.

operationId: GetSubscriptionsSubscriptionExposedId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
subscription_exposed_id	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/subscriptions/{subscription_exposed_id}

Tax 8 endpoints

GET /v1/tax/associations/find Find a Tax Association

Finds a tax association object by PaymentIntent id.

operationId: GetTaxAssociationsFind

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
payment_intent	query	required	string	Valid [PaymentIntent](https://docs.stripe.com/api/payment_intents/object) id

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/tax/associations/find

GET /v1/tax/calculations/{calculation} Retrieve a Tax Calculation

Retrieves a Tax <code>Calculation</code> object, if the calculation hasn’t expired.

operationId: GetTaxCalculationsCalculation

Parameters

Name	In	Required	Type	Description
calculation	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/tax/calculations/{calculation}

GET /v1/tax/calculations/{calculation}/line_items Retrieve a calculation's line items

Retrieves the line items of a tax calculation as a collection, if the calculation hasn’t expired.

operationId: GetTaxCalculationsCalculationLineItems

Parameters

Name	In	Required	Type	Description
calculation	path	required	string
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/tax/calculations/{calculation}/line_items

GET /v1/tax/registrations List registrations

Returns a list of Tax <code>Registration</code> objects.

operationId: GetTaxRegistrations

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
status	query	optional	string	The status of the Tax Registration.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/tax/registrations

GET /v1/tax/registrations/{id} Retrieve a registration

Returns a Tax <code>Registration</code> object.

operationId: GetTaxRegistrationsId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/tax/registrations/{id}

GET /v1/tax/settings Retrieve settings

Retrieves Tax <code>Settings</code> for a merchant.

operationId: GetTaxSettings

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/tax/settings

GET /v1/tax/transactions/{transaction} Retrieve a transaction

Retrieves a Tax <code>Transaction</code> object.

operationId: GetTaxTransactionsTransaction

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
transaction	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/tax/transactions/{transaction}

GET /v1/tax/transactions/{transaction}/line_items Retrieve a transaction's line items

Retrieves the line items of a committed standalone transaction as a collection.

operationId: GetTaxTransactionsTransactionLineItems

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
transaction	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/tax/transactions/{transaction}/line_items

Taxcodes 2 endpoints

GET /v1/tax_codes List all tax codes

A list of <a href="https://stripe.com/docs/tax/tax-categories">all tax codes available</a> to add to Products in order to allow specific tax calculations.

operationId: GetTaxCodes

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/tax_codes

GET /v1/tax_codes/{id} Retrieve a tax code

Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.

operationId: GetTaxCodesId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/tax_codes/{id}

Taxids 2 endpoints

GET /v1/tax_ids List all tax IDs

Returns a list of tax IDs.

operationId: GetTaxIds

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
owner	query	optional	object	The account or customer the tax ID belongs to. Defaults to `owner[type]=self`.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/tax_ids

GET /v1/tax_ids/{id} Retrieve a tax ID

Retrieves an account or customer <code>tax_id</code> object.

operationId: GetTaxIdsId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/tax_ids/{id}

Taxrates 2 endpoints

GET /v1/tax_rates List all tax rates

Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.

operationId: GetTaxRates

Parameters

Name	In	Required	Type	Description
active	query	optional	boolean	Optional flag to filter by tax rates that are either active or inactive (archived).
created	query	optional		Optional range for filtering created date.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
inclusive	query	optional	boolean	Optional flag to filter by tax rates that are inclusive (or those that are not inclusive).
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/tax_rates

GET /v1/tax_rates/{tax_rate} Retrieve a tax rate

Retrieves a tax rate with the given ID

operationId: GetTaxRatesTaxRate

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
tax_rate	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/tax_rates/{tax_rate}

Terminal 6 endpoints

GET /v1/terminal/configurations List all Configurations

Returns a list of <code>Configuration</code> objects.

operationId: GetTerminalConfigurations

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
is_account_default	query	optional	boolean	if present, only return the account default or non-default configurations.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/terminal/configurations

GET /v1/terminal/configurations/{configuration} Retrieve a Configuration

Retrieves a <code>Configuration</code> object.

operationId: GetTerminalConfigurationsConfiguration

Parameters

Name	In	Required	Type	Description
configuration	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/terminal/configurations/{configuration}

GET /v1/terminal/locations List all Locations

Returns a list of <code>Location</code> objects.

operationId: GetTerminalLocations

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/terminal/locations

GET /v1/terminal/locations/{location} Retrieve a Location

Retrieves a <code>Location</code> object.

operationId: GetTerminalLocationsLocation

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
location	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/terminal/locations/{location}

GET /v1/terminal/readers List all Readers

Returns a list of <code>Reader</code> objects.

operationId: GetTerminalReaders

Parameters

Name	In	Required	Type	Description
device_type	query	optional	string	Filters readers by device type
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
location	query	optional	string	A location ID to filter the response list to only readers at the specific location
serial_number	query	optional	string	Filters readers by serial number
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
status	query	optional	string	A status filter to filter readers to only offline or online readers

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/terminal/readers

GET /v1/terminal/readers/{reader} Retrieve a Reader

Retrieves a <code>Reader</code> object.

operationId: GetTerminalReadersReader

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
reader	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/terminal/readers/{reader}

Testhelpers 2 endpoints

GET /v1/test_helpers/test_clocks List all test clocks

Returns a list of your test clocks.

operationId: GetTestHelpersTestClocks

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/test_helpers/test_clocks

GET /v1/test_helpers/test_clocks/{test_clock} Retrieve a test clock

Retrieves a test clock.

operationId: GetTestHelpersTestClocksTestClock

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
test_clock	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/test_helpers/test_clocks/{test_clock}

Tokens 1 endpoints

GET /v1/tokens/{token} Retrieve a token

Retrieves the token with the given ID.

operationId: GetTokensToken

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
token	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/tokens/{token}

Topups 2 endpoints

GET /v1/topups List all top-ups

Returns a list of top-ups.

operationId: GetTopups

Parameters

Name	In	Required	Type	Description
amount	query	optional		A positive integer representing how much to transfer.
created	query	optional		A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
status	query	optional	string	Only return top-ups that have the given status. One of `canceled`, `failed`, `pending` or `succeeded`.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/topups

GET /v1/topups/{topup} Retrieve a top-up

Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.

operationId: GetTopupsTopup

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
topup	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/topups/{topup}

Transfers 4 endpoints

GET /v1/transfers List all transfers

Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.

operationId: GetTransfers

Parameters

Name	In	Required	Type	Description
created	query	optional		Only return transfers that were created during the given date interval.
destination	query	optional	string	Only return transfers for the destination specified by this account ID.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
transfer_group	query	optional	string	Only return transfers with the specified transfer group.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/transfers

GET /v1/transfers/{id}/reversals List all reversals

You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the <code>limit</code> and <code>starting_after</code> parameters to page through additional reversals.

operationId: GetTransfersIdReversals

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/transfers/{id}/reversals

GET /v1/transfers/{transfer} Retrieve a transfer

Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.

operationId: GetTransfersTransfer

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
transfer	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/transfers/{transfer}

GET /v1/transfers/{transfer}/reversals/{id} Retrieve a reversal

By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.

operationId: GetTransfersTransferReversalsId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string
transfer	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/transfers/{transfer}/reversals/{id}

Treasury 21 endpoints

GET /v1/treasury/credit_reversals List all CreditReversals

Returns a list of CreditReversals.

operationId: GetTreasuryCreditReversals

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
financial_account	query	required	string	Returns objects associated with this FinancialAccount.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
received_credit	query	optional	string	Only return CreditReversals for the ReceivedCredit ID.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
status	query	optional	string	Only return CreditReversals for a given status.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/treasury/credit_reversals

GET /v1/treasury/credit_reversals/{credit_reversal} Retrieve a CreditReversal

Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list

operationId: GetTreasuryCreditReversalsCreditReversal

Parameters

Name	In	Required	Type	Description
credit_reversal	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/treasury/credit_reversals/{credit_reversal}

GET /v1/treasury/debit_reversals List all DebitReversals

Returns a list of DebitReversals.

operationId: GetTreasuryDebitReversals

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
financial_account	query	required	string	Returns objects associated with this FinancialAccount.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
received_debit	query	optional	string	Only return DebitReversals for the ReceivedDebit ID.
resolution	query	optional	string	Only return DebitReversals for a given resolution.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
status	query	optional	string	Only return DebitReversals for a given status.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/treasury/debit_reversals

GET /v1/treasury/debit_reversals/{debit_reversal} Retrieve a DebitReversal

Retrieves a DebitReversal object.

operationId: GetTreasuryDebitReversalsDebitReversal

Parameters

Name	In	Required	Type	Description
debit_reversal	path	required	string
expand	query	optional	array	Specifies which fields in the response should be expanded.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/treasury/debit_reversals/{debit_reversal}

GET /v1/treasury/financial_accounts List all FinancialAccounts

Returns a list of FinancialAccounts.

operationId: GetTreasuryFinancialAccounts

Parameters

Name	In	Required	Type	Description
created	query	optional		Only return FinancialAccounts that were created during the given date interval.
ending_before	query	optional	string	An object ID cursor for use in pagination.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit ranging from 1 to 100 (defaults to 10).
starting_after	query	optional	string	An object ID cursor for use in pagination.
status	query	optional	string	Only return FinancialAccounts that have the given status: `open` or `closed`

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/treasury/financial_accounts

GET /v1/treasury/financial_accounts/{financial_account} Retrieve a FinancialAccount

Retrieves the details of a FinancialAccount.

operationId: GetTreasuryFinancialAccountsFinancialAccount

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
financial_account	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/treasury/financial_accounts/{financial_account}

GET /v1/treasury/financial_accounts/{financial_account}/features Retrieve FinancialAccount Features

Retrieves Features information associated with the FinancialAccount.

operationId: GetTreasuryFinancialAccountsFinancialAccountFeatures

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
financial_account	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/treasury/financial_accounts/{financial_account}/features

GET /v1/treasury/inbound_transfers List all InboundTransfers

Returns a list of InboundTransfers sent from the specified FinancialAccount.

operationId: GetTreasuryInboundTransfers

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
financial_account	query	required	string	Returns objects associated with this FinancialAccount.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
status	query	optional	string	Only return InboundTransfers that have the given status: `processing`, `succeeded`, `failed` or `canceled`.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/treasury/inbound_transfers

GET /v1/treasury/inbound_transfers/{id} Retrieve an InboundTransfer

Retrieves the details of an existing InboundTransfer.

operationId: GetTreasuryInboundTransfersId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/treasury/inbound_transfers/{id}

GET /v1/treasury/outbound_payments List all OutboundPayments

Returns a list of OutboundPayments sent from the specified FinancialAccount.

operationId: GetTreasuryOutboundPayments

Parameters

Name	In	Required	Type	Description
created	query	optional		Only return OutboundPayments that were created during the given date interval.
customer	query	optional	string	Only return OutboundPayments sent to this customer.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
financial_account	query	required	string	Returns objects associated with this FinancialAccount.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
status	query	optional	string	Only return OutboundPayments that have the given status: `processing`, `failed`, `posted`, `returned`, or `canceled`.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/treasury/outbound_payments

GET /v1/treasury/outbound_payments/{id} Retrieve an OutboundPayment

Retrieves the details of an existing OutboundPayment by passing the unique OutboundPayment ID from either the OutboundPayment creation request or OutboundPayment list.

operationId: GetTreasuryOutboundPaymentsId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/treasury/outbound_payments/{id}

GET /v1/treasury/outbound_transfers List all OutboundTransfers

Returns a list of OutboundTransfers sent from the specified FinancialAccount.

operationId: GetTreasuryOutboundTransfers

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
financial_account	query	required	string	Returns objects associated with this FinancialAccount.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
status	query	optional	string	Only return OutboundTransfers that have the given status: `processing`, `canceled`, `failed`, `posted`, or `returned`.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/treasury/outbound_transfers

GET /v1/treasury/outbound_transfers/{outbound_transfer} Retrieve an OutboundTransfer

Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.

operationId: GetTreasuryOutboundTransfersOutboundTransfer

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
outbound_transfer	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/treasury/outbound_transfers/{outbound_transfer}

GET /v1/treasury/received_credits List all ReceivedCredits

Returns a list of ReceivedCredits.

operationId: GetTreasuryReceivedCredits

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
financial_account	query	required	string	The FinancialAccount that received the funds.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
linked_flows	query	optional	object	Only return ReceivedCredits described by the flow.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
status	query	optional	string	Only return ReceivedCredits that have the given status: `succeeded` or `failed`.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/treasury/received_credits

GET /v1/treasury/received_credits/{id} Retrieve a ReceivedCredit

Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.

operationId: GetTreasuryReceivedCreditsId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/treasury/received_credits/{id}

GET /v1/treasury/received_debits List all ReceivedDebits

Returns a list of ReceivedDebits.

operationId: GetTreasuryReceivedDebits

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
financial_account	query	required	string	The FinancialAccount that funds were pulled from.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
status	query	optional	string	Only return ReceivedDebits that have the given status: `succeeded` or `failed`.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/treasury/received_debits

GET /v1/treasury/received_debits/{id} Retrieve a ReceivedDebit

Retrieves the details of an existing ReceivedDebit by passing the unique ReceivedDebit ID from the ReceivedDebit list

operationId: GetTreasuryReceivedDebitsId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/treasury/received_debits/{id}

GET /v1/treasury/transaction_entries List all TransactionEntries

Retrieves a list of TransactionEntry objects.

operationId: GetTreasuryTransactionEntries

Parameters

Name	In	Required	Type	Description
created	query	optional		Only return TransactionEntries that were created during the given date interval.
effective_at	query	optional
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
financial_account	query	required	string	Returns objects associated with this FinancialAccount.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
order_by	query	optional	string	The results are in reverse chronological order by `created` or `effective_at`. The default is `created`.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
transaction	query	optional	string	Only return TransactionEntries associated with this Transaction.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/treasury/transaction_entries

GET /v1/treasury/transaction_entries/{id} Retrieve a TransactionEntry

Retrieves a TransactionEntry object.

operationId: GetTreasuryTransactionEntriesId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/treasury/transaction_entries/{id}

GET /v1/treasury/transactions List all Transactions

Retrieves a list of Transaction objects.

operationId: GetTreasuryTransactions

Parameters

Name	In	Required	Type	Description
created	query	optional		Only return Transactions that were created during the given date interval.
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
financial_account	query	required	string	Returns objects associated with this FinancialAccount.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
order_by	query	optional	string	The results are in reverse chronological order by `created` or `posted_at`. The default is `created`.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
status	query	optional	string	Only return Transactions that have the given status: `open`, `posted`, or `void`.
status_transitions	query	optional	object	A filter for the `status_transitions.posted_at` timestamp. When using this filter, `status=posted` and `order_by=posted_at` must also be specified.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/treasury/transactions

GET /v1/treasury/transactions/{id} Retrieve a Transaction

Retrieves the details of an existing Transaction.

operationId: GetTreasuryTransactionsId

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
id	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/treasury/transactions/{id}

Webhookendpoints 2 endpoints

GET /v1/webhook_endpoints List all webhook endpoints

Returns a list of your webhook endpoints.

operationId: GetWebhookEndpoints

Parameters

Name	In	Required	Type	Description
ending_before	query	optional	string	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	query	optional	array	Specifies which fields in the response should be expanded.
limit	query	optional	integer	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	query	optional	string	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/webhook_endpoints

GET /v1/webhook_endpoints/{webhook_endpoint} Retrieve a webhook endpoint

Retrieves the webhook endpoint with the given ID.

operationId: GetWebhookEndpointsWebhookEndpoint

Parameters

Name	In	Required	Type	Description
expand	query	optional	array	Specifies which fields in the response should be expanded.
webhook_endpoint	path	required	string

Request Body

{
  "content": {
    "application/x-www-form-urlencoded": {
      "schema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "encoding": {}
    }
  },
  "required": false
}

Responses

default Error response.

200 Successful response.

GET /v1/webhook_endpoints/{webhook_endpoint}

Schemas

object account

{
  "type": "object",
  "title": "Account",
  "required": [
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "type": {
      "enum": [
        "custom",
        "express",
        "none",
        "standard"
      ],
      "type": "string",
      "description": "The Stripe account type. Can be `standard`, `express`, `custom`, or `none`."
    },
    "email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform."
    },
    "groups": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/account_group_membership"
        }
      ],
      "nullable": true,
      "description": "The groups associated with the account."
    },
    "object": {
      "enum": [
        "account"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "company": {
      "$ref": "#/components/schemas/legal_entity_company"
    },
    "country": {
      "type": "string",
      "maxLength": 5000,
      "description": "The account's country."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the account was connected. Measured in seconds since the Unix epoch."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "settings": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/account_settings"
        }
      ],
      "nullable": true,
      "description": "Options for customizing how the account functions within Stripe."
    },
    "controller": {
      "$ref": "#/components/schemas/account_unification_account_controller"
    },
    "individual": {
      "$ref": "#/components/schemas/person"
    },
    "capabilities": {
      "$ref": "#/components/schemas/account_capabilities"
    },
    "requirements": {
      "$ref": "#/components/schemas/account_requirements"
    },
    "business_type": {
      "enum": [
        "company",
        "government_entity",
        "individual",
        "non_profit"
      ],
      "type": "string",
      "nullable": true,
      "description": "The business type.",
      "x-stripeBypassValidation": true
    },
    "tos_acceptance": {
      "$ref": "#/components/schemas/account_tos_acceptance"
    },
    "charges_enabled": {
      "type": "boolean",
      "description": "Whether the account can process charges."
    },
    "payouts_enabled": {
      "type": "boolean",
      "description": "Whether the funds in this account can be paid out."
    },
    "business_profile": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/account_business_profile"
        }
      ],
      "nullable": true,
      "description": "Business information about the account."
    },
    "default_currency": {
      "type": "string",
      "maxLength": 5000,
      "description": "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts)."
    },
    "details_submitted": {
      "type": "boolean",
      "description": "Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to [an onboarding flow](/connect/onboarding) to finish submitting account details."
    },
    "external_accounts": {
      "type": "object",
      "title": "ExternalAccountList",
      "required": [
        "data",
        "has_more",
        "object",
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "maxLength": 5000,
          "description": "The URL where this list can be accessed."
        },
        "data": {
          "type": "array",
          "items": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/bank_account"
              },
              {
                "$ref": "#/components/schemas/card"
              }
            ],
            "title": "Polymorphic",
            "x-stripeBypassValidation": true
          },
          "description": "The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards."
        },
        "object": {
          "enum": [
            "list"
          ],
          "type": "string",
          "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
        },
        "has_more": {
          "type": "boolean",
          "description": "True if this list has another page of items after this one that can be fetched."
        }
      },
      "description": "External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests where `controller[is_controller]` is true.",
      "x-expandableFields": [
        "data"
      ]
    },
    "future_requirements": {
      "$ref": "#/components/schemas/account_future_requirements"
    }
  },
  "description": "For new integrations, we recommend using the [Accounts v2 API](/api/v2/core/accounts), in place of /v1/accounts and /v1/customers to represent a user.\n\nThis is an object representing a Stripe account. You can retrieve it to see\nproperties on the account like its current requirements or if the account is\nenabled to make live charges or receive payouts.\n\nFor accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection)\nis `application`, which includes Custom accounts, the properties below are always\nreturned.\n\nFor accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection)\nis `stripe`, which includes Standard and Express accounts, some properties are only returned\nuntil you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions)\nto start Connect Onboarding. Learn about the [differences between accounts](/connect/accounts).",
  "x-resourceId": "account",
  "x-expandableFields": [
    "business_profile",
    "capabilities",
    "company",
    "controller",
    "external_accounts",
    "future_requirements",
    "groups",
    "individual",
    "requirements",
    "settings",
    "tos_acceptance"
  ]
}

object account_annual_revenue

{
  "type": "object",
  "title": "AccountAnnualRevenue",
  "properties": {
    "amount": {
      "type": "integer",
      "nullable": true,
      "description": "A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal)."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "nullable": true,
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "fiscal_year_end": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_bacs_debit_payments_settings

{
  "type": "object",
  "title": "AccountBacsDebitPaymentsSettings",
  "properties": {
    "display_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Bacs Direct Debit display name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. The fee appears 5 business days after requesting Bacs. If you don't set the display name before requesting Bacs capability, it's automatically set as \"Stripe\" and the account is onboarded to Stripe branding, which is free."
    },
    "service_user_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Bacs Direct Debit Service user number for this account. For payments made with Bacs Direct Debit, this number is a unique identifier of the account with our banking partners."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_branding_settings

{
  "type": "object",
  "title": "AccountBrandingSettings",
  "properties": {
    "icon": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    },
    "logo": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    },
    "primary_color": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A CSS hex color value representing the primary branding color for this account"
    },
    "secondary_color": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A CSS hex color value representing the secondary branding color for this account"
    }
  },
  "description": "",
  "x-expandableFields": [
    "icon",
    "logo"
  ]
}

object account_business_profile

{
  "type": "object",
  "title": "AccountBusinessProfile",
  "properties": {
    "mcc": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "[The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide."
    },
    "url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The business's publicly available website."
    },
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The customer-facing business name."
    },
    "support_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A publicly available website for handling support issues."
    },
    "support_email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A publicly available email address for sending support issues to."
    },
    "support_phone": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A publicly available phone number to call with support issues."
    },
    "annual_revenue": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/account_annual_revenue"
        }
      ],
      "nullable": true,
      "description": "The applicant's gross annual revenue for its preceding fiscal year."
    },
    "support_address": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/address"
        }
      ],
      "nullable": true,
      "description": "A publicly available mailing address for sending support issues to."
    },
    "product_description": {
      "type": "string",
      "nullable": true,
      "maxLength": 40000,
      "description": "Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes."
    },
    "estimated_worker_count": {
      "type": "integer",
      "nullable": true,
      "description": "An estimated upper bound of employees, contractors, vendors, etc. currently working for the business."
    },
    "monthly_estimated_revenue": {
      "$ref": "#/components/schemas/account_monthly_estimated_revenue"
    },
    "minority_owned_business_designation": {
      "type": "array",
      "items": {
        "enum": [
          "lgbtqi_owned_business",
          "minority_owned_business",
          "none_of_these_apply",
          "prefer_not_to_answer",
          "women_owned_business"
        ],
        "type": "string"
      },
      "nullable": true,
      "description": "Whether the business is a minority-owned, women-owned, and/or LGBTQI+ -owned business."
    }
  },
  "description": "",
  "x-expandableFields": [
    "annual_revenue",
    "monthly_estimated_revenue",
    "support_address"
  ]
}

object account_capabilities

{
  "type": "object",
  "title": "AccountCapabilities",
  "properties": {
    "treasury": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the banking capability, or whether the account can have bank accounts."
    },
    "transfers": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the transfers capability of the account, or whether your platform can transfer funds to the account."
    },
    "card_issuing": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards"
    },
    "eps_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the EPS payments capability of the account, or whether the account can directly process EPS charges."
    },
    "fpx_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the FPX payments capability of the account, or whether the account can directly process FPX charges."
    },
    "jcb_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the JCB payments capability of the account, or whether the account (Japan only) can directly process JCB credit card charges in JPY currency."
    },
    "p24_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the P24 payments capability of the account, or whether the account can directly process P24 charges."
    },
    "pix_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the pix payments capability of the account, or whether the account can directly process pix charges."
    },
    "upi_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the upi payments capability of the account, or whether the account can directly process upi charges."
    },
    "zip_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Zip capability of the account, or whether the account can directly process Zip charges."
    },
    "alma_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Alma capability of the account, or whether the account can directly process Alma payments."
    },
    "blik_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the blik payments capability of the account, or whether the account can directly process blik charges."
    },
    "card_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges."
    },
    "link_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the link_payments capability of the account, or whether the account can directly process Link charges."
    },
    "oxxo_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges."
    },
    "ideal_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges."
    },
    "payco_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Payco capability of the account, or whether the account can directly process Payco payments."
    },
    "payto_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the PayTo capability of the account, or whether the account can directly process PayTo charges."
    },
    "swish_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Swish capability of the account, or whether the account can directly process Swish payments."
    },
    "twint_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the TWINT capability of the account, or whether the account can directly process TWINT charges."
    },
    "affirm_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Affirm capability of the account, or whether the account can directly process Affirm charges."
    },
    "billie_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Billie capability of the account, or whether the account can directly process Billie payments."
    },
    "boleto_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the boleto payments capability of the account, or whether the account can directly process boleto charges."
    },
    "crypto_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Crypto capability of the account, or whether the account can directly process Crypto payments."
    },
    "klarna_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges."
    },
    "legacy_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the legacy payments capability of the account."
    },
    "mb_way_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the MB WAY payments capability of the account, or whether the account can directly process MB WAY charges."
    },
    "paynow_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the paynow payments capability of the account, or whether the account can directly process paynow charges."
    },
    "sofort_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges."
    },
    "cashapp_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Cash App Pay capability of the account, or whether the account can directly process Cash App Pay payments."
    },
    "giropay_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the giropay payments capability of the account, or whether the account can directly process giropay charges."
    },
    "grabpay_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges."
    },
    "konbini_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the konbini payments capability of the account, or whether the account can directly process konbini charges."
    },
    "kr_card_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the KrCard capability of the account, or whether the account can directly process KrCard payments."
    },
    "satispay_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Satispay capability of the account, or whether the account can directly process Satispay payments."
    },
    "kakao_pay_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the KakaoPay capability of the account, or whether the account can directly process KakaoPay payments."
    },
    "mobilepay_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the MobilePay capability of the account, or whether the account can directly process MobilePay charges."
    },
    "naver_pay_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the NaverPay capability of the account, or whether the account can directly process NaverPay payments."
    },
    "promptpay_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the promptpay payments capability of the account, or whether the account can directly process promptpay charges."
    },
    "acss_debit_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Canadian pre-authorized debits payments capability of the account, or whether the account can directly process Canadian pre-authorized debits charges."
    },
    "amazon_pay_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the AmazonPay capability of the account, or whether the account can directly process AmazonPay payments."
    },
    "bacs_debit_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges."
    },
    "bancontact_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges."
    },
    "multibanco_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Multibanco payments capability of the account, or whether the account can directly process Multibanco charges."
    },
    "sepa_debit_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges."
    },
    "pay_by_bank_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the pay_by_bank payments capability of the account, or whether the account can directly process pay_by_bank charges."
    },
    "revolut_pay_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the RevolutPay capability of the account, or whether the account can directly process RevolutPay payments."
    },
    "samsung_pay_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the SamsungPay capability of the account, or whether the account can directly process SamsungPay payments."
    },
    "au_becs_debit_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the BECS Direct Debit (AU) payments capability of the account, or whether the account can directly process BECS Direct Debit (AU) charges."
    },
    "bank_transfer_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the customer_balance payments capability of the account, or whether the account can directly process customer_balance charges."
    },
    "tax_reporting_us_1099_k": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the tax reporting 1099-K (US) capability of the account."
    },
    "cartes_bancaires_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Cartes Bancaires payments capability of the account, or whether the account can directly process Cartes Bancaires card charges in EUR currency."
    },
    "gb_bank_transfer_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the GB customer_balance payments (GBP currency) capability of the account, or whether the account can directly process GB customer_balance charges."
    },
    "jp_bank_transfer_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Japanese customer_balance payments (JPY currency) capability of the account, or whether the account can directly process Japanese customer_balance charges."
    },
    "mx_bank_transfer_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Mexican customer_balance payments (MXN currency) capability of the account, or whether the account can directly process Mexican customer_balance charges."
    },
    "us_bank_transfer_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the US customer_balance payments (USD currency) capability of the account, or whether the account can directly process US customer_balance charges."
    },
    "afterpay_clearpay_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges."
    },
    "tax_reporting_us_1099_misc": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the tax reporting 1099-MISC (US) capability of the account."
    },
    "sepa_bank_transfer_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the SEPA customer_balance payments (EUR currency) capability of the account, or whether the account can directly process SEPA customer_balance charges."
    },
    "india_international_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the india_international_payments capability of the account, or whether the account can process international charges (non INR) in India."
    },
    "us_bank_account_ach_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the US bank account ACH payments capability of the account, or whether the account can directly process US bank account charges."
    },
    "nz_bank_account_becs_debit_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the New Zealand BECS Direct Debit payments capability of the account, or whether the account can directly process New Zealand BECS Direct Debit charges."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_capability_future_requirements

{
  "type": "object",
  "title": "AccountCapabilityFutureRequirements",
  "required": [
    "currently_due",
    "errors",
    "eventually_due",
    "past_due",
    "pending_verification"
  ],
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/account_requirements_error"
      },
      "description": "Details about validation and verification failures for `due` requirements that must be resolved."
    },
    "past_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Fields that haven't been resolved by `requirements.current_deadline`. These fields need to be resolved to enable the capability on the account. `future_requirements.past_due` is a subset of `requirements.past_due`."
    },
    "alternatives": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/account_requirements_alternative"
      },
      "nullable": true,
      "description": "Fields that are due and can be resolved by providing the corresponding alternative fields instead. Multiple alternatives can reference the same `original_fields_due`. When this happens, any of these alternatives can serve as a pathway for attempting to resolve the fields. Additionally, providing `original_fields_due` again also serves as a pathway for attempting to resolve the fields."
    },
    "currently_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Fields that need to be resolved to keep the capability enabled. If not resolved by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash."
    },
    "eventually_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well."
    },
    "disabled_reason": {
      "enum": [
        "other",
        "paused.inactivity",
        "pending.onboarding",
        "pending.review",
        "platform_disabled",
        "platform_paused",
        "rejected.inactivity",
        "rejected.other",
        "rejected.unsupported_business",
        "requirements.fields_needed"
      ],
      "type": "string",
      "nullable": true,
      "description": "This is typed as an enum for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is null because fields in `future_requirements` will never disable the account.",
      "x-stripeBypassValidation": true
    },
    "current_deadline": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning."
    },
    "pending_verification": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending."
    }
  },
  "description": "",
  "x-expandableFields": [
    "alternatives",
    "errors"
  ]
}

object account_capability_requirements

{
  "type": "object",
  "title": "AccountCapabilityRequirements",
  "required": [
    "currently_due",
    "errors",
    "eventually_due",
    "past_due",
    "pending_verification"
  ],
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/account_requirements_error"
      },
      "description": "Details about validation and verification failures for `due` requirements that must be resolved."
    },
    "past_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the capability on the account."
    },
    "alternatives": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/account_requirements_alternative"
      },
      "nullable": true,
      "description": "Fields that are due and can be resolved by providing the corresponding alternative fields instead. Multiple alternatives can reference the same `original_fields_due`. When this happens, any of these alternatives can serve as a pathway for attempting to resolve the fields. Additionally, providing `original_fields_due` again also serves as a pathway for attempting to resolve the fields."
    },
    "currently_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Fields that need to be resolved to keep the capability enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the capability is disabled."
    },
    "eventually_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set."
    },
    "disabled_reason": {
      "enum": [
        "other",
        "paused.inactivity",
        "pending.onboarding",
        "pending.review",
        "platform_disabled",
        "platform_paused",
        "rejected.inactivity",
        "rejected.other",
        "rejected.unsupported_business",
        "requirements.fields_needed"
      ],
      "type": "string",
      "nullable": true,
      "description": "Description of why the capability is disabled. [Learn more about handling verification issues](https://docs.stripe.com/connect/handling-api-verification).",
      "x-stripeBypassValidation": true
    },
    "current_deadline": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The date by which all required account information must be both submitted and verified. This includes fields listed in `currently_due` as well as those in `pending_verification`. If any required information is missing or unverified by this date, the account may be disabled. Note that `current_deadline` may change if additional `currently_due` requirements are requested."
    },
    "pending_verification": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending."
    }
  },
  "description": "",
  "x-expandableFields": [
    "alternatives",
    "errors"
  ]
}

object account_card_issuing_settings

{
  "type": "object",
  "title": "AccountCardIssuingSettings",
  "properties": {
    "tos_acceptance": {
      "$ref": "#/components/schemas/card_issuing_account_terms_of_service"
    }
  },
  "description": "",
  "x-expandableFields": [
    "tos_acceptance"
  ]
}

object account_card_payments_settings

{
  "type": "object",
  "title": "AccountCardPaymentsSettings",
  "properties": {
    "decline_on": {
      "$ref": "#/components/schemas/account_decline_charge_on"
    },
    "statement_descriptor_prefix": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion."
    },
    "statement_descriptor_prefix_kana": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion."
    },
    "statement_descriptor_prefix_kanji": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion."
    }
  },
  "description": "",
  "x-expandableFields": [
    "decline_on"
  ]
}

object account_dashboard_settings

{
  "type": "object",
  "title": "AccountDashboardSettings",
  "properties": {
    "timezone": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The timezone used in the Stripe Dashboard for this account. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones)."
    },
    "display_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_decline_charge_on

{
  "type": "object",
  "title": "AccountDeclineChargeOn",
  "required": [
    "avs_failure",
    "cvc_failure"
  ],
  "properties": {
    "avs_failure": {
      "type": "boolean",
      "description": "Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification."
    },
    "cvc_failure": {
      "type": "boolean",
      "description": "Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_future_requirements

{
  "type": "object",
  "title": "AccountFutureRequirements",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/account_requirements_error"
      },
      "nullable": true,
      "description": "Details about validation and verification failures for `due` requirements that must be resolved."
    },
    "past_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "Fields that haven't been resolved by `requirements.current_deadline`. These fields need to be resolved to enable the capability on the account. `future_requirements.past_due` is a subset of `requirements.past_due`."
    },
    "alternatives": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/account_requirements_alternative"
      },
      "nullable": true,
      "description": "Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again."
    },
    "currently_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "Fields that need to be resolved to keep the account enabled. If not resolved by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash."
    },
    "eventually_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well."
    },
    "disabled_reason": {
      "enum": [
        "action_required.requested_capabilities",
        "listed",
        "other",
        "platform_paused",
        "rejected.fraud",
        "rejected.incomplete_verification",
        "rejected.listed",
        "rejected.other",
        "rejected.platform_fraud",
        "rejected.platform_other",
        "rejected.platform_terms_of_service",
        "rejected.terms_of_service",
        "requirements.past_due",
        "requirements.pending_verification",
        "under_review"
      ],
      "type": "string",
      "nullable": true,
      "description": "This is typed as an enum for consistency with `requirements.disabled_reason`."
    },
    "current_deadline": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on its enablement state prior to transitioning."
    },
    "pending_verification": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending."
    }
  },
  "description": "",
  "x-expandableFields": [
    "alternatives",
    "errors"
  ]
}

object account_group_membership

{
  "type": "object",
  "title": "AccountGroupMembership",
  "properties": {
    "payments_pricing": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://docs.stripe.com/connect/platform-pricing-tools) for details."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_invoices_settings

{
  "type": "object",
  "title": "AccountInvoicesSettings",
  "properties": {
    "default_account_tax_ids": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 5000
          },
          {
            "$ref": "#/components/schemas/tax_id"
          }
        ],
        "x-expansionResources": {
          "oneOf": [
            {
              "$ref": "#/components/schemas/tax_id"
            }
          ]
        }
      },
      "nullable": true,
      "description": "The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized."
    },
    "hosted_payment_method_save": {
      "enum": [
        "always",
        "never",
        "offer"
      ],
      "type": "string",
      "nullable": true,
      "description": "Whether to save the payment method after a payment is completed for a one-time invoice or a subscription invoice when the customer already has a default payment method on the hosted invoice page."
    }
  },
  "description": "",
  "x-expandableFields": [
    "default_account_tax_ids"
  ]
}

object account_link

{
  "type": "object",
  "title": "AccountLink",
  "required": [
    "created",
    "expires_at",
    "object",
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 5000,
      "description": "The URL for the account link."
    },
    "object": {
      "enum": [
        "account_link"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "expires_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "The timestamp at which this account link will expire."
    }
  },
  "description": "Account Links are the means by which a Connect platform grants a connected account permission to access\nStripe-hosted applications, such as Connect Onboarding.\n\nRelated guide: [Connect Onboarding](https://docs.stripe.com/connect/custom/hosted-onboarding)",
  "x-resourceId": "account_link",
  "x-expandableFields": []
}

object account_monthly_estimated_revenue

{
  "type": "object",
  "title": "AccountMonthlyEstimatedRevenue",
  "required": [
    "amount",
    "currency"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal)."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_payments_settings

{
  "type": "object",
  "title": "AccountPaymentsSettings",
  "properties": {
    "statement_descriptor": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge."
    },
    "statement_descriptor_kana": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors)."
    },
    "statement_descriptor_kanji": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_payout_settings

{
  "type": "object",
  "title": "AccountPayoutSettings",
  "required": [
    "debit_negative_balances",
    "schedule"
  ],
  "properties": {
    "schedule": {
      "$ref": "#/components/schemas/transfer_schedule"
    },
    "statement_descriptor": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard."
    },
    "debit_negative_balances": {
      "type": "boolean",
      "description": "A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See [Understanding Connect account balances](/connect/account-balances) for details. The default value is `false` when [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, otherwise `true`."
    }
  },
  "description": "",
  "x-expandableFields": [
    "schedule"
  ]
}

object account_requirements

{
  "type": "object",
  "title": "AccountRequirements",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/account_requirements_error"
      },
      "nullable": true,
      "description": "Details about validation and verification failures for `due` requirements that must be resolved."
    },
    "past_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the account."
    },
    "alternatives": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/account_requirements_alternative"
      },
      "nullable": true,
      "description": "Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again."
    },
    "currently_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "Fields that need to be resolved to keep the account enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled."
    },
    "eventually_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set."
    },
    "disabled_reason": {
      "enum": [
        "action_required.requested_capabilities",
        "listed",
        "other",
        "platform_paused",
        "rejected.fraud",
        "rejected.incomplete_verification",
        "rejected.listed",
        "rejected.other",
        "rejected.platform_fraud",
        "rejected.platform_other",
        "rejected.platform_terms_of_service",
        "rejected.terms_of_service",
        "requirements.past_due",
        "requirements.pending_verification",
        "under_review"
      ],
      "type": "string",
      "nullable": true,
      "description": "If the account is disabled, this enum describes why. [Learn more about handling verification issues](https://docs.stripe.com/connect/handling-api-verification)."
    },
    "current_deadline": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Date by which the fields in `currently_due` must be collected to keep the account enabled. These fields may disable the account sooner if the next threshold is reached before they are collected."
    },
    "pending_verification": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending."
    }
  },
  "description": "",
  "x-expandableFields": [
    "alternatives",
    "errors"
  ]
}

object account_requirements_alternative

{
  "type": "object",
  "title": "AccountRequirementsAlternative",
  "required": [
    "alternative_fields_due",
    "original_fields_due"
  ],
  "properties": {
    "original_fields_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Fields that are due and can be resolved by providing all fields in `alternative_fields_due`."
    },
    "alternative_fields_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Fields that can be provided to resolve all fields in `original_fields_due`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_requirements_error

{
  "type": "object",
  "title": "AccountRequirementsError",
  "required": [
    "code",
    "reason",
    "requirement"
  ],
  "properties": {
    "code": {
      "enum": [
        "external_request",
        "information_missing",
        "invalid_address_city_state_postal_code",
        "invalid_address_highway_contract_box",
        "invalid_address_private_mailbox",
        "invalid_business_profile_name",
        "invalid_business_profile_name_denylisted",
        "invalid_company_name_denylisted",
        "invalid_dob_age_over_maximum",
        "invalid_dob_age_under_18",
        "invalid_dob_age_under_minimum",
        "invalid_product_description_length",
        "invalid_product_description_url_match",
        "invalid_representative_country",
        "invalid_signator",
        "invalid_statement_descriptor_business_mismatch",
        "invalid_statement_descriptor_denylisted",
        "invalid_statement_descriptor_length",
        "invalid_statement_descriptor_prefix_denylisted",
        "invalid_statement_descriptor_prefix_mismatch",
        "invalid_street_address",
        "invalid_tax_id",
        "invalid_tax_id_format",
        "invalid_tos_acceptance",
        "invalid_url_denylisted",
        "invalid_url_format",
        "invalid_url_web_presence_detected",
        "invalid_url_website_business_information_mismatch",
        "invalid_url_website_empty",
        "invalid_url_website_inaccessible",
        "invalid_url_website_inaccessible_geoblocked",
        "invalid_url_website_inaccessible_password_protected",
        "invalid_url_website_incomplete",
        "invalid_url_website_incomplete_cancellation_policy",
        "invalid_url_website_incomplete_customer_service_details",
        "invalid_url_website_incomplete_legal_restrictions",
        "invalid_url_website_incomplete_refund_policy",
        "invalid_url_website_incomplete_return_policy",
        "invalid_url_website_incomplete_terms_and_conditions",
        "invalid_url_website_incomplete_under_construction",
        "invalid_url_website_other",
        "invalid_value_other",
        "unsupported_business_type",
        "verification_directors_mismatch",
        "verification_document_address_mismatch",
        "verification_document_address_missing",
        "verification_document_corrupt",
        "verification_document_country_not_supported",
        "verification_document_directors_mismatch",
        "verification_document_dob_mismatch",
        "verification_document_duplicate_type",
        "verification_document_expired",
        "verification_document_failed_copy",
        "verification_document_failed_greyscale",
        "verification_document_failed_other",
        "verification_document_failed_test_mode",
        "verification_document_fraudulent",
        "verification_document_id_number_mismatch",
        "verification_document_id_number_missing",
        "verification_document_incomplete",
        "verification_document_invalid",
        "verification_document_issue_or_expiry_date_missing",
        "verification_document_manipulated",
        "verification_document_missing_back",
        "verification_document_missing_front",
        "verification_document_name_mismatch",
        "verification_document_name_missing",
        "verification_document_nationality_mismatch",
        "verification_document_not_readable",
        "verification_document_not_signed",
        "verification_document_not_uploaded",
        "verification_document_photo_mismatch",
        "verification_document_too_large",
        "verification_document_type_not_supported",
        "verification_extraneous_directors",
        "verification_failed_address_match",
        "verification_failed_authorizer_authority",
        "verification_failed_business_iec_number",
        "verification_failed_document_match",
        "verification_failed_id_number_match",
        "verification_failed_keyed_identity",
        "verification_failed_keyed_match",
        "verification_failed_name_match",
        "verification_failed_other",
        "verification_failed_representative_authority",
        "verification_failed_residential_address",
        "verification_failed_tax_id_match",
        "verification_failed_tax_id_not_issued",
        "verification_legal_entity_structure_mismatch",
        "verification_missing_directors",
        "verification_missing_executives",
        "verification_missing_owners",
        "verification_rejected_ownership_exemption_reason",
        "verification_requires_additional_memorandum_of_associations",
        "verification_requires_additional_proof_of_registration",
        "verification_supportability"
      ],
      "type": "string",
      "description": "The code for the type of error.",
      "x-stripeBypassValidation": true
    },
    "reason": {
      "type": "string",
      "maxLength": 5000,
      "description": "An informative message that indicates the error type and provides additional details about the error."
    },
    "requirement": {
      "type": "string",
      "maxLength": 5000,
      "description": "The specific user onboarding requirement field (in the requirements hash) that needs to be resolved."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_sepa_debit_payments_settings

{
  "type": "object",
  "title": "AccountSepaDebitPaymentsSettings",
  "properties": {
    "creditor_id": {
      "type": "string",
      "maxLength": 5000,
      "description": "SEPA creditor identifier that identifies the company making the payment."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_session

{
  "type": "object",
  "title": "ConnectEmbeddedMethodAccountSessionCreateMethodAccountSession",
  "required": [
    "account",
    "client_secret",
    "components",
    "expires_at",
    "livemode",
    "object"
  ],
  "properties": {
    "object": {
      "enum": [
        "account_session"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "account": {
      "type": "string",
      "maxLength": 5000,
      "description": "The ID of the account the AccountSession was created for"
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "components": {
      "$ref": "#/components/schemas/connect_embedded_account_session_create_components"
    },
    "expires_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "The timestamp at which this AccountSession will expire."
    },
    "client_secret": {
      "type": "string",
      "maxLength": 5000,
      "description": "The client secret of this AccountSession. Used on the client to set up secure access to the given `account`.\n\nThe client secret can be used to provide access to `account` from your frontend. It should not be stored, logged, or exposed to anyone other than the connected account. Make sure that you have TLS enabled on any page that includes the client secret.\n\nRefer to our docs to [setup Connect embedded components](https://docs.stripe.com/connect/get-started-connect-embedded-components) and learn about how `client_secret` should be handled."
    }
  },
  "description": "An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded components.\n\nWe recommend that you create an AccountSession each time you need to display an embedded component\nto your user. Do not save AccountSessions to your database as they expire relatively\nquickly, and cannot be used more than once.\n\nRelated guide: [Connect embedded components](https://docs.stripe.com/connect/get-started-connect-embedded-components)",
  "x-resourceId": "account_session",
  "x-expandableFields": [
    "components"
  ]
}

object account_settings

{
  "type": "object",
  "title": "AccountSettings",
  "required": [
    "branding",
    "card_payments",
    "dashboard",
    "payments"
  ],
  "properties": {
    "payouts": {
      "$ref": "#/components/schemas/account_payout_settings"
    },
    "branding": {
      "$ref": "#/components/schemas/account_branding_settings"
    },
    "invoices": {
      "$ref": "#/components/schemas/account_invoices_settings"
    },
    "payments": {
      "$ref": "#/components/schemas/account_payments_settings"
    },
    "treasury": {
      "$ref": "#/components/schemas/account_treasury_settings"
    },
    "dashboard": {
      "$ref": "#/components/schemas/account_dashboard_settings"
    },
    "card_issuing": {
      "$ref": "#/components/schemas/account_card_issuing_settings"
    },
    "card_payments": {
      "$ref": "#/components/schemas/account_card_payments_settings"
    },
    "bacs_debit_payments": {
      "$ref": "#/components/schemas/account_bacs_debit_payments_settings"
    },
    "sepa_debit_payments": {
      "$ref": "#/components/schemas/account_sepa_debit_payments_settings"
    }
  },
  "description": "",
  "x-expandableFields": [
    "bacs_debit_payments",
    "branding",
    "card_issuing",
    "card_payments",
    "dashboard",
    "invoices",
    "payments",
    "payouts",
    "sepa_debit_payments",
    "treasury"
  ]
}

object account_terms_of_service

{
  "type": "object",
  "title": "AccountTermsOfService",
  "properties": {
    "ip": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The IP address from which the account representative accepted the service agreement."
    },
    "date": {
      "type": "integer",
      "nullable": true,
      "description": "The Unix timestamp marking when the account representative accepted the service agreement."
    },
    "user_agent": {
      "type": "string",
      "maxLength": 5000,
      "description": "The user agent of the browser from which the account representative accepted the service agreement."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_tos_acceptance

{
  "type": "object",
  "title": "AccountTOSAcceptance",
  "properties": {
    "ip": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The IP address from which the account representative accepted their service agreement"
    },
    "date": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The Unix timestamp marking when the account representative accepted their service agreement"
    },
    "user_agent": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The user agent of the browser from which the account representative accepted their service agreement"
    },
    "service_agreement": {
      "type": "string",
      "maxLength": 5000,
      "description": "The user's service agreement type"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_treasury_settings

{
  "type": "object",
  "title": "AccountTreasurySettings",
  "properties": {
    "tos_acceptance": {
      "$ref": "#/components/schemas/account_terms_of_service"
    }
  },
  "description": "",
  "x-expandableFields": [
    "tos_acceptance"
  ]
}

object account_unification_account_controller

{
  "type": "object",
  "title": "AccountUnificationAccountController",
  "required": [
    "type"
  ],
  "properties": {
    "fees": {
      "$ref": "#/components/schemas/account_unification_account_controller_fees"
    },
    "type": {
      "enum": [
        "account",
        "application"
      ],
      "type": "string",
      "description": "The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself."
    },
    "losses": {
      "$ref": "#/components/schemas/account_unification_account_controller_losses"
    },
    "is_controller": {
      "type": "boolean",
      "description": "`true` if the Connect application retrieving the resource controls the account and can therefore exercise [platform controls](https://docs.stripe.com/connect/platform-controls-for-standard-accounts). Otherwise, this field is null."
    },
    "stripe_dashboard": {
      "$ref": "#/components/schemas/account_unification_account_controller_stripe_dashboard"
    },
    "requirement_collection": {
      "enum": [
        "application",
        "stripe"
      ],
      "type": "string",
      "description": "A value indicating responsibility for collecting requirements on this account. Only returned when the Connect application retrieving the resource controls the account."
    }
  },
  "description": "",
  "x-expandableFields": [
    "fees",
    "losses",
    "stripe_dashboard"
  ]
}

object account_unification_account_controller_fees

{
  "type": "object",
  "title": "AccountUnificationAccountControllerFees",
  "required": [
    "payer"
  ],
  "properties": {
    "payer": {
      "enum": [
        "account",
        "application",
        "application_custom",
        "application_express"
      ],
      "type": "string",
      "description": "A value indicating the responsible payer of a bundle of Stripe fees for pricing-control eligible products on this account. Learn more about [fee behavior on connected accounts](https://docs.stripe.com/connect/direct-charges-fee-payer-behavior).",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_unification_account_controller_losses

{
  "type": "object",
  "title": "AccountUnificationAccountControllerLosses",
  "required": [
    "payments"
  ],
  "properties": {
    "payments": {
      "enum": [
        "application",
        "stripe"
      ],
      "type": "string",
      "description": "A value indicating who is liable when this account can't pay back negative balances from payments."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object account_unification_account_controller_stripe_dashboard

{
  "type": "object",
  "title": "AccountUnificationAccountControllerStripeDashboard",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "express",
        "full",
        "none"
      ],
      "type": "string",
      "description": "A value indicating the Stripe dashboard this account has access to independent of the Connect application."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object address

{
  "type": "object",
  "title": "Address",
  "properties": {
    "city": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "City, district, suburb, town, or village."
    },
    "line1": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Address line 1, such as the street, PO Box, or company name."
    },
    "line2": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Address line 2, such as the apartment, suite, unit, or building."
    },
    "state": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."
    },
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."
    },
    "postal_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ZIP or postal code."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object alma_installments

{
  "type": "object",
  "title": "alma_installments",
  "required": [
    "count"
  ],
  "properties": {
    "count": {
      "type": "integer",
      "description": "The number of installments."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object amazon_pay_underlying_payment_method_funding_details

{
  "type": "object",
  "title": "amazon_pay_underlying_payment_method_funding_details",
  "properties": {
    "card": {
      "$ref": "#/components/schemas/payment_method_details_passthrough_card"
    },
    "type": {
      "enum": [
        "card"
      ],
      "type": "string",
      "nullable": true,
      "description": "funding type of the underlying payment method."
    }
  },
  "description": "",
  "x-expandableFields": [
    "card"
  ]
}

object api_errors

{
  "type": "object",
  "title": "APIErrors",
  "required": [
    "type"
  ],
  "properties": {
    "code": {
      "type": "string",
      "maxLength": 5000,
      "description": "For some errors that could be handled programmatically, a short string indicating the [error code](https://docs.stripe.com/error-codes) reported."
    },
    "type": {
      "enum": [
        "api_error",
        "card_error",
        "idempotency_error",
        "invalid_request_error"
      ],
      "type": "string",
      "description": "The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`"
    },
    "param": {
      "type": "string",
      "maxLength": 5000,
      "description": "If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field."
    },
    "charge": {
      "type": "string",
      "maxLength": 5000,
      "description": "For card errors, the ID of the failed charge."
    },
    "source": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/bank_account"
        },
        {
          "$ref": "#/components/schemas/card"
        },
        {
          "$ref": "#/components/schemas/source"
        }
      ],
      "description": "The [source object](https://docs.stripe.com/api/sources/object) for errors returned on a request involving a source.",
      "x-stripeBypassValidation": true
    },
    "doc_url": {
      "type": "string",
      "maxLength": 5000,
      "description": "A URL to more information about the [error code](https://docs.stripe.com/error-codes) reported."
    },
    "message": {
      "type": "string",
      "maxLength": 40000,
      "description": "A human-readable message providing more details about the error. For card errors, these messages can be shown to your users."
    },
    "advice_code": {
      "type": "string",
      "maxLength": 5000,
      "description": "For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://docs.stripe.com/declines#retrying-issuer-declines) if they provide one."
    },
    "decline_code": {
      "type": "string",
      "maxLength": 5000,
      "description": "For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://docs.stripe.com/declines#issuer-declines) if they provide one."
    },
    "setup_intent": {
      "$ref": "#/components/schemas/setup_intent"
    },
    "payment_intent": {
      "$ref": "#/components/schemas/payment_intent"
    },
    "payment_method": {
      "$ref": "#/components/schemas/payment_method"
    },
    "request_log_url": {
      "type": "string",
      "maxLength": 5000,
      "description": "A URL to the request log entry in your dashboard."
    },
    "network_advice_code": {
      "type": "string",
      "maxLength": 5000,
      "description": "For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error."
    },
    "payment_method_type": {
      "type": "string",
      "maxLength": 5000,
      "description": "If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors."
    },
    "network_decline_code": {
      "type": "string",
      "maxLength": 5000,
      "description": "For payments declined by the network, an alphanumeric code which indicates the reason the payment failed."
    }
  },
  "description": "",
  "x-expandableFields": [
    "payment_intent",
    "payment_method",
    "setup_intent",
    "source"
  ]
}

object apple_pay_domain

{
  "type": "object",
  "title": "ApplePayDomain",
  "required": [
    "created",
    "domain_name",
    "id",
    "livemode",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "apple_pay_domain"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "domain_name": {
      "type": "string",
      "maxLength": 5000
    }
  },
  "description": "",
  "x-resourceId": "apple_pay_domain",
  "x-expandableFields": []
}

object application

{
  "type": "object",
  "title": "Application",
  "required": [
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The name of the application."
    },
    "object": {
      "enum": [
        "application"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object application_fee

{
  "type": "object",
  "title": "PlatformFee",
  "required": [
    "account",
    "amount",
    "amount_refunded",
    "application",
    "charge",
    "created",
    "currency",
    "id",
    "livemode",
    "object",
    "refunded",
    "refunds"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "amount": {
      "type": "integer",
      "description": "Amount earned, in cents (or local equivalent)."
    },
    "charge": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/charge"
        }
      ],
      "description": "ID of the charge that the application fee was taken from.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/charge"
          }
        ]
      }
    },
    "object": {
      "enum": [
        "application_fee"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "account": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/account"
        }
      ],
      "description": "ID of the Stripe account this fee was taken from.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/account"
          }
        ]
      }
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "refunds": {
      "type": "object",
      "title": "FeeRefundList",
      "required": [
        "data",
        "has_more",
        "object",
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "maxLength": 5000,
          "description": "The URL where this list can be accessed."
        },
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/fee_refund"
          },
          "description": "Details about each object."
        },
        "object": {
          "enum": [
            "list"
          ],
          "type": "string",
          "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
        },
        "has_more": {
          "type": "boolean",
          "description": "True if this list has another page of items after this one that can be fetched."
        }
      },
      "description": "A list of refunds that have been applied to the fee.",
      "x-expandableFields": [
        "data"
      ]
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "refunded": {
      "type": "boolean",
      "description": "Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false."
    },
    "fee_source": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/platform_earning_fee_source"
        }
      ],
      "nullable": true,
      "description": "Polymorphic source of the application fee. Includes the ID of the object the application fee was created from."
    },
    "application": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/application"
        }
      ],
      "description": "ID of the Connect application that earned the fee.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/application"
          }
        ]
      }
    },
    "amount_refunded": {
      "type": "integer",
      "description": "Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the fee if a partial refund was issued)"
    },
    "balance_transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/balance_transaction"
        }
      ],
      "nullable": true,
      "description": "Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds).",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/balance_transaction"
          }
        ]
      }
    },
    "originating_transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/charge"
        }
      ],
      "nullable": true,
      "description": "ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/charge"
          }
        ]
      }
    }
  },
  "description": "",
  "x-resourceId": "application_fee",
  "x-expandableFields": [
    "account",
    "application",
    "balance_transaction",
    "charge",
    "fee_source",
    "originating_transaction",
    "refunds"
  ]
}

object apps.secret

{
  "type": "object",
  "title": "SecretServiceResourceSecret",
  "required": [
    "created",
    "id",
    "livemode",
    "name",
    "object",
    "scope"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "name": {
      "type": "string",
      "maxLength": 5000,
      "description": "A name for the secret that's unique within the scope."
    },
    "scope": {
      "$ref": "#/components/schemas/secret_service_resource_scope"
    },
    "object": {
      "enum": [
        "apps.secret"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "deleted": {
      "type": "boolean",
      "description": "If true, indicates that this secret has been deleted"
    },
    "payload": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The plaintext secret value to be stored."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "expires_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The Unix timestamp for the expiry time of the secret, after which the secret deletes."
    }
  },
  "description": "Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends.\n\nThe primary resource in Secret Store is a `secret`. Other apps can't view secrets created by an app. Additionally, secrets are scoped to provide further permission control.\n\nAll Dashboard users and the app backend share `account` scoped secrets. Use the `account` scope for secrets that don't change per-user, like a third-party API key.\n\nA `user` scoped secret is accessible by the app backend and one specific Dashboard user. Use the `user` scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions.\n\nRelated guide: [Store data between page reloads](https://docs.stripe.com/stripe-apps/store-auth-data-custom-objects)",
  "x-resourceId": "apps.secret",
  "x-expandableFields": [
    "scope"
  ]
}

object automatic_tax

{
  "type": "object",
  "title": "AutomaticTax",
  "required": [
    "enabled"
  ],
  "properties": {
    "status": {
      "enum": [
        "complete",
        "failed",
        "requires_location_inputs"
      ],
      "type": "string",
      "nullable": true,
      "description": "The status of the most recent automated tax calculation for this invoice."
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://docs.stripe.com/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices."
    },
    "provider": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The tax provider powering automatic tax."
    },
    "liability": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/connect_account_reference"
        }
      ],
      "nullable": true,
      "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account."
    },
    "disabled_reason": {
      "enum": [
        "finalization_requires_location_inputs",
        "finalization_system_error"
      ],
      "type": "string",
      "nullable": true,
      "description": "If Stripe disabled automatic tax, this enum describes why."
    }
  },
  "description": "",
  "x-expandableFields": [
    "liability"
  ]
}

object balance

{
  "type": "object",
  "title": "Balance",
  "required": [
    "available",
    "livemode",
    "object",
    "pending"
  ],
  "properties": {
    "object": {
      "enum": [
        "balance"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "issuing": {
      "$ref": "#/components/schemas/balance_detail"
    },
    "pending": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/balance_amount"
      },
      "description": "Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the `source_types` property."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "available": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/balance_amount"
      },
      "description": "Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://api.stripe.com#transfers) or [Payouts API](https://api.stripe.com#payouts). You can find the available balance for each currency and payment type in the `source_types` property."
    },
    "connect_reserved": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/balance_amount"
      },
      "description": "Funds held due to negative balances on connected accounts where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property."
    },
    "instant_available": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/balance_amount_net"
      },
      "description": "Funds that you can pay out using Instant Payouts."
    },
    "refund_and_dispute_prefunding": {
      "$ref": "#/components/schemas/balance_detail_ungated"
    }
  },
  "description": "This is an object representing your Stripe balance. You can retrieve it to see\nthe balance currently on your Stripe account.\n\nThe top-level `available` and `pending` comprise your \"payments balance.\"\n\nRelated guide: [Balances and settlement time](https://docs.stripe.com/payments/balances), [Understanding Connect account balances](https://docs.stripe.com/connect/account-balances)",
  "x-resourceId": "balance",
  "x-expandableFields": [
    "available",
    "connect_reserved",
    "instant_available",
    "issuing",
    "pending",
    "refund_and_dispute_prefunding"
  ]
}

object balance_amount

{
  "type": "object",
  "title": "BalanceAmount",
  "required": [
    "amount",
    "currency"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "Balance amount."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "source_types": {
      "$ref": "#/components/schemas/balance_amount_by_source_type"
    }
  },
  "description": "",
  "x-expandableFields": [
    "source_types"
  ]
}

object balance_amount_by_source_type

{
  "type": "object",
  "title": "BalanceAmountBySourceType",
  "properties": {
    "fpx": {
      "type": "integer",
      "description": "Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method."
    },
    "card": {
      "type": "integer",
      "description": "Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits)."
    },
    "bank_account": {
      "type": "integer",
      "description": "Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object balance_amount_net

{
  "type": "object",
  "title": "BalanceAmountNet",
  "required": [
    "amount",
    "currency"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "Balance amount."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "source_types": {
      "$ref": "#/components/schemas/balance_amount_by_source_type"
    },
    "net_available": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/balance_net_available"
      },
      "description": "Breakdown of balance by destination."
    }
  },
  "description": "",
  "x-expandableFields": [
    "net_available",
    "source_types"
  ]
}

object balance_detail

{
  "type": "object",
  "title": "BalanceDetail",
  "required": [
    "available"
  ],
  "properties": {
    "available": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/balance_amount"
      },
      "description": "Funds that are available for use."
    }
  },
  "description": "",
  "x-expandableFields": [
    "available"
  ]
}

object balance_detail_ungated

{
  "type": "object",
  "title": "BalanceDetailUngated",
  "required": [
    "available",
    "pending"
  ],
  "properties": {
    "pending": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/balance_amount"
      },
      "description": "Funds that are pending"
    },
    "available": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/balance_amount"
      },
      "description": "Funds that are available for use."
    }
  },
  "description": "",
  "x-expandableFields": [
    "available",
    "pending"
  ]
}

object balance_net_available

{
  "type": "object",
  "title": "BalanceNetAvailable",
  "required": [
    "amount",
    "destination"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "Net balance amount, subtracting fees from platform-set pricing."
    },
    "destination": {
      "type": "string",
      "maxLength": 5000,
      "description": "ID of the external account for this net balance (not expandable)."
    },
    "source_types": {
      "$ref": "#/components/schemas/balance_amount_by_source_type"
    }
  },
  "description": "",
  "x-expandableFields": [
    "source_types"
  ]
}

object balance_settings

{
  "type": "object",
  "title": "BalanceSettingsResourceBalanceSettings",
  "required": [
    "object",
    "payments"
  ],
  "properties": {
    "object": {
      "enum": [
        "balance_settings"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "payments": {
      "$ref": "#/components/schemas/balance_settings_resource_payments"
    }
  },
  "description": "Options for customizing account balances and payout settings for a Stripe platform’s connected accounts.",
  "x-resourceId": "balance_settings",
  "x-expandableFields": [
    "payments"
  ]
}

object balance_settings_resource_payments

{
  "type": "object",
  "title": "BalanceSettingsResourcePayments",
  "required": [
    "settlement_timing"
  ],
  "properties": {
    "payouts": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/balance_settings_resource_payouts"
        }
      ],
      "nullable": true,
      "description": "Settings specific to the account's payouts."
    },
    "settlement_timing": {
      "$ref": "#/components/schemas/balance_settings_resource_settlement_timing"
    },
    "debit_negative_balances": {
      "type": "boolean",
      "nullable": true,
      "description": "A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See [Understanding Connect account balances](/connect/account-balances) for details. The default value is `false` when [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, otherwise `true`."
    }
  },
  "description": "",
  "x-expandableFields": [
    "payouts",
    "settlement_timing"
  ]
}

object balance_settings_resource_payout_schedule

{
  "type": "object",
  "title": "BalanceSettingsResourcePayoutSchedule",
  "properties": {
    "interval": {
      "enum": [
        "daily",
        "manual",
        "monthly",
        "weekly"
      ],
      "type": "string",
      "nullable": true,
      "description": "How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`."
    },
    "weekly_payout_days": {
      "type": "array",
      "items": {
        "enum": [
          "friday",
          "monday",
          "thursday",
          "tuesday",
          "wednesday"
        ],
        "type": "string",
        "x-stripeBypassValidation": true
      },
      "description": "The days of the week when available funds are paid out, specified as an array, for example, [`monday`, `tuesday`]. Only shown if `interval` is weekly."
    },
    "monthly_payout_days": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "The day of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object balance_settings_resource_payouts

{
  "type": "object",
  "title": "BalanceSettingsResourcePayouts",
  "required": [
    "status"
  ],
  "properties": {
    "status": {
      "enum": [
        "disabled",
        "enabled"
      ],
      "type": "string",
      "description": "Whether the funds in this account can be paid out."
    },
    "schedule": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/balance_settings_resource_payout_schedule"
        }
      ],
      "nullable": true,
      "description": "Details on when funds from charges are available, and when they are paid out to an external account. See our [Setting Bank and Debit Card Payouts](https://docs.stripe.com/connect/bank-transfers#payout-information) documentation for details."
    },
    "statement_descriptor": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard."
    },
    "minimum_balance_by_currency": {
      "type": "object",
      "nullable": true,
      "description": "The minimum balance amount to retain per currency after automatic payouts. Only funds that exceed these amounts are paid out. Learn more about the [minimum balances for automatic payouts](/payouts/minimum-balances-for-automatic-payouts).",
      "additionalProperties": {
        "type": "integer"
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "schedule"
  ]
}

object balance_settings_resource_settlement_timing

{
  "type": "object",
  "title": "BalanceSettingsResourceSettlementTiming",
  "required": [
    "delay_days"
  ],
  "properties": {
    "delay_days": {
      "type": "integer",
      "description": "The number of days charge funds are held before becoming available."
    },
    "delay_days_override": {
      "type": "integer",
      "description": "The number of days charge funds are held before becoming available. If present, overrides the default, or minimum available, for the account."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object balance_transaction

{
  "type": "object",
  "title": "BalanceTransaction",
  "required": [
    "amount",
    "available_on",
    "balance_type",
    "created",
    "currency",
    "fee",
    "fee_details",
    "id",
    "net",
    "object",
    "reporting_category",
    "status",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "fee": {
      "type": "integer",
      "description": "Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed."
    },
    "net": {
      "type": "integer",
      "description": "Net impact to a Stripe balance (in cents (or local equivalent)). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by `amount` - `fee`"
    },
    "type": {
      "enum": [
        "adjustment",
        "advance",
        "advance_funding",
        "anticipation_repayment",
        "application_fee",
        "application_fee_refund",
        "charge",
        "climate_order_purchase",
        "climate_order_refund",
        "connect_collection_transfer",
        "contribution",
        "issuing_authorization_hold",
        "issuing_authorization_release",
        "issuing_dispute",
        "issuing_transaction",
        "obligation_outbound",
        "obligation_reversal_inbound",
        "payment",
        "payment_failure_refund",
        "payment_network_reserve_hold",
        "payment_network_reserve_release",
        "payment_refund",
        "payment_reversal",
        "payment_unreconciled",
        "payout",
        "payout_cancel",
        "payout_failure",
        "payout_minimum_balance_hold",
        "payout_minimum_balance_release",
        "refund",
        "refund_failure",
        "reserve_hold",
        "reserve_release",
        "reserve_transaction",
        "reserved_funds",
        "stripe_balance_payment_debit",
        "stripe_balance_payment_debit_reversal",
        "stripe_fee",
        "stripe_fx_fee",
        "tax_fee",
        "topup",
        "topup_reversal",
        "transfer",
        "transfer_cancel",
        "transfer_failure",
        "transfer_refund"
      ],
      "type": "string",
      "description": "Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `reserve_hold`, `reserve_release`, `stripe_fee`, `stripe_fx_fee`, `stripe_balance_payment_debit`, `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead."
    },
    "amount": {
      "type": "integer",
      "description": "Gross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party."
    },
    "object": {
      "enum": [
        "balance_transaction"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "source": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/application_fee"
        },
        {
          "$ref": "#/components/schemas/charge"
        },
        {
          "$ref": "#/components/schemas/connect_collection_transfer"
        },
        {
          "$ref": "#/components/schemas/customer_cash_balance_transaction"
        },
        {
          "$ref": "#/components/schemas/dispute"
        },
        {
          "$ref": "#/components/schemas/fee_refund"
        },
        {
          "$ref": "#/components/schemas/issuing.authorization"
        },
        {
          "$ref": "#/components/schemas/issuing.dispute"
        },
        {
          "$ref": "#/components/schemas/issuing.transaction"
        },
        {
          "$ref": "#/components/schemas/payout"
        },
        {
          "$ref": "#/components/schemas/refund"
        },
        {
          "$ref": "#/components/schemas/reserve_transaction"
        },
        {
          "$ref": "#/components/schemas/tax_deducted_at_source"
        },
        {
          "$ref": "#/components/schemas/topup"
        },
        {
          "$ref": "#/components/schemas/transfer"
        },
        {
          "$ref": "#/components/schemas/transfer_reversal"
        }
      ],
      "nullable": true,
      "description": "This transaction relates to the Stripe object.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/application_fee"
          },
          {
            "$ref": "#/components/schemas/charge"
          },
          {
            "$ref": "#/components/schemas/connect_collection_transfer"
          },
          {
            "$ref": "#/components/schemas/customer_cash_balance_transaction"
          },
          {
            "$ref": "#/components/schemas/dispute"
          },
          {
            "$ref": "#/components/schemas/fee_refund"
          },
          {
            "$ref": "#/components/schemas/issuing.authorization"
          },
          {
            "$ref": "#/components/schemas/issuing.dispute"
          },
          {
            "$ref": "#/components/schemas/issuing.transaction"
          },
          {
            "$ref": "#/components/schemas/payout"
          },
          {
            "$ref": "#/components/schemas/refund"
          },
          {
            "$ref": "#/components/schemas/reserve_transaction"
          },
          {
            "$ref": "#/components/schemas/tax_deducted_at_source"
          },
          {
            "$ref": "#/components/schemas/topup"
          },
          {
            "$ref": "#/components/schemas/transfer"
          },
          {
            "$ref": "#/components/schemas/transfer_reversal"
          }
        ]
      },
      "x-stripeBypassValidation": true
    },
    "status": {
      "type": "string",
      "maxLength": 5000,
      "description": "The transaction's net funds status in the Stripe balance, which are either `available` or `pending`."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An arbitrary string attached to the object. Often useful for displaying to users."
    },
    "fee_details": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/fee"
      },
      "description": "Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction."
    },
    "available_on": {
      "type": "integer",
      "format": "unix-time",
      "description": "The date that the transaction's net funds become available in the Stripe balance."
    },
    "balance_type": {
      "enum": [
        "issuing",
        "payments",
        "refund_and_dispute_prefunding",
        "risk_reserved"
      ],
      "type": "string",
      "description": "The balance that this transaction impacts.",
      "x-stripeBypassValidation": true
    },
    "exchange_rate": {
      "type": "number",
      "nullable": true,
      "description": "If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the `amount` in currency A, multipled by the `exchange_rate`, equals the `amount` in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's `amount` is `1000` and `currency` is `eur`. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's `amount` is `1234`, its `currency` is `usd`, and the `exchange_rate` is `1.234`."
    },
    "reporting_category": {
      "type": "string",
      "maxLength": 5000,
      "description": "Learn more about how [reporting categories](https://stripe.com/docs/reports/reporting-categories) can help you understand balance transactions from an accounting perspective."
    }
  },
  "description": "Balance transactions represent funds moving through your Stripe account.\nStripe creates them for every type of transaction that enters or leaves your Stripe account balance.\n\nRelated guide: [Balance transaction types](https://docs.stripe.com/reports/balance-transaction-types)",
  "x-resourceId": "balance_transaction",
  "x-expandableFields": [
    "fee_details",
    "source"
  ]
}

object bank_account

{
  "type": "object",
  "title": "BankAccount",
  "required": [
    "country",
    "currency",
    "id",
    "last4",
    "object",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "last4": {
      "type": "string",
      "maxLength": 5000,
      "description": "The last four digits of the bank account number."
    },
    "object": {
      "enum": [
        "bank_account"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "type": "string",
      "maxLength": 5000,
      "description": "For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, `tokenized_account_number_deactivated` or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If the status is `tokenized_account_number_deactivated`, the account utilizes a tokenized account number which has been deactivated due to expiration or revocation. This account will need to be reverified to continue using it for money movement. If a payout sent to this bank account fails, we'll set the status to `errored` and will not continue to send [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) until the bank details are updated.\n\nFor external accounts, possible values are `new`, `errored`, `verification_failed`, and `tokenized_account_number_deactivated`. If a payout fails, the status is set to `errored` and scheduled payouts are stopped until account details are updated. In the US and India, if we can't [verify the owner of the bank account](https://support.stripe.com/questions/bank-account-ownership-verification), we'll set the status to `verification_failed`. Other validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply."
    },
    "account": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/account"
        }
      ],
      "nullable": true,
      "description": "The account this bank account belongs to. Only applicable on Accounts (not customers or recipients) This property is only available when returned as an [External Account](/api/external_account_bank_accounts/object) where [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) is `true`.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/account"
          }
        ]
      }
    },
    "country": {
      "type": "string",
      "maxLength": 5000,
      "description": "Two-letter ISO code representing the country the bank account is located in."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account."
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        },
        {
          "$ref": "#/components/schemas/deleted_customer"
        }
      ],
      "nullable": true,
      "description": "The ID of the customer that the bank account is associated with.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          },
          {
            "$ref": "#/components/schemas/deleted_customer"
          }
        ]
      }
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "bank_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Name of the bank associated with the routing number (e.g., `WELLS FARGO`)."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."
    },
    "account_type": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`."
    },
    "requirements": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/external_account_requirements"
        }
      ],
      "nullable": true,
      "description": "Information about the requirements for the bank account, including what information needs to be collected."
    },
    "routing_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The routing transit number for the bank account."
    },
    "account_holder_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The name of the person or business that owns the bank account."
    },
    "account_holder_type": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The type of entity that holds the account. This can be either `individual` or `company`."
    },
    "future_requirements": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/external_account_requirements"
        }
      ],
      "nullable": true,
      "description": "Information about the [upcoming new requirements for the bank account](https://docs.stripe.com/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when."
    },
    "default_for_currency": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether this bank account is the default external account for its currency."
    },
    "available_payout_methods": {
      "type": "array",
      "items": {
        "enum": [
          "instant",
          "standard"
        ],
        "type": "string"
      },
      "nullable": true,
      "description": "A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout."
    }
  },
  "description": "These bank accounts are payment methods on `Customer` objects.\n\nOn the other hand [External Accounts](/api#external_accounts) are transfer\ndestinations on `Account` objects for connected accounts.\nThey can be bank accounts or debit cards as well, and are documented in the links above.\n\nRelated guide: [Bank debits and transfers](/payments/bank-debits-transfers)",
  "x-resourceId": "bank_account",
  "x-expandableFields": [
    "account",
    "customer",
    "future_requirements",
    "requirements"
  ]
}

object bank_connections_resource_account_number_details

{
  "type": "object",
  "title": "BankConnectionsResourceAccountNumberDetails",
  "required": [
    "identifier_type",
    "status",
    "supported_networks"
  ],
  "properties": {
    "status": {
      "enum": [
        "deactivated",
        "transactable"
      ],
      "type": "string",
      "description": "Whether the account number is currently active and usable for transactions."
    },
    "identifier_type": {
      "enum": [
        "account_number",
        "tokenized_account_number"
      ],
      "type": "string",
      "description": "The type of account number associated with the account."
    },
    "supported_networks": {
      "type": "array",
      "items": {
        "enum": [
          "ach"
        ],
        "type": "string",
        "x-stripeBypassValidation": true
      },
      "description": "The payment networks that the account number can be used for."
    },
    "expected_expiry_date": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "When the account number is expected to expire, if applicable."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object bank_connections_resource_accountholder

{
  "type": "object",
  "title": "BankConnectionsResourceAccountholder",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "account",
        "customer"
      ],
      "type": "string",
      "description": "Type of account holder that this account belongs to."
    },
    "account": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/account"
        }
      ],
      "description": "The ID of the Stripe account that this account belongs to. Only available when `account_holder.type` is `account`.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/account"
          }
        ]
      }
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        }
      ],
      "description": "The ID for an Account representing a customer that this account belongs to. Only available when `account_holder.type` is `customer`.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          }
        ]
      }
    },
    "customer_account": {
      "type": "string",
      "maxLength": 5000
    }
  },
  "description": "",
  "x-expandableFields": [
    "account",
    "customer"
  ]
}

object bank_connections_resource_balance

{
  "type": "object",
  "title": "BankConnectionsResourceBalance",
  "required": [
    "as_of",
    "current",
    "type"
  ],
  "properties": {
    "cash": {
      "$ref": "#/components/schemas/bank_connections_resource_balance_api_resource_cash_balance"
    },
    "type": {
      "enum": [
        "cash",
        "credit"
      ],
      "type": "string",
      "description": "The `type` of the balance. An additional hash is included on the balance with a name matching this value."
    },
    "as_of": {
      "type": "integer",
      "format": "unix-time",
      "description": "The time that the external institution calculated this balance. Measured in seconds since the Unix epoch."
    },
    "credit": {
      "$ref": "#/components/schemas/bank_connections_resource_balance_api_resource_credit_balance"
    },
    "current": {
      "type": "object",
      "description": "The balances owed to (or by) the account holder, before subtracting any outbound pending transactions or adding any inbound pending transactions.\n\nEach key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.\n\nEach value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.",
      "additionalProperties": {
        "type": "integer"
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "cash",
    "credit"
  ]
}

object bank_connections_resource_balance_api_resource_cash_balance

{
  "type": "object",
  "title": "BankConnectionsResourceBalanceAPIResourceCashBalance",
  "properties": {
    "available": {
      "type": "object",
      "nullable": true,
      "description": "The funds available to the account holder. Typically this is the current balance after subtracting any outbound pending transactions and adding any inbound pending transactions.\n\nEach key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.\n\nEach value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.",
      "additionalProperties": {
        "type": "integer"
      }
    }
  },
  "description": "",
  "x-expandableFields": []
}

object bank_connections_resource_balance_api_resource_credit_balance

{
  "type": "object",
  "title": "BankConnectionsResourceBalanceAPIResourceCreditBalance",
  "properties": {
    "used": {
      "type": "object",
      "nullable": true,
      "description": "The credit that has been used by the account holder.\n\nEach key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.\n\nEach value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.",
      "additionalProperties": {
        "type": "integer"
      }
    }
  },
  "description": "",
  "x-expandableFields": []
}

object bank_connections_resource_balance_refresh

{
  "type": "object",
  "title": "BankConnectionsResourceBalanceRefresh",
  "required": [
    "last_attempted_at",
    "status"
  ],
  "properties": {
    "status": {
      "enum": [
        "failed",
        "pending",
        "succeeded"
      ],
      "type": "string",
      "description": "The status of the last refresh attempt."
    },
    "last_attempted_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch."
    },
    "next_refresh_available_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Time at which the next balance refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object bank_connections_resource_link_account_session_filters

{
  "type": "object",
  "title": "BankConnectionsResourceLinkAccountSessionFilters",
  "properties": {
    "countries": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "List of countries from which to filter accounts."
    },
    "account_subcategories": {
      "type": "array",
      "items": {
        "enum": [
          "checking",
          "credit_card",
          "line_of_credit",
          "mortgage",
          "savings"
        ],
        "type": "string"
      },
      "nullable": true,
      "description": "Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object bank_connections_resource_ownership_refresh

{
  "type": "object",
  "title": "BankConnectionsResourceOwnershipRefresh",
  "required": [
    "last_attempted_at",
    "status"
  ],
  "properties": {
    "status": {
      "enum": [
        "failed",
        "pending",
        "succeeded"
      ],
      "type": "string",
      "description": "The status of the last refresh attempt."
    },
    "last_attempted_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch."
    },
    "next_refresh_available_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Time at which the next ownership refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object bank_connections_resource_transaction_refresh

{
  "type": "object",
  "title": "BankConnectionsResourceTransactionRefresh",
  "required": [
    "id",
    "last_attempted_at",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "status": {
      "enum": [
        "failed",
        "pending",
        "succeeded"
      ],
      "type": "string",
      "description": "The status of the last refresh attempt."
    },
    "last_attempted_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch."
    },
    "next_refresh_available_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Time at which the next transaction refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object bank_connections_resource_transaction_resource_status_transitions

{
  "type": "object",
  "title": "BankConnectionsResourceTransactionResourceStatusTransitions",
  "properties": {
    "void_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Time at which this transaction was voided. Measured in seconds since the Unix epoch."
    },
    "posted_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Time at which this transaction posted. Measured in seconds since the Unix epoch."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object billing.alert

{
  "type": "object",
  "title": "ThresholdsResourceAlert",
  "required": [
    "alert_type",
    "id",
    "livemode",
    "object",
    "title"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "title": {
      "type": "string",
      "maxLength": 5000,
      "description": "Title of the alert."
    },
    "object": {
      "enum": [
        "billing.alert"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "active",
        "archived",
        "inactive"
      ],
      "type": "string",
      "nullable": true,
      "description": "Status of the alert. This can be active, inactive or archived."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "alert_type": {
      "enum": [
        "usage_threshold"
      ],
      "type": "string",
      "description": "Defines the type of the alert.",
      "x-stripeBypassValidation": true
    },
    "usage_threshold": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/thresholds_resource_usage_threshold_config"
        }
      ],
      "nullable": true,
      "description": "Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://docs.stripe.com/api/billing/meter)."
    }
  },
  "description": "A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.",
  "x-resourceId": "billing.alert",
  "x-expandableFields": [
    "usage_threshold"
  ]
}

object billing.credit_balance_summary

{
  "type": "object",
  "title": "CreditBalanceSummary",
  "required": [
    "balances",
    "customer",
    "livemode",
    "object"
  ],
  "properties": {
    "object": {
      "enum": [
        "billing.credit_balance_summary"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "balances": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/credit_balance"
      },
      "description": "The billing credit balances. One entry per credit grant currency. If a customer only has credit grants in a single currency, then this will have a single balance entry."
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        },
        {
          "$ref": "#/components/schemas/deleted_customer"
        }
      ],
      "description": "The customer the balance is for.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          },
          {
            "$ref": "#/components/schemas/deleted_customer"
          }
        ]
      }
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "customer_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The account the balance is for."
    }
  },
  "description": "Indicates the billing credit balance for billing credits granted to a customer.",
  "x-resourceId": "billing.credit_balance_summary",
  "x-expandableFields": [
    "balances",
    "customer"
  ]
}

object billing.credit_balance_transaction

{
  "type": "object",
  "title": "CreditBalanceTransaction",
  "required": [
    "created",
    "credit_grant",
    "effective_at",
    "id",
    "livemode",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "type": {
      "enum": [
        "credit",
        "debit"
      ],
      "type": "string",
      "nullable": true,
      "description": "The type of credit balance transaction (credit or debit)."
    },
    "debit": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_credit_grants_resource_balance_debit"
        }
      ],
      "nullable": true,
      "description": "Debit details for this credit balance transaction. Only present if type is `debit`."
    },
    "credit": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_credit_grants_resource_balance_credit"
        }
      ],
      "nullable": true,
      "description": "Credit details for this credit balance transaction. Only present if type is `credit`."
    },
    "object": {
      "enum": [
        "billing.credit_balance_transaction"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "test_clock": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/test_helpers.test_clock"
        }
      ],
      "nullable": true,
      "description": "ID of the test clock this credit balance transaction belongs to.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/test_helpers.test_clock"
          }
        ]
      }
    },
    "credit_grant": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/billing.credit_grant"
        }
      ],
      "description": "The credit grant associated with this credit balance transaction.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/billing.credit_grant"
          }
        ]
      }
    },
    "effective_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "The effective time of this credit balance transaction."
    }
  },
  "description": "A credit balance transaction is a resource representing a transaction (either a credit or a debit) against an existing credit grant.",
  "x-resourceId": "billing.credit_balance_transaction",
  "x-expandableFields": [
    "credit",
    "credit_grant",
    "debit",
    "test_clock"
  ]
}

object billing.credit_grant

{
  "type": "object",
  "title": "CreditGrant",
  "required": [
    "amount",
    "applicability_config",
    "category",
    "created",
    "customer",
    "id",
    "livemode",
    "metadata",
    "object",
    "updated"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A descriptive name shown in dashboard."
    },
    "amount": {
      "$ref": "#/components/schemas/billing_credit_grants_resource_amount"
    },
    "object": {
      "enum": [
        "billing.credit_grant"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "updated": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch."
    },
    "category": {
      "enum": [
        "paid",
        "promotional"
      ],
      "type": "string",
      "description": "The category of this credit grant. This is for tracking purposes and isn't displayed to the customer."
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        },
        {
          "$ref": "#/components/schemas/deleted_customer"
        }
      ],
      "description": "ID of the customer receiving the billing credits.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          },
          {
            "$ref": "#/components/schemas/deleted_customer"
          }
        ]
      }
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "priority": {
      "type": "integer",
      "nullable": true,
      "description": "The priority for applying this credit grant. The highest priority is 0 and the lowest is 100."
    },
    "voided_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The time when this credit grant was voided. If not present, the credit grant hasn't been voided."
    },
    "expires_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The time when the billing credits expire. If not present, the billing credits don't expire."
    },
    "test_clock": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/test_helpers.test_clock"
        }
      ],
      "nullable": true,
      "description": "ID of the test clock this credit grant belongs to.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/test_helpers.test_clock"
          }
        ]
      }
    },
    "effective_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The time when the billing credits become effective-when they're eligible for use."
    },
    "customer_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the account representing the customer receiving the billing credits"
    },
    "applicability_config": {
      "$ref": "#/components/schemas/billing_credit_grants_resource_applicability_config"
    }
  },
  "description": "A credit grant is an API resource that documents the allocation of some billing credits to a customer.\n\nRelated guide: [Billing credits](https://docs.stripe.com/billing/subscriptions/usage-based/billing-credits)",
  "x-resourceId": "billing.credit_grant",
  "x-expandableFields": [
    "amount",
    "applicability_config",
    "customer",
    "test_clock"
  ]
}

object billing.meter

{
  "type": "object",
  "title": "BillingMeter",
  "required": [
    "created",
    "customer_mapping",
    "default_aggregation",
    "display_name",
    "event_name",
    "id",
    "livemode",
    "object",
    "status",
    "status_transitions",
    "updated",
    "value_settings"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "billing.meter"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "active",
        "inactive"
      ],
      "type": "string",
      "description": "The meter's status."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "updated": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "event_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events."
    },
    "display_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The meter's name."
    },
    "value_settings": {
      "$ref": "#/components/schemas/billing_meter_resource_billing_meter_value"
    },
    "customer_mapping": {
      "$ref": "#/components/schemas/billing_meter_resource_customer_mapping_settings"
    },
    "event_time_window": {
      "enum": [
        "day",
        "hour"
      ],
      "type": "string",
      "nullable": true,
      "description": "The time window which meter events have been pre-aggregated for, if any."
    },
    "status_transitions": {
      "$ref": "#/components/schemas/billing_meter_resource_billing_meter_status_transitions"
    },
    "default_aggregation": {
      "$ref": "#/components/schemas/billing_meter_resource_aggregation_settings"
    }
  },
  "description": "Meters specify how to aggregate meter events over a billing period. Meter events represent the actions that customers take in your system. Meters attach to prices and form the basis of the bill.\n\nRelated guide: [Usage based billing](https://docs.stripe.com/billing/subscriptions/usage-based)",
  "x-resourceId": "billing.meter",
  "x-expandableFields": [
    "customer_mapping",
    "default_aggregation",
    "status_transitions",
    "value_settings"
  ]
}

object billing.meter_event

{
  "type": "object",
  "title": "BillingMeterEvent",
  "required": [
    "created",
    "event_name",
    "identifier",
    "livemode",
    "object",
    "payload",
    "timestamp"
  ],
  "properties": {
    "object": {
      "enum": [
        "billing.meter_event"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "payload": {
      "type": "object",
      "description": "The payload of the event. This contains the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://docs.stripe.com/billing/subscriptions/usage-based/meters/configure#meter-configuration-attributes).",
      "additionalProperties": {
        "type": "string",
        "maxLength": 100
      }
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "timestamp": {
      "type": "integer",
      "format": "unix-time",
      "description": "The timestamp passed in when creating the event. Measured in seconds since the Unix epoch."
    },
    "event_name": {
      "type": "string",
      "maxLength": 100,
      "description": "The name of the meter event. Corresponds with the `event_name` field on a meter."
    },
    "identifier": {
      "type": "string",
      "maxLength": 5000,
      "description": "A unique identifier for the event."
    }
  },
  "description": "Meter events represent actions that customers take in your system. You can use meter events to bill a customer based on their usage. Meter events are associated with billing meters, which define both the contents of the event’s payload and how to aggregate those events.",
  "x-resourceId": "billing.meter_event",
  "x-expandableFields": []
}

object billing.meter_event_adjustment

{
  "type": "object",
  "title": "BillingMeterEventAdjustment",
  "required": [
    "event_name",
    "livemode",
    "object",
    "status",
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "cancel"
      ],
      "type": "string",
      "description": "Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet."
    },
    "cancel": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_meter_resource_billing_meter_event_adjustment_cancel"
        }
      ],
      "nullable": true,
      "description": "Specifies which event to cancel."
    },
    "object": {
      "enum": [
        "billing.meter_event_adjustment"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "complete",
        "pending"
      ],
      "type": "string",
      "description": "The meter event adjustment's status."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "event_name": {
      "type": "string",
      "maxLength": 100,
      "description": "The name of the meter event. Corresponds with the `event_name` field on a meter."
    }
  },
  "description": "A billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer.",
  "x-resourceId": "billing.meter_event_adjustment",
  "x-expandableFields": [
    "cancel"
  ]
}

object billing.meter_event_summary

{
  "type": "object",
  "title": "BillingMeterEventSummary",
  "required": [
    "aggregated_value",
    "end_time",
    "id",
    "livemode",
    "meter",
    "object",
    "start_time"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "meter": {
      "type": "string",
      "maxLength": 5000,
      "description": "The meter associated with this event summary."
    },
    "object": {
      "enum": [
        "billing.meter_event_summary"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "end_time": {
      "type": "integer",
      "format": "unix-time",
      "description": "End timestamp for this event summary (exclusive). Must be aligned with minute boundaries."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "start_time": {
      "type": "integer",
      "format": "unix-time",
      "description": "Start timestamp for this event summary (inclusive). Must be aligned with minute boundaries."
    },
    "aggregated_value": {
      "type": "number",
      "description": "Aggregated value of all the events within `start_time` (inclusive) and `end_time` (inclusive). The aggregation strategy is defined on meter via `default_aggregation`."
    }
  },
  "description": "A billing meter event summary represents an aggregated view of a customer's billing meter events within a specified timeframe. It indicates how much\nusage was accrued by a customer for that period.\n\nNote: Meters events are aggregated asynchronously so the meter event summaries provide an eventually consistent view of the reported usage.",
  "x-resourceId": "billing.meter_event_summary",
  "x-expandableFields": []
}

object billing_bill_resource_invoice_item_parents_invoice_item_parent

{
  "type": "object",
  "title": "BillingBillResourceInvoiceItemParentsInvoiceItemParent",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "subscription_details"
      ],
      "type": "string",
      "description": "The type of parent that generated this invoice item",
      "x-stripeBypassValidation": true
    },
    "subscription_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_bill_resource_invoice_item_parents_invoice_item_subscription_parent"
        }
      ],
      "nullable": true,
      "description": "Details about the subscription that generated this invoice item"
    }
  },
  "description": "",
  "x-expandableFields": [
    "subscription_details"
  ]
}

object billing_bill_resource_invoice_item_parents_invoice_item_subscription_parent

{
  "type": "object",
  "title": "BillingBillResourceInvoiceItemParentsInvoiceItemSubscriptionParent",
  "required": [
    "subscription"
  ],
  "properties": {
    "subscription": {
      "type": "string",
      "maxLength": 5000,
      "description": "The subscription that generated this invoice item"
    },
    "subscription_item": {
      "type": "string",
      "maxLength": 5000,
      "description": "The subscription item that generated this invoice item"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object billing_bill_resource_invoicing_lines_common_credited_items

{
  "type": "object",
  "title": "BillingBillResourceInvoicingLinesCommonCreditedItems",
  "required": [
    "invoice",
    "invoice_line_items"
  ],
  "properties": {
    "invoice": {
      "type": "string",
      "maxLength": 5000,
      "description": "Invoice containing the credited invoice line items"
    },
    "invoice_line_items": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Credited invoice line items"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object billing_bill_resource_invoicing_lines_common_proration_details

{
  "type": "object",
  "title": "BillingBillResourceInvoicingLinesCommonProrationDetails",
  "properties": {
    "credited_items": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_bill_resource_invoicing_lines_common_credited_items"
        }
      ],
      "nullable": true,
      "description": "For a credit proration `line_item`, the original debit line_items to which the credit proration applies."
    }
  },
  "description": "",
  "x-expandableFields": [
    "credited_items"
  ]
}

object billing_bill_resource_invoicing_lines_parents_invoice_line_item_invoice_item_parent

{
  "type": "object",
  "title": "BillingBillResourceInvoicingLinesParentsInvoiceLineItemInvoiceItemParent",
  "required": [
    "invoice_item",
    "proration"
  ],
  "properties": {
    "proration": {
      "type": "boolean",
      "description": "Whether this is a proration"
    },
    "invoice_item": {
      "type": "string",
      "maxLength": 5000,
      "description": "The invoice item that generated this line item"
    },
    "subscription": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The subscription that the invoice item belongs to"
    },
    "proration_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_bill_resource_invoicing_lines_common_proration_details"
        }
      ],
      "nullable": true,
      "description": "Additional details for proration line items"
    }
  },
  "description": "",
  "x-expandableFields": [
    "proration_details"
  ]
}

object billing_bill_resource_invoicing_lines_parents_invoice_line_item_parent

{
  "type": "object",
  "title": "BillingBillResourceInvoicingLinesParentsInvoiceLineItemParent",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "invoice_item_details",
        "subscription_item_details"
      ],
      "type": "string",
      "description": "The type of parent that generated this line item",
      "x-stripeBypassValidation": true
    },
    "invoice_item_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_bill_resource_invoicing_lines_parents_invoice_line_item_invoice_item_parent"
        }
      ],
      "nullable": true,
      "description": "Details about the invoice item that generated this line item"
    },
    "subscription_item_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_bill_resource_invoicing_lines_parents_invoice_line_item_subscription_item_parent"
        }
      ],
      "nullable": true,
      "description": "Details about the subscription item that generated this line item"
    }
  },
  "description": "",
  "x-expandableFields": [
    "invoice_item_details",
    "subscription_item_details"
  ]
}

object billing_bill_resource_invoicing_lines_parents_invoice_line_item_subscription_item_parent

{
  "type": "object",
  "title": "BillingBillResourceInvoicingLinesParentsInvoiceLineItemSubscriptionItemParent",
  "required": [
    "proration",
    "subscription_item"
  ],
  "properties": {
    "proration": {
      "type": "boolean",
      "description": "Whether this is a proration"
    },
    "invoice_item": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The invoice item that generated this line item"
    },
    "subscription": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The subscription that the subscription item belongs to"
    },
    "proration_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_bill_resource_invoicing_lines_common_proration_details"
        }
      ],
      "nullable": true,
      "description": "Additional details for proration line items"
    },
    "subscription_item": {
      "type": "string",
      "maxLength": 5000,
      "description": "The subscription item that generated this line item"
    }
  },
  "description": "",
  "x-expandableFields": [
    "proration_details"
  ]
}

object billing_bill_resource_invoicing_parents_invoice_parent

{
  "type": "object",
  "title": "BillingBillResourceInvoicingParentsInvoiceParent",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "quote_details",
        "subscription_details"
      ],
      "type": "string",
      "description": "The type of parent that generated this invoice",
      "x-stripeBypassValidation": true
    },
    "quote_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_bill_resource_invoicing_parents_invoice_quote_parent"
        }
      ],
      "nullable": true,
      "description": "Details about the quote that generated this invoice"
    },
    "subscription_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_bill_resource_invoicing_parents_invoice_subscription_parent"
        }
      ],
      "nullable": true,
      "description": "Details about the subscription that generated this invoice"
    }
  },
  "description": "",
  "x-expandableFields": [
    "quote_details",
    "subscription_details"
  ]
}

object billing_bill_resource_invoicing_parents_invoice_quote_parent

{
  "type": "object",
  "title": "BillingBillResourceInvoicingParentsInvoiceQuoteParent",
  "required": [
    "quote"
  ],
  "properties": {
    "quote": {
      "type": "string",
      "maxLength": 5000,
      "description": "The quote that generated this invoice"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object billing_bill_resource_invoicing_parents_invoice_subscription_parent

{
  "type": "object",
  "title": "BillingBillResourceInvoicingParentsInvoiceSubscriptionParent",
  "required": [
    "subscription"
  ],
  "properties": {
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization.\n *Note: This attribute is populated only for invoices created on or after June 29, 2023.*",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "subscription": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/subscription"
        }
      ],
      "description": "The subscription that generated this invoice",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/subscription"
          }
        ]
      }
    },
    "subscription_proration_date": {
      "type": "integer",
      "format": "unix-time",
      "description": "Only set for upcoming invoices that preview prorations. The time used to calculate prorations."
    }
  },
  "description": "",
  "x-expandableFields": [
    "subscription"
  ]
}

object billing_bill_resource_invoicing_pricing_pricing

{
  "type": "object",
  "title": "BillingBillResourceInvoicingPricingPricing",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "price_details"
      ],
      "type": "string",
      "description": "The type of the pricing details.",
      "x-stripeBypassValidation": true
    },
    "price_details": {
      "$ref": "#/components/schemas/billing_bill_resource_invoicing_pricing_pricing_price_details"
    },
    "unit_amount_decimal": {
      "type": "string",
      "format": "decimal",
      "nullable": true,
      "description": "The unit amount (in the `currency` specified) of the item which contains a decimal value with at most 12 decimal places."
    }
  },
  "description": "",
  "x-expandableFields": [
    "price_details"
  ]
}

object billing_bill_resource_invoicing_pricing_pricing_price_details

{
  "type": "object",
  "title": "BillingBillResourceInvoicingPricingPricingPriceDetails",
  "required": [
    "price",
    "product"
  ],
  "properties": {
    "price": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/price"
        }
      ],
      "description": "The ID of the price this item is associated with.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/price"
          }
        ]
      }
    },
    "product": {
      "type": "string",
      "maxLength": 5000,
      "description": "The ID of the product this item is associated with."
    }
  },
  "description": "",
  "x-expandableFields": [
    "price"
  ]
}

object billing_bill_resource_invoicing_taxes_tax

{
  "type": "object",
  "title": "BillingBillResourceInvoicingTaxesTax",
  "required": [
    "amount",
    "tax_behavior",
    "taxability_reason",
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "tax_rate_details"
      ],
      "type": "string",
      "description": "The type of tax information."
    },
    "amount": {
      "type": "integer",
      "description": "The amount of the tax, in cents (or local equivalent)."
    },
    "tax_behavior": {
      "enum": [
        "exclusive",
        "inclusive"
      ],
      "type": "string",
      "description": "Whether this tax is inclusive or exclusive."
    },
    "taxable_amount": {
      "type": "integer",
      "nullable": true,
      "description": "The amount on which tax is calculated, in cents (or local equivalent)."
    },
    "tax_rate_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_bill_resource_invoicing_taxes_tax_rate_details"
        }
      ],
      "nullable": true,
      "description": "Additional details about the tax rate. Only present when `type` is `tax_rate_details`."
    },
    "taxability_reason": {
      "enum": [
        "customer_exempt",
        "not_available",
        "not_collecting",
        "not_subject_to_tax",
        "not_supported",
        "portion_product_exempt",
        "portion_reduced_rated",
        "portion_standard_rated",
        "product_exempt",
        "product_exempt_holiday",
        "proportionally_rated",
        "reduced_rated",
        "reverse_charge",
        "standard_rated",
        "taxable_basis_reduced",
        "zero_rated"
      ],
      "type": "string",
      "description": "The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": [
    "tax_rate_details"
  ]
}

object billing_bill_resource_invoicing_taxes_tax_rate_details

{
  "type": "object",
  "title": "BillingBillResourceInvoicingTaxesTaxRateDetails",
  "required": [
    "tax_rate"
  ],
  "properties": {
    "tax_rate": {
      "type": "string",
      "maxLength": 5000,
      "description": "ID of the tax rate"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object billing_clocks_resource_status_details_advancing_status_details

{
  "type": "object",
  "title": "BillingClocksResourceStatusDetailsAdvancingStatusDetails",
  "required": [
    "target_frozen_time"
  ],
  "properties": {
    "target_frozen_time": {
      "type": "integer",
      "format": "unix-time",
      "description": "The `frozen_time` that the Test Clock is advancing towards."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object billing_clocks_resource_status_details_status_details

{
  "type": "object",
  "title": "BillingClocksResourceStatusDetailsStatusDetails",
  "properties": {
    "advancing": {
      "$ref": "#/components/schemas/billing_clocks_resource_status_details_advancing_status_details"
    }
  },
  "description": "",
  "x-expandableFields": [
    "advancing"
  ]
}

object billing_credit_grants_resource_amount

{
  "type": "object",
  "title": "BillingCreditGrantsResourceAmount",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "monetary"
      ],
      "type": "string",
      "description": "The type of this amount. We currently only support `monetary` billing credits.",
      "x-stripeBypassValidation": true
    },
    "monetary": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_credit_grants_resource_monetary_amount"
        }
      ],
      "nullable": true,
      "description": "The monetary amount."
    }
  },
  "description": "",
  "x-expandableFields": [
    "monetary"
  ]
}

object billing_credit_grants_resource_applicability_config

{
  "type": "object",
  "title": "BillingCreditGrantsResourceApplicabilityConfig",
  "required": [
    "scope"
  ],
  "properties": {
    "scope": {
      "$ref": "#/components/schemas/billing_credit_grants_resource_scope"
    }
  },
  "description": "",
  "x-expandableFields": [
    "scope"
  ]
}

object billing_credit_grants_resource_applicable_price

{
  "type": "object",
  "title": "BillingCreditGrantsResourceApplicablePrice",
  "properties": {
    "id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object billing_credit_grants_resource_balance_credit

{
  "type": "object",
  "title": "BillingCreditGrantsResourceBalanceCredit",
  "required": [
    "amount",
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "credits_application_invoice_voided",
        "credits_granted"
      ],
      "type": "string",
      "description": "The type of credit transaction."
    },
    "amount": {
      "$ref": "#/components/schemas/billing_credit_grants_resource_amount"
    },
    "credits_application_invoice_voided": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_credit_grants_resource_balance_credits_application_invoice_voided"
        }
      ],
      "nullable": true,
      "description": "Details of the invoice to which the reinstated credits were originally applied. Only present if `type` is `credits_application_invoice_voided`."
    }
  },
  "description": "",
  "x-expandableFields": [
    "amount",
    "credits_application_invoice_voided"
  ]
}

object billing_credit_grants_resource_balance_credits_application_invoice_voided

{
  "type": "object",
  "title": "BillingCreditGrantsResourceBalanceCreditsApplicationInvoiceVoided",
  "required": [
    "invoice",
    "invoice_line_item"
  ],
  "properties": {
    "invoice": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/invoice"
        }
      ],
      "description": "The invoice to which the reinstated billing credits were originally applied.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/invoice"
          }
        ]
      }
    },
    "invoice_line_item": {
      "type": "string",
      "maxLength": 5000,
      "description": "The invoice line item to which the reinstated billing credits were originally applied."
    }
  },
  "description": "",
  "x-expandableFields": [
    "invoice"
  ]
}

object billing_credit_grants_resource_balance_credits_applied

{
  "type": "object",
  "title": "BillingCreditGrantsResourceBalanceCreditsApplied",
  "required": [
    "invoice",
    "invoice_line_item"
  ],
  "properties": {
    "invoice": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/invoice"
        }
      ],
      "description": "The invoice to which the billing credits were applied.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/invoice"
          }
        ]
      }
    },
    "invoice_line_item": {
      "type": "string",
      "maxLength": 5000,
      "description": "The invoice line item to which the billing credits were applied."
    }
  },
  "description": "",
  "x-expandableFields": [
    "invoice"
  ]
}

object billing_credit_grants_resource_balance_debit

{
  "type": "object",
  "title": "BillingCreditGrantsResourceBalanceDebit",
  "required": [
    "amount",
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "credits_applied",
        "credits_expired",
        "credits_voided"
      ],
      "type": "string",
      "description": "The type of debit transaction."
    },
    "amount": {
      "$ref": "#/components/schemas/billing_credit_grants_resource_amount"
    },
    "credits_applied": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_credit_grants_resource_balance_credits_applied"
        }
      ],
      "nullable": true,
      "description": "Details of how the billing credits were applied to an invoice. Only present if `type` is `credits_applied`."
    }
  },
  "description": "",
  "x-expandableFields": [
    "amount",
    "credits_applied"
  ]
}

object billing_credit_grants_resource_monetary_amount

{
  "type": "object",
  "title": "BillingCreditGrantsResourceMonetaryAmount",
  "required": [
    "currency",
    "value"
  ],
  "properties": {
    "value": {
      "type": "integer",
      "description": "A positive integer representing the amount."
    },
    "currency": {
      "type": "string",
      "maxLength": 5000,
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object billing_credit_grants_resource_scope

{
  "type": "object",
  "title": "BillingCreditGrantsResourceScope",
  "properties": {
    "prices": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billing_credit_grants_resource_applicable_price"
      },
      "description": "The prices that credit grants can apply to. We currently only support `metered` prices. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them. Cannot be used in combination with `price_type`."
    },
    "price_type": {
      "enum": [
        "metered"
      ],
      "type": "string",
      "description": "The price type that credit grants can apply to. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them. Cannot be used in combination with `prices`."
    }
  },
  "description": "",
  "x-expandableFields": [
    "prices"
  ]
}

object billing_details

{
  "type": "object",
  "title": "billing_details",
  "properties": {
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Full name."
    },
    "email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Email address."
    },
    "phone": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Billing phone number (including extension)."
    },
    "tax_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers."
    },
    "address": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/address"
        }
      ],
      "nullable": true,
      "description": "Billing address."
    }
  },
  "description": "",
  "x-expandableFields": [
    "address"
  ]
}

object billing_meter_resource_aggregation_settings

{
  "type": "object",
  "title": "BillingMeterResourceAggregationSettings",
  "required": [
    "formula"
  ],
  "properties": {
    "formula": {
      "enum": [
        "count",
        "last",
        "sum"
      ],
      "type": "string",
      "description": "Specifies how events are aggregated.",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": []
}

object billing_meter_resource_billing_meter_event_adjustment_cancel

{
  "type": "object",
  "title": "BillingMeterResourceBillingMeterEventAdjustmentCancel",
  "properties": {
    "identifier": {
      "type": "string",
      "nullable": true,
      "maxLength": 100,
      "description": "Unique identifier for the event."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object billing_meter_resource_billing_meter_status_transitions

{
  "type": "object",
  "title": "BillingMeterResourceBillingMeterStatusTransitions",
  "properties": {
    "deactivated_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The time the meter was deactivated, if any. Measured in seconds since Unix epoch."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object billing_meter_resource_billing_meter_value

{
  "type": "object",
  "title": "BillingMeterResourceBillingMeterValue",
  "required": [
    "event_payload_key"
  ],
  "properties": {
    "event_payload_key": {
      "type": "string",
      "maxLength": 5000,
      "description": "The key in the meter event payload to use as the value for this meter."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object billing_meter_resource_customer_mapping_settings

{
  "type": "object",
  "title": "BillingMeterResourceCustomerMappingSettings",
  "required": [
    "event_payload_key",
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "by_id"
      ],
      "type": "string",
      "description": "The method for mapping a meter event to a customer."
    },
    "event_payload_key": {
      "type": "string",
      "maxLength": 5000,
      "description": "The key in the meter event payload to use for mapping the event to a customer."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object billing_portal.configuration

{
  "type": "object",
  "title": "PortalConfiguration",
  "required": [
    "active",
    "business_profile",
    "created",
    "features",
    "id",
    "is_default",
    "livemode",
    "login_page",
    "object",
    "updated"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The name of the configuration."
    },
    "active": {
      "type": "boolean",
      "description": "Whether the configuration is active and can be used to create portal sessions."
    },
    "object": {
      "enum": [
        "billing_portal.configuration"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "updated": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch."
    },
    "features": {
      "$ref": "#/components/schemas/portal_features"
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "is_default": {
      "type": "boolean",
      "description": "Whether the configuration is the default. If `true`, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session."
    },
    "login_page": {
      "$ref": "#/components/schemas/portal_login_page"
    },
    "application": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/application"
        },
        {
          "$ref": "#/components/schemas/deleted_application"
        }
      ],
      "nullable": true,
      "description": "ID of the Connect Application that created the configuration.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/application"
          },
          {
            "$ref": "#/components/schemas/deleted_application"
          }
        ]
      }
    },
    "business_profile": {
      "$ref": "#/components/schemas/portal_business_profile"
    },
    "default_return_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session."
    }
  },
  "description": "A portal configuration describes the functionality and behavior you embed in a portal session. Related guide: [Configure the customer portal](/customer-management/configure-portal).",
  "x-resourceId": "billing_portal.configuration",
  "x-expandableFields": [
    "application",
    "business_profile",
    "features",
    "login_page"
  ]
}

object billing_portal.session

{
  "type": "object",
  "title": "PortalSession",
  "required": [
    "configuration",
    "created",
    "customer",
    "id",
    "livemode",
    "object",
    "url"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "url": {
      "type": "string",
      "maxLength": 5000,
      "description": "The short-lived URL of the session that gives customers access to the customer portal."
    },
    "flow": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/portal_flows_flow"
        }
      ],
      "nullable": true,
      "description": "Information about a specific flow for the customer to go through. See the [docs](https://docs.stripe.com/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows."
    },
    "locale": {
      "enum": [
        "auto",
        "bg",
        "cs",
        "da",
        "de",
        "el",
        "en",
        "en-AU",
        "en-CA",
        "en-GB",
        "en-IE",
        "en-IN",
        "en-NZ",
        "en-SG",
        "es",
        "es-419",
        "et",
        "fi",
        "fil",
        "fr",
        "fr-CA",
        "hr",
        "hu",
        "id",
        "it",
        "ja",
        "ko",
        "lt",
        "lv",
        "ms",
        "mt",
        "nb",
        "nl",
        "pl",
        "pt",
        "pt-BR",
        "ro",
        "ru",
        "sk",
        "sl",
        "sv",
        "th",
        "tr",
        "vi",
        "zh",
        "zh-HK",
        "zh-TW"
      ],
      "type": "string",
      "nullable": true,
      "description": "The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used."
    },
    "object": {
      "enum": [
        "billing_portal.session"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "customer": {
      "type": "string",
      "maxLength": 5000,
      "description": "The ID of the customer for this session."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "return_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The URL to redirect customers to when they click on the portal's link to return to your website."
    },
    "on_behalf_of": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://docs.stripe.com/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://docs.stripe.com/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays."
    },
    "configuration": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/billing_portal.configuration"
        }
      ],
      "description": "The configuration used by this session, describing the features available.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/billing_portal.configuration"
          }
        ]
      }
    },
    "customer_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The ID of the account for this session."
    }
  },
  "description": "The Billing customer portal is a Stripe-hosted UI for subscription and\nbilling management.\n\nA portal configuration describes the functionality and features that you\nwant to provide to your customers through the portal.\n\nA portal session describes the instantiation of the customer portal for\na particular customer. By visiting the session's URL, the customer\ncan manage their subscriptions and billing details. For security reasons,\nsessions are short-lived and will expire if the customer does not visit the URL.\nCreate sessions on-demand when customers intend to manage their subscriptions\nand billing details.\n\nRelated guide: [Customer management](/customer-management)",
  "x-resourceId": "billing_portal.session",
  "x-expandableFields": [
    "configuration",
    "flow"
  ]
}

object cancellation_details

{
  "type": "object",
  "title": "CancellationDetails",
  "properties": {
    "reason": {
      "enum": [
        "canceled_by_retention_policy",
        "cancellation_requested",
        "payment_disputed",
        "payment_failed"
      ],
      "type": "string",
      "nullable": true,
      "description": "Why this subscription was canceled."
    },
    "comment": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user."
    },
    "feedback": {
      "enum": [
        "customer_service",
        "low_quality",
        "missing_features",
        "other",
        "switched_service",
        "too_complex",
        "too_expensive",
        "unused"
      ],
      "type": "string",
      "nullable": true,
      "description": "The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object capability

{
  "type": "object",
  "title": "AccountCapability",
  "required": [
    "account",
    "id",
    "object",
    "requested",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "The identifier for the capability."
    },
    "object": {
      "enum": [
        "capability"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "active",
        "inactive",
        "pending",
        "unrequested"
      ],
      "type": "string",
      "description": "The status of the capability.",
      "x-stripeBypassValidation": true
    },
    "account": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/account"
        }
      ],
      "description": "The account for which the capability enables functionality.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/account"
          }
        ]
      }
    },
    "requested": {
      "type": "boolean",
      "description": "Whether the capability has been requested."
    },
    "requested_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Time at which the capability was requested. Measured in seconds since the Unix epoch."
    },
    "requirements": {
      "$ref": "#/components/schemas/account_capability_requirements"
    },
    "future_requirements": {
      "$ref": "#/components/schemas/account_capability_future_requirements"
    }
  },
  "description": "This is an object representing a capability for a Stripe account.\n\nRelated guide: [Account capabilities](https://docs.stripe.com/connect/account-capabilities)",
  "x-resourceId": "capability",
  "x-expandableFields": [
    "account",
    "future_requirements",
    "requirements"
  ]
}

object card

{
  "type": "object",
  "title": "Card",
  "required": [
    "brand",
    "exp_month",
    "exp_year",
    "funding",
    "id",
    "last4",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "iin": {
      "type": "string",
      "maxLength": 5000,
      "description": "Issuer identification number of the card."
    },
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Cardholder name."
    },
    "brand": {
      "type": "string",
      "maxLength": 5000,
      "description": "Card brand. Can be `American Express`, `Cartes Bancaires`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`."
    },
    "last4": {
      "type": "string",
      "maxLength": 5000,
      "description": "The last four digits of the card."
    },
    "object": {
      "enum": [
        "card"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated."
    },
    "account": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/account"
        }
      ],
      "nullable": true,
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/account"
          }
        ]
      }
    },
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected."
    },
    "funding": {
      "type": "string",
      "maxLength": 5000,
      "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "nullable": true,
      "description": "Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available when returned as an [External Account](/api/external_account_cards/object) where [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) is `true`."
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        },
        {
          "$ref": "#/components/schemas/deleted_customer"
        }
      ],
      "nullable": true,
      "description": "The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          },
          {
            "$ref": "#/components/schemas/deleted_customer"
          }
        ]
      }
    },
    "exp_year": {
      "type": "integer",
      "description": "Four-digit number representing the card's expiration year."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "networks": {
      "$ref": "#/components/schemas/token_card_networks"
    },
    "cvc_check": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge)."
    },
    "exp_month": {
      "type": "integer",
      "description": "Two-digit number representing the card's expiration month."
    },
    "address_zip": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ZIP or postal code."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*"
    },
    "address_city": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "City/District/Suburb/Town/Village."
    },
    "address_line1": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Address line 1 (Street address/PO Box/Company name)."
    },
    "address_line2": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Address line 2 (Apartment/Suite/Unit/Building)."
    },
    "address_state": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "State/County/Province/Region."
    },
    "dynamic_last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "(For tokenized numbers only.) The last four digits of the device account number."
    },
    "address_country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Billing address country, if provided when creating card."
    },
    "allow_redisplay": {
      "enum": [
        "always",
        "limited",
        "unspecified"
      ],
      "type": "string",
      "nullable": true,
      "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”."
    },
    "regulated_status": {
      "enum": [
        "regulated",
        "unregulated"
      ],
      "type": "string",
      "nullable": true,
      "description": "Status of a card based on the card issuer."
    },
    "address_zip_check": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`."
    },
    "address_line1_check": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`."
    },
    "tokenization_method": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null."
    },
    "default_for_currency": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether this card is the default external account for its currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts."
    },
    "available_payout_methods": {
      "type": "array",
      "items": {
        "enum": [
          "instant",
          "standard"
        ],
        "type": "string"
      },
      "nullable": true,
      "description": "A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout."
    }
  },
  "description": "You can store multiple cards on a customer in order to charge the customer\nlater. You can also store multiple debit cards on a recipient in order to\ntransfer to those cards later.\n\nRelated guide: [Card payments with Sources](https://docs.stripe.com/sources/cards)",
  "x-resourceId": "card",
  "x-expandableFields": [
    "account",
    "customer",
    "networks"
  ]
}

object card_generated_from_payment_method_details

{
  "type": "object",
  "title": "card_generated_from_payment_method_details",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "type": "string",
      "maxLength": 5000,
      "description": "The type of payment method transaction-specific details from the transaction that generated this `card` payment method. Always `card_present`."
    },
    "card_present": {
      "$ref": "#/components/schemas/payment_method_details_card_present"
    }
  },
  "description": "",
  "x-expandableFields": [
    "card_present"
  ]
}

object card_issuing_account_terms_of_service

{
  "type": "object",
  "title": "CardIssuingAccountTermsOfService",
  "properties": {
    "ip": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The IP address from which the account representative accepted the service agreement."
    },
    "date": {
      "type": "integer",
      "nullable": true,
      "description": "The Unix timestamp marking when the account representative accepted the service agreement."
    },
    "user_agent": {
      "type": "string",
      "maxLength": 5000,
      "description": "The user agent of the browser from which the account representative accepted the service agreement."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object card_mandate_payment_method_details

{
  "type": "object",
  "title": "card_mandate_payment_method_details",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object cash_balance

{
  "type": "object",
  "title": "cash_balance",
  "required": [
    "customer",
    "livemode",
    "object",
    "settings"
  ],
  "properties": {
    "object": {
      "enum": [
        "cash_balance"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "customer": {
      "type": "string",
      "maxLength": 5000,
      "description": "The ID of the customer whose cash balance this object represents."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "settings": {
      "$ref": "#/components/schemas/customer_balance_customer_balance_settings"
    },
    "available": {
      "type": "object",
      "nullable": true,
      "description": "A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).",
      "additionalProperties": {
        "type": "integer"
      }
    },
    "customer_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The ID of an Account representing a customer whose cash balance this object represents."
    }
  },
  "description": "A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account.",
  "x-resourceId": "cash_balance",
  "x-expandableFields": [
    "settings"
  ]
}

object charge

{
  "type": "object",
  "title": "Charge",
  "required": [
    "amount",
    "amount_captured",
    "amount_refunded",
    "billing_details",
    "captured",
    "created",
    "currency",
    "disputed",
    "id",
    "livemode",
    "metadata",
    "object",
    "paid",
    "refunded",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "paid": {
      "type": "boolean",
      "description": "`true` if the charge succeeded, or was successfully authorized for later capture."
    },
    "amount": {
      "type": "integer",
      "description": "Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99)."
    },
    "object": {
      "enum": [
        "charge"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "review": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/review"
        }
      ],
      "nullable": true,
      "description": "ID of the review associated with this charge if one exists.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/review"
          }
        ]
      }
    },
    "status": {
      "enum": [
        "failed",
        "pending",
        "succeeded"
      ],
      "type": "string",
      "description": "The status of the payment is either `succeeded`, `pending`, or `failed`."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "outcome": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/charge_outcome"
        }
      ],
      "nullable": true,
      "description": "Details about whether the payment was accepted, and why. See [understanding declines](https://docs.stripe.com/declines) for details."
    },
    "refunds": {
      "type": "object",
      "title": "RefundList",
      "nullable": true,
      "required": [
        "data",
        "has_more",
        "object",
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "maxLength": 5000,
          "description": "The URL where this list can be accessed."
        },
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/refund"
          },
          "description": "Details about each object."
        },
        "object": {
          "enum": [
            "list"
          ],
          "type": "string",
          "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
        },
        "has_more": {
          "type": "boolean",
          "description": "True if this list has another page of items after this one that can be fetched."
        }
      },
      "description": "A list of refunds that have been applied to the charge.",
      "x-expandableFields": [
        "data"
      ]
    },
    "captured": {
      "type": "boolean",
      "description": "If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        },
        {
          "$ref": "#/components/schemas/deleted_customer"
        }
      ],
      "nullable": true,
      "description": "ID of the customer this charge is for if one exists.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          },
          {
            "$ref": "#/components/schemas/deleted_customer"
          }
        ]
      }
    },
    "disputed": {
      "type": "boolean",
      "description": "Whether the charge has been disputed."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "refunded": {
      "type": "boolean",
      "description": "Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false."
    },
    "shipping": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/shipping"
        }
      ],
      "nullable": true,
      "description": "Shipping information for the charge."
    },
    "transfer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/transfer"
        }
      ],
      "description": "ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter).",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/transfer"
          }
        ]
      }
    },
    "application": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/application"
        }
      ],
      "nullable": true,
      "description": "ID of the Connect application that created the charge.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/application"
          }
        ]
      }
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 40000,
      "description": "An arbitrary string attached to the object. Often useful for displaying to users."
    },
    "receipt_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt."
    },
    "failure_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Error code explaining reason for charge failure if available (see [the errors section](https://docs.stripe.com/error-codes) for a list of codes)."
    },
    "on_behalf_of": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/account"
        }
      ],
      "nullable": true,
      "description": "The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers) for details.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/account"
          }
        ]
      }
    },
    "fraud_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/charge_fraud_details"
        }
      ],
      "nullable": true,
      "description": "Information on fraud assessments for the charge."
    },
    "radar_options": {
      "$ref": "#/components/schemas/radar_radar_options"
    },
    "receipt_email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "This is the email address that the receipt for this charge was sent to."
    },
    "transfer_data": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/charge_transfer_data"
        }
      ],
      "nullable": true,
      "description": "An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details."
    },
    "payment_intent": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_intent"
        }
      ],
      "nullable": true,
      "description": "ID of the PaymentIntent associated with this charge, if one exists.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_intent"
          }
        ]
      }
    },
    "payment_method": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the payment method used in this charge."
    },
    "receipt_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "This is the transaction number that appears on email receipts sent for this charge. This attribute will be `null` until a receipt has been sent."
    },
    "transfer_group": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A string that identifies this transaction as part of a group. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details."
    },
    "amount_captured": {
      "type": "integer",
      "description": "Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made)."
    },
    "amount_refunded": {
      "type": "integer",
      "description": "Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued)."
    },
    "application_fee": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/application_fee"
        }
      ],
      "nullable": true,
      "description": "The application fee (if any) for the charge. [See the Connect documentation](https://docs.stripe.com/connect/direct-charges#collect-fees) for details.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/application_fee"
          }
        ]
      }
    },
    "billing_details": {
      "$ref": "#/components/schemas/billing_details"
    },
    "failure_message": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Message to user further explaining reason for charge failure if available."
    },
    "source_transfer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/transfer"
        }
      ],
      "nullable": true,
      "description": "The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/transfer"
          }
        ]
      }
    },
    "balance_transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/balance_transaction"
        }
      ],
      "nullable": true,
      "description": "ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/balance_transaction"
          }
        ]
      }
    },
    "presentment_details": {
      "$ref": "#/components/schemas/payment_flows_payment_intent_presentment_details"
    },
    "statement_descriptor": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nFor a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix."
    },
    "application_fee_amount": {
      "type": "integer",
      "nullable": true,
      "description": "The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://docs.stripe.com/connect/direct-charges#collect-fees) for details."
    },
    "payment_method_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_details"
        }
      ],
      "nullable": true,
      "description": "Details about the payment method at the time of the transaction."
    },
    "failure_balance_transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/balance_transaction"
        }
      ],
      "nullable": true,
      "description": "ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/balance_transaction"
          }
        ]
      }
    },
    "statement_descriptor_suffix": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor."
    },
    "calculated_statement_descriptor": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments."
    }
  },
  "description": "The `Charge` object represents a single attempt to move money into your Stripe account.\nPaymentIntent confirmation is the most common way to create Charges, but [Account Debits](https://docs.stripe.com/connect/account-debits) may also create Charges.\nSome legacy payment flows create Charges directly, which is not recommended for new integrations.",
  "x-resourceId": "charge",
  "x-expandableFields": [
    "application",
    "application_fee",
    "balance_transaction",
    "billing_details",
    "customer",
    "failure_balance_transaction",
    "fraud_details",
    "on_behalf_of",
    "outcome",
    "payment_intent",
    "payment_method_details",
    "presentment_details",
    "radar_options",
    "refunds",
    "review",
    "shipping",
    "source_transfer",
    "transfer",
    "transfer_data"
  ]
}

object charge_fraud_details

{
  "type": "object",
  "title": "ChargeFraudDetails",
  "properties": {
    "user_report": {
      "type": "string",
      "maxLength": 5000,
      "description": "Assessments reported by you. If set, possible values of are `safe` and `fraudulent`."
    },
    "stripe_report": {
      "type": "string",
      "maxLength": 5000,
      "description": "Assessments from Stripe. If set, the value is `fraudulent`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object charge_outcome

{
  "type": "object",
  "title": "ChargeOutcome",
  "required": [
    "type"
  ],
  "properties": {
    "rule": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/rule"
        }
      ],
      "description": "The ID of the Radar rule that matched the payment, if applicable.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/rule"
          }
        ]
      }
    },
    "type": {
      "type": "string",
      "maxLength": 5000,
      "description": "Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See [understanding declines](https://docs.stripe.com/declines) and [Radar reviews](https://docs.stripe.com/radar/reviews) for details."
    },
    "reason": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges blocked because the payment is unlikely to be authorized have the value `low_probability_of_authorization`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://docs.stripe.com/declines) for more details."
    },
    "risk_level": {
      "type": "string",
      "maxLength": 5000,
      "description": "Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are `normal`, `elevated`, `highest`. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value `not_assessed`. In the event of an error in the evaluation, this field will have the value `unknown`. This field is only available with Radar."
    },
    "risk_score": {
      "type": "integer",
      "description": "Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are between 0 and 100. For non-card payments, card-based payments predating the public assignment of risk scores, or in the event of an error during evaluation, this field will not be present. This field is only available with Radar for Fraud Teams."
    },
    "advice_code": {
      "enum": [
        "confirm_card_data",
        "do_not_try_again",
        "try_again_later"
      ],
      "type": "string",
      "nullable": true,
      "description": "An enumerated value providing a more detailed explanation on [how to proceed with an error](https://docs.stripe.com/declines#retrying-issuer-declines)."
    },
    "network_status": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://docs.stripe.com/declines#blocked-payments) after bank authorization, and may temporarily appear as \"pending\" on a cardholder's statement."
    },
    "seller_message": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer."
    },
    "network_advice_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "For charges declined by the network, a 2 digit code which indicates the advice returned by the network on how to proceed with an error."
    },
    "network_decline_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "For charges declined by the network, an alphanumeric code which indicates the reason the charge failed."
    }
  },
  "description": "",
  "x-expandableFields": [
    "rule"
  ]
}

object charge_transfer_data

{
  "type": "object",
  "title": "ChargeTransferData",
  "required": [
    "destination"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "nullable": true,
      "description": "The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account."
    },
    "destination": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/account"
        }
      ],
      "description": "ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/account"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "destination"
  ]
}

object checkout.session

{
  "type": "object",
  "title": "Session",
  "required": [
    "automatic_tax",
    "created",
    "custom_fields",
    "custom_text",
    "expires_at",
    "id",
    "livemode",
    "mode",
    "object",
    "payment_method_types",
    "payment_status",
    "shipping_options"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The URL to the Checkout Session. Applies to Checkout Sessions with `ui_mode: hosted`. Redirect customers to this URL to take them to Checkout. If you’re using [Custom Domains](https://docs.stripe.com/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it’ll use `checkout.stripe.com.`\nThis value is only present when the session is active."
    },
    "mode": {
      "enum": [
        "payment",
        "setup",
        "subscription"
      ],
      "type": "string",
      "description": "The mode of the Checkout Session.",
      "x-stripeBypassValidation": true
    },
    "locale": {
      "enum": [
        "auto",
        "bg",
        "cs",
        "da",
        "de",
        "el",
        "en",
        "en-GB",
        "es",
        "es-419",
        "et",
        "fi",
        "fil",
        "fr",
        "fr-CA",
        "hr",
        "hu",
        "id",
        "it",
        "ja",
        "ko",
        "lt",
        "lv",
        "ms",
        "mt",
        "nb",
        "nl",
        "pl",
        "pt",
        "pt-BR",
        "ro",
        "ru",
        "sk",
        "sl",
        "sv",
        "th",
        "tr",
        "vi",
        "zh",
        "zh-HK",
        "zh-TW"
      ],
      "type": "string",
      "nullable": true,
      "description": "The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.",
      "x-stripeBypassValidation": true
    },
    "object": {
      "enum": [
        "checkout.session"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "complete",
        "expired",
        "open"
      ],
      "type": "string",
      "nullable": true,
      "description": "The status of the Checkout Session, one of `open`, `complete`, or `expired`."
    },
    "consent": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_pages_checkout_session_consent"
        }
      ],
      "nullable": true,
      "description": "Results of `consent_collection` for this session."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "invoice": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/invoice"
        }
      ],
      "nullable": true,
      "description": "ID of the invoice created by the Checkout Session, if it exists.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/invoice"
          }
        ]
      }
    },
    "ui_mode": {
      "enum": [
        "elements",
        "embedded_page",
        "hosted_page"
      ],
      "type": "string",
      "nullable": true,
      "description": "The UI mode of the Session. Defaults to `hosted_page`.",
      "x-stripeBypassValidation": true
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "nullable": true,
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        },
        {
          "$ref": "#/components/schemas/deleted_customer"
        }
      ],
      "nullable": true,
      "description": "The ID of the customer for this Session.\nFor Checkout Sessions in `subscription` mode or Checkout Sessions with `customer_creation` set as `always` in `payment` mode, Checkout\nwill create a new customer object based on information provided\nduring the payment flow unless an existing customer was provided when\nthe Session was created.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          },
          {
            "$ref": "#/components/schemas/deleted_customer"
          }
        ]
      }
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "discounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/payment_pages_checkout_session_discount"
      },
      "nullable": true,
      "description": "List of coupons and promotion codes attached to the Checkout Session."
    },
    "cancel_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website."
    },
    "expires_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "The timestamp at which the Checkout Session will expire."
    },
    "line_items": {
      "type": "object",
      "title": "PaymentPagesCheckoutSessionListLineItems",
      "required": [
        "data",
        "has_more",
        "object",
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "maxLength": 5000,
          "description": "The URL where this list can be accessed."
        },
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/item"
          },
          "description": "Details about each object."
        },
        "object": {
          "enum": [
            "list"
          ],
          "type": "string",
          "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
        },
        "has_more": {
          "type": "boolean",
          "description": "True if this list has another page of items after this one that can be fetched."
        }
      },
      "description": "The line items purchased by the customer.",
      "x-expandableFields": [
        "data"
      ]
    },
    "return_url": {
      "type": "string",
      "maxLength": 5000,
      "description": "Applies to Checkout Sessions with `ui_mode: embedded` or `ui_mode: custom`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site."
    },
    "custom_text": {
      "$ref": "#/components/schemas/payment_pages_checkout_session_custom_text"
    },
    "permissions": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_pages_checkout_session_permissions"
        }
      ],
      "nullable": true,
      "description": "This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object.\n\nFor specific permissions, please refer to their dedicated subsections, such as `permissions.update_shipping_details`."
    },
    "submit_type": {
      "enum": [
        "auto",
        "book",
        "donate",
        "pay",
        "subscribe"
      ],
      "type": "string",
      "nullable": true,
      "description": "Describes the type of transaction being performed by Checkout in order to customize\nrelevant text on the page, such as the submit button. `submit_type` can only be\nspecified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used."
    },
    "success_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The URL the customer will be directed to after the payment or\nsubscription creation is successful."
    },
    "amount_total": {
      "type": "integer",
      "nullable": true,
      "description": "Total of all items after discounts and taxes are applied."
    },
    "payment_link": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_link"
        }
      ],
      "nullable": true,
      "description": "The ID of the Payment Link that created this Session.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_link"
          }
        ]
      }
    },
    "setup_intent": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/setup_intent"
        }
      ],
      "nullable": true,
      "description": "The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://docs.stripe.com/api/checkout/sessions/expire) instead.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/setup_intent"
          }
        ]
      }
    },
    "subscription": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/subscription"
        }
      ],
      "nullable": true,
      "description": "The ID of the [Subscription](https://docs.stripe.com/api/subscriptions) for Checkout Sessions in `subscription` mode.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/subscription"
          }
        ]
      }
    },
    "automatic_tax": {
      "$ref": "#/components/schemas/payment_pages_checkout_session_automatic_tax"
    },
    "client_secret": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The client secret of your Checkout Session. Applies to Checkout Sessions with `ui_mode: embedded` or `ui_mode: custom`. For `ui_mode: embedded`, the client secret is to be used when initializing Stripe.js embedded checkout.\n For `ui_mode: custom`, use the client secret with [initCheckout](https://docs.stripe.com/js/custom_checkout/init) on your front end."
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields"
      },
      "description": "Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if `ui_mode` is `custom`."
    },
    "shipping_cost": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_pages_checkout_session_shipping_cost"
        }
      ],
      "nullable": true,
      "description": "The details of the customer cost of shipping, including the customer chosen ShippingRate."
    },
    "total_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_pages_checkout_session_total_details"
        }
      ],
      "nullable": true,
      "description": "Tax and discount details for the computed total amount."
    },
    "customer_email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "If provided, this value will be used when the Customer object is created.\nIf not provided, customers will be asked to enter their email address.\nUse this parameter to prefill customer data if you already have an email\non file. To access information about the customer once the payment flow is\ncomplete, use the `customer` attribute."
    },
    "optional_items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/payment_pages_checkout_session_optional_item"
      },
      "nullable": true,
      "description": "The optional items presented to the customer at checkout."
    },
    "origin_context": {
      "enum": [
        "mobile_app",
        "web"
      ],
      "type": "string",
      "nullable": true,
      "description": "Where the user is coming from. This informs the optimizations that are applied to the session."
    },
    "payment_intent": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_intent"
        }
      ],
      "nullable": true,
      "description": "The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://docs.stripe.com/api/checkout/sessions/expire) instead.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_intent"
          }
        ]
      }
    },
    "payment_status": {
      "enum": [
        "no_payment_required",
        "paid",
        "unpaid"
      ],
      "type": "string",
      "description": "The payment status of the Checkout Session, one of `paid`, `unpaid`, or `no_payment_required`.\nYou can use this value to decide when to fulfill your customer's order."
    },
    "recovered_from": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The ID of the original expired Checkout Session that triggered the recovery flow."
    },
    "wallet_options": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/checkout_session_wallet_options"
        }
      ],
      "nullable": true,
      "description": "Wallet-specific configuration for this Checkout Session."
    },
    "amount_subtotal": {
      "type": "integer",
      "nullable": true,
      "description": "Total of all items before discounts or taxes are applied."
    },
    "name_collection": {
      "$ref": "#/components/schemas/payment_pages_checkout_session_name_collection"
    },
    "adaptive_pricing": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_pages_checkout_session_adaptive_pricing"
        }
      ],
      "nullable": true,
      "description": "Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing)."
    },
    "after_expiration": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_pages_checkout_session_after_expiration"
        }
      ],
      "nullable": true,
      "description": "When set, provides configuration for actions to take if this Checkout Session expires."
    },
    "customer_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The ID of the account for this Session."
    },
    "customer_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_pages_checkout_session_customer_details"
        }
      ],
      "nullable": true,
      "description": "The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in `setup` mode."
    },
    "invoice_creation": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_pages_checkout_session_invoice_creation"
        }
      ],
      "nullable": true,
      "description": "Details on the state of invoice creation for the Checkout Session."
    },
    "shipping_options": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/payment_pages_checkout_session_shipping_option"
      },
      "description": "The shipping rate options applied to this Session."
    },
    "branding_settings": {
      "$ref": "#/components/schemas/payment_pages_checkout_session_branding_settings"
    },
    "customer_creation": {
      "enum": [
        "always",
        "if_required"
      ],
      "type": "string",
      "nullable": true,
      "description": "Configure whether a Checkout Session creates a Customer when the Checkout Session completes."
    },
    "tax_id_collection": {
      "$ref": "#/components/schemas/payment_pages_checkout_session_tax_id_collection"
    },
    "consent_collection": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_pages_checkout_session_consent_collection"
        }
      ],
      "nullable": true,
      "description": "When set, provides configuration for the Checkout Session to gather active consent from customers."
    },
    "client_reference_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A unique string to reference the Checkout Session. This can be a\ncustomer ID, a cart ID, or similar, and can be used to reconcile the\nSession with your internal systems."
    },
    "currency_conversion": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_pages_checkout_session_currency_conversion"
        }
      ],
      "nullable": true,
      "description": "Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions created before 2025-03-31."
    },
    "presentment_details": {
      "$ref": "#/components/schemas/payment_flows_payment_intent_presentment_details"
    },
    "payment_method_types": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "A list of the types of payment methods (e.g. card) this Checkout\nSession is allowed to accept."
    },
    "allow_promotion_codes": {
      "type": "boolean",
      "nullable": true,
      "description": "Enables user redeemable promotion codes."
    },
    "collected_information": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_pages_checkout_session_collected_information"
        }
      ],
      "nullable": true,
      "description": "Information about the customer collected within the Checkout Session."
    },
    "integration_identifier": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The integration identifier for this Checkout Session. Multiple Checkout Sessions can have the same integration identifier."
    },
    "payment_method_options": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/checkout_session_payment_method_options"
        }
      ],
      "nullable": true,
      "description": "Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession."
    },
    "redirect_on_completion": {
      "enum": [
        "always",
        "if_required",
        "never"
      ],
      "type": "string",
      "description": "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://docs.stripe.com/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`."
    },
    "phone_number_collection": {
      "$ref": "#/components/schemas/payment_pages_checkout_session_phone_number_collection"
    },
    "payment_method_collection": {
      "enum": [
        "always",
        "if_required"
      ],
      "type": "string",
      "nullable": true,
      "description": "Configure whether a Checkout Session should collect a payment method. Defaults to `always`."
    },
    "billing_address_collection": {
      "enum": [
        "auto",
        "required"
      ],
      "type": "string",
      "nullable": true,
      "description": "Describes whether Checkout should collect the customer's billing address. Defaults to `auto`."
    },
    "shipping_address_collection": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_pages_checkout_session_shipping_address_collection"
        }
      ],
      "nullable": true,
      "description": "When set, provides configuration for Checkout to collect a shipping address from a customer."
    },
    "saved_payment_method_options": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_pages_checkout_session_saved_payment_method_options"
        }
      ],
      "nullable": true,
      "description": "Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode."
    },
    "excluded_payment_method_types": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "A list of the types of payment methods (e.g., `card`) that should be excluded from this Checkout Session. This should only be used when payment methods for this Checkout Session are managed through the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods)."
    },
    "payment_method_configuration_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_config_biz_payment_method_configuration_details"
        }
      ],
      "nullable": true,
      "description": "Information about the payment method configuration used for this Checkout session if using dynamic payment methods."
    }
  },
  "description": "A Checkout Session represents your customer's session as they pay for\none-time purchases or subscriptions through [Checkout](https://docs.stripe.com/payments/checkout)\nor [Payment Links](https://docs.stripe.com/payments/payment-links). We recommend creating a\nnew Session each time your customer attempts to pay.\n\nOnce payment is successful, the Checkout Session will contain a reference\nto the [Customer](https://docs.stripe.com/api/customers), and either the successful\n[PaymentIntent](https://docs.stripe.com/api/payment_intents) or an active\n[Subscription](https://docs.stripe.com/api/subscriptions).\n\nYou can create a Checkout Session on your server and redirect to its URL\nto begin Checkout.\n\nRelated guide: [Checkout quickstart](https://docs.stripe.com/checkout/quickstart)",
  "x-resourceId": "checkout.session",
  "x-expandableFields": [
    "adaptive_pricing",
    "after_expiration",
    "automatic_tax",
    "branding_settings",
    "collected_information",
    "consent",
    "consent_collection",
    "currency_conversion",
    "custom_fields",
    "custom_text",
    "customer",
    "customer_details",
    "discounts",
    "invoice",
    "invoice_creation",
    "line_items",
    "name_collection",
    "optional_items",
    "payment_intent",
    "payment_link",
    "payment_method_configuration_details",
    "payment_method_options",
    "permissions",
    "phone_number_collection",
    "presentment_details",
    "saved_payment_method_options",
    "setup_intent",
    "shipping_address_collection",
    "shipping_cost",
    "shipping_options",
    "subscription",
    "tax_id_collection",
    "total_details",
    "wallet_options"
  ]
}

object checkout_acss_debit_mandate_options

{
  "type": "object",
  "title": "CheckoutAcssDebitMandateOptions",
  "properties": {
    "default_for": {
      "type": "array",
      "items": {
        "enum": [
          "invoice",
          "subscription"
        ],
        "type": "string"
      },
      "description": "List of Stripe products where this mandate can be selected automatically. Returned when the Session is in `setup` mode."
    },
    "payment_schedule": {
      "enum": [
        "combined",
        "interval",
        "sporadic"
      ],
      "type": "string",
      "nullable": true,
      "description": "Payment schedule for the mandate."
    },
    "transaction_type": {
      "enum": [
        "business",
        "personal"
      ],
      "type": "string",
      "nullable": true,
      "description": "Transaction type of the mandate."
    },
    "custom_mandate_url": {
      "type": "string",
      "maxLength": 5000,
      "description": "A URL for custom mandate text"
    },
    "interval_description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_acss_debit_payment_method_options

{
  "type": "object",
  "title": "CheckoutAcssDebitPaymentMethodOptions",
  "properties": {
    "currency": {
      "enum": [
        "cad",
        "usd"
      ],
      "type": "string",
      "description": "Currency supported by the bank account. Returned when the Session is in `setup` mode."
    },
    "target_date": {
      "type": "string",
      "maxLength": 5000,
      "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now."
    },
    "mandate_options": {
      "$ref": "#/components/schemas/checkout_acss_debit_mandate_options"
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session",
        "on_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    },
    "verification_method": {
      "enum": [
        "automatic",
        "instant",
        "microdeposits"
      ],
      "type": "string",
      "description": "Bank account verification method. The default value is `automatic`.",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": [
    "mandate_options"
  ]
}

object checkout_affirm_payment_method_options

{
  "type": "object",
  "title": "CheckoutAffirmPaymentMethodOptions",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    },
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_afterpay_clearpay_payment_method_options

{
  "type": "object",
  "title": "CheckoutAfterpayClearpayPaymentMethodOptions",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    },
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_alipay_payment_method_options

{
  "type": "object",
  "title": "CheckoutAlipayPaymentMethodOptions",
  "properties": {
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_alma_payment_method_options

{
  "type": "object",
  "title": "CheckoutAlmaPaymentMethodOptions",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_amazon_pay_payment_method_options

{
  "type": "object",
  "title": "CheckoutAmazonPayPaymentMethodOptions",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_au_becs_debit_payment_method_options

{
  "type": "object",
  "title": "CheckoutAuBecsDebitPaymentMethodOptions",
  "properties": {
    "target_date": {
      "type": "string",
      "maxLength": 5000,
      "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now."
    },
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_bacs_debit_payment_method_options

{
  "type": "object",
  "title": "CheckoutBacsDebitPaymentMethodOptions",
  "properties": {
    "target_date": {
      "type": "string",
      "maxLength": 5000,
      "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now."
    },
    "mandate_options": {
      "$ref": "#/components/schemas/checkout_payment_method_options_mandate_options_bacs_debit"
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session",
        "on_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": [
    "mandate_options"
  ]
}

object checkout_bancontact_payment_method_options

{
  "type": "object",
  "title": "CheckoutBancontactPaymentMethodOptions",
  "properties": {
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_billie_payment_method_options

{
  "type": "object",
  "title": "CheckoutBilliePaymentMethodOptions",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_boleto_payment_method_options

{
  "type": "object",
  "title": "CheckoutBoletoPaymentMethodOptions",
  "required": [
    "expires_after_days"
  ],
  "properties": {
    "expires_after_days": {
      "type": "integer",
      "description": "The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time."
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session",
        "on_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_card_installments_options

{
  "type": "object",
  "title": "CheckoutCardInstallmentsOptions",
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Indicates if installments are enabled"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_card_payment_method_options

{
  "type": "object",
  "title": "CheckoutCardPaymentMethodOptions",
  "required": [
    "request_three_d_secure"
  ],
  "properties": {
    "installments": {
      "$ref": "#/components/schemas/checkout_card_installments_options"
    },
    "restrictions": {
      "$ref": "#/components/schemas/payment_pages_private_card_payment_method_options_resource_restrictions"
    },
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session",
        "on_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    },
    "request_overcapture": {
      "enum": [
        "if_available",
        "never"
      ],
      "type": "string",
      "description": "Request ability to [overcapture](/payments/overcapture) for this CheckoutSession."
    },
    "request_multicapture": {
      "enum": [
        "if_available",
        "never"
      ],
      "type": "string",
      "description": "Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession."
    },
    "request_three_d_secure": {
      "enum": [
        "any",
        "automatic",
        "challenge"
      ],
      "type": "string",
      "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://docs.stripe.com/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
      "x-stripeBypassValidation": true
    },
    "request_extended_authorization": {
      "enum": [
        "if_available",
        "never"
      ],
      "type": "string",
      "description": "Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession."
    },
    "statement_descriptor_suffix_kana": {
      "type": "string",
      "maxLength": 5000,
      "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters."
    },
    "request_incremental_authorization": {
      "enum": [
        "if_available",
        "never"
      ],
      "type": "string",
      "description": "Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession."
    },
    "statement_descriptor_suffix_kanji": {
      "type": "string",
      "maxLength": 5000,
      "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters."
    }
  },
  "description": "",
  "x-expandableFields": [
    "installments",
    "restrictions"
  ]
}

object checkout_cashapp_payment_method_options

{
  "type": "object",
  "title": "CheckoutCashappPaymentMethodOptions",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    },
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_customer_balance_bank_transfer_payment_method_options

{
  "type": "object",
  "title": "CheckoutCustomerBalanceBankTransferPaymentMethodOptions",
  "properties": {
    "type": {
      "enum": [
        "eu_bank_transfer",
        "gb_bank_transfer",
        "jp_bank_transfer",
        "mx_bank_transfer",
        "us_bank_transfer"
      ],
      "type": "string",
      "nullable": true,
      "description": "The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.",
      "x-stripeBypassValidation": true
    },
    "eu_bank_transfer": {
      "$ref": "#/components/schemas/payment_method_options_customer_balance_eu_bank_account"
    },
    "requested_address_types": {
      "type": "array",
      "items": {
        "enum": [
          "aba",
          "iban",
          "sepa",
          "sort_code",
          "spei",
          "swift",
          "zengin"
        ],
        "type": "string",
        "x-stripeBypassValidation": true
      },
      "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`."
    }
  },
  "description": "",
  "x-expandableFields": [
    "eu_bank_transfer"
  ]
}

object checkout_customer_balance_payment_method_options

{
  "type": "object",
  "title": "CheckoutCustomerBalancePaymentMethodOptions",
  "properties": {
    "funding_type": {
      "enum": [
        "bank_transfer"
      ],
      "type": "string",
      "nullable": true,
      "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`."
    },
    "bank_transfer": {
      "$ref": "#/components/schemas/checkout_customer_balance_bank_transfer_payment_method_options"
    },
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": [
    "bank_transfer"
  ]
}

object checkout_eps_payment_method_options

{
  "type": "object",
  "title": "CheckoutEpsPaymentMethodOptions",
  "properties": {
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_fpx_payment_method_options

{
  "type": "object",
  "title": "CheckoutFpxPaymentMethodOptions",
  "properties": {
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_giropay_payment_method_options

{
  "type": "object",
  "title": "CheckoutGiropayPaymentMethodOptions",
  "properties": {
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_grab_pay_payment_method_options

{
  "type": "object",
  "title": "CheckoutGrabPayPaymentMethodOptions",
  "properties": {
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_ideal_payment_method_options

{
  "type": "object",
  "title": "CheckoutIdealPaymentMethodOptions",
  "properties": {
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_kakao_pay_payment_method_options

{
  "type": "object",
  "title": "CheckoutKakaoPayPaymentMethodOptions",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_klarna_payment_method_options

{
  "type": "object",
  "title": "CheckoutKlarnaPaymentMethodOptions",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session",
        "on_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_konbini_payment_method_options

{
  "type": "object",
  "title": "CheckoutKonbiniPaymentMethodOptions",
  "properties": {
    "expires_after_days": {
      "type": "integer",
      "nullable": true,
      "description": "The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST."
    },
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_kr_card_payment_method_options

{
  "type": "object",
  "title": "CheckoutKrCardPaymentMethodOptions",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_link_payment_method_options

{
  "type": "object",
  "title": "CheckoutLinkPaymentMethodOptions",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_link_wallet_options

{
  "type": "object",
  "title": "CheckoutLinkWalletOptions",
  "properties": {
    "display": {
      "enum": [
        "auto",
        "never"
      ],
      "type": "string",
      "description": "Describes whether Checkout should display Link. Defaults to `auto`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_mobilepay_payment_method_options

{
  "type": "object",
  "title": "CheckoutMobilepayPaymentMethodOptions",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    },
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_multibanco_payment_method_options

{
  "type": "object",
  "title": "CheckoutMultibancoPaymentMethodOptions",
  "properties": {
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_naver_pay_payment_method_options

{
  "type": "object",
  "title": "CheckoutNaverPayPaymentMethodOptions",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_oxxo_payment_method_options

{
  "type": "object",
  "title": "CheckoutOxxoPaymentMethodOptions",
  "required": [
    "expires_after_days"
  ],
  "properties": {
    "expires_after_days": {
      "type": "integer",
      "description": "The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time."
    },
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_p24_payment_method_options

{
  "type": "object",
  "title": "CheckoutP24PaymentMethodOptions",
  "properties": {
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_payco_payment_method_options

{
  "type": "object",
  "title": "CheckoutPaycoPaymentMethodOptions",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_payment_method_options_mandate_options_bacs_debit

{
  "type": "object",
  "title": "checkout_payment_method_options_mandate_options_bacs_debit",
  "properties": {
    "reference_prefix": {
      "type": "string",
      "maxLength": 5000,
      "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_payment_method_options_mandate_options_sepa_debit

{
  "type": "object",
  "title": "checkout_payment_method_options_mandate_options_sepa_debit",
  "properties": {
    "reference_prefix": {
      "type": "string",
      "maxLength": 5000,
      "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_paynow_payment_method_options

{
  "type": "object",
  "title": "CheckoutPaynowPaymentMethodOptions",
  "properties": {
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_paypal_payment_method_options

{
  "type": "object",
  "title": "CheckoutPaypalPaymentMethodOptions",
  "properties": {
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID."
    },
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    },
    "preferred_locale": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Preferred locale of the PayPal checkout page that the customer is redirected to."
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_payto_payment_method_options

{
  "type": "object",
  "title": "CheckoutPaytoPaymentMethodOptions",
  "properties": {
    "mandate_options": {
      "$ref": "#/components/schemas/mandate_options_payto"
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": [
    "mandate_options"
  ]
}

object checkout_pix_payment_method_options

{
  "type": "object",
  "title": "CheckoutPixPaymentMethodOptions",
  "properties": {
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
      "x-stripeBypassValidation": true
    },
    "amount_includes_iof": {
      "enum": [
        "always",
        "never"
      ],
      "type": "string",
      "description": "Determines if the amount includes the IOF tax."
    },
    "expires_after_seconds": {
      "type": "integer",
      "nullable": true,
      "description": "The number of seconds after which Pix payment will expire."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_revolut_pay_payment_method_options

{
  "type": "object",
  "title": "CheckoutRevolutPayPaymentMethodOptions",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_samsung_pay_payment_method_options

{
  "type": "object",
  "title": "CheckoutSamsungPayPaymentMethodOptions",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_satispay_payment_method_options

{
  "type": "object",
  "title": "CheckoutSatispayPaymentMethodOptions",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_sepa_debit_payment_method_options

{
  "type": "object",
  "title": "CheckoutSepaDebitPaymentMethodOptions",
  "properties": {
    "target_date": {
      "type": "string",
      "maxLength": 5000,
      "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now."
    },
    "mandate_options": {
      "$ref": "#/components/schemas/checkout_payment_method_options_mandate_options_sepa_debit"
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session",
        "on_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": [
    "mandate_options"
  ]
}

object checkout_session_payment_method_options

{
  "type": "object",
  "title": "CheckoutSessionPaymentMethodOptions",
  "properties": {
    "eps": {
      "$ref": "#/components/schemas/checkout_eps_payment_method_options"
    },
    "fpx": {
      "$ref": "#/components/schemas/checkout_fpx_payment_method_options"
    },
    "p24": {
      "$ref": "#/components/schemas/checkout_p24_payment_method_options"
    },
    "pix": {
      "$ref": "#/components/schemas/checkout_pix_payment_method_options"
    },
    "upi": {
      "$ref": "#/components/schemas/checkout_upi_payment_method_options"
    },
    "alma": {
      "$ref": "#/components/schemas/checkout_alma_payment_method_options"
    },
    "card": {
      "$ref": "#/components/schemas/checkout_card_payment_method_options"
    },
    "link": {
      "$ref": "#/components/schemas/checkout_link_payment_method_options"
    },
    "oxxo": {
      "$ref": "#/components/schemas/checkout_oxxo_payment_method_options"
    },
    "ideal": {
      "$ref": "#/components/schemas/checkout_ideal_payment_method_options"
    },
    "payco": {
      "$ref": "#/components/schemas/checkout_payco_payment_method_options"
    },
    "payto": {
      "$ref": "#/components/schemas/checkout_payto_payment_method_options"
    },
    "swish": {
      "$ref": "#/components/schemas/checkout_swish_payment_method_options"
    },
    "twint": {
      "$ref": "#/components/schemas/checkout_twint_payment_method_options"
    },
    "affirm": {
      "$ref": "#/components/schemas/checkout_affirm_payment_method_options"
    },
    "alipay": {
      "$ref": "#/components/schemas/checkout_alipay_payment_method_options"
    },
    "billie": {
      "$ref": "#/components/schemas/checkout_billie_payment_method_options"
    },
    "boleto": {
      "$ref": "#/components/schemas/checkout_boleto_payment_method_options"
    },
    "klarna": {
      "$ref": "#/components/schemas/checkout_klarna_payment_method_options"
    },
    "paynow": {
      "$ref": "#/components/schemas/checkout_paynow_payment_method_options"
    },
    "paypal": {
      "$ref": "#/components/schemas/checkout_paypal_payment_method_options"
    },
    "sofort": {
      "$ref": "#/components/schemas/checkout_sofort_payment_method_options"
    },
    "cashapp": {
      "$ref": "#/components/schemas/checkout_cashapp_payment_method_options"
    },
    "giropay": {
      "$ref": "#/components/schemas/checkout_giropay_payment_method_options"
    },
    "grabpay": {
      "$ref": "#/components/schemas/checkout_grab_pay_payment_method_options"
    },
    "konbini": {
      "$ref": "#/components/schemas/checkout_konbini_payment_method_options"
    },
    "kr_card": {
      "$ref": "#/components/schemas/checkout_kr_card_payment_method_options"
    },
    "satispay": {
      "$ref": "#/components/schemas/checkout_satispay_payment_method_options"
    },
    "kakao_pay": {
      "$ref": "#/components/schemas/checkout_kakao_pay_payment_method_options"
    },
    "mobilepay": {
      "$ref": "#/components/schemas/checkout_mobilepay_payment_method_options"
    },
    "naver_pay": {
      "$ref": "#/components/schemas/checkout_naver_pay_payment_method_options"
    },
    "acss_debit": {
      "$ref": "#/components/schemas/checkout_acss_debit_payment_method_options"
    },
    "amazon_pay": {
      "$ref": "#/components/schemas/checkout_amazon_pay_payment_method_options"
    },
    "bacs_debit": {
      "$ref": "#/components/schemas/checkout_bacs_debit_payment_method_options"
    },
    "bancontact": {
      "$ref": "#/components/schemas/checkout_bancontact_payment_method_options"
    },
    "multibanco": {
      "$ref": "#/components/schemas/checkout_multibanco_payment_method_options"
    },
    "sepa_debit": {
      "$ref": "#/components/schemas/checkout_sepa_debit_payment_method_options"
    },
    "revolut_pay": {
      "$ref": "#/components/schemas/checkout_revolut_pay_payment_method_options"
    },
    "samsung_pay": {
      "$ref": "#/components/schemas/checkout_samsung_pay_payment_method_options"
    },
    "au_becs_debit": {
      "$ref": "#/components/schemas/checkout_au_becs_debit_payment_method_options"
    },
    "us_bank_account": {
      "$ref": "#/components/schemas/checkout_us_bank_account_payment_method_options"
    },
    "customer_balance": {
      "$ref": "#/components/schemas/checkout_customer_balance_payment_method_options"
    },
    "afterpay_clearpay": {
      "$ref": "#/components/schemas/checkout_afterpay_clearpay_payment_method_options"
    }
  },
  "description": "",
  "x-expandableFields": [
    "acss_debit",
    "affirm",
    "afterpay_clearpay",
    "alipay",
    "alma",
    "amazon_pay",
    "au_becs_debit",
    "bacs_debit",
    "bancontact",
    "billie",
    "boleto",
    "card",
    "cashapp",
    "customer_balance",
    "eps",
    "fpx",
    "giropay",
    "grabpay",
    "ideal",
    "kakao_pay",
    "klarna",
    "konbini",
    "kr_card",
    "link",
    "mobilepay",
    "multibanco",
    "naver_pay",
    "oxxo",
    "p24",
    "payco",
    "paynow",
    "paypal",
    "payto",
    "pix",
    "revolut_pay",
    "samsung_pay",
    "satispay",
    "sepa_debit",
    "sofort",
    "swish",
    "twint",
    "upi",
    "us_bank_account"
  ]
}

object checkout_session_wallet_options

{
  "type": "object",
  "title": "CheckoutSessionWalletOptions",
  "properties": {
    "link": {
      "$ref": "#/components/schemas/checkout_link_wallet_options"
    }
  },
  "description": "",
  "x-expandableFields": [
    "link"
  ]
}

object checkout_sofort_payment_method_options

{
  "type": "object",
  "title": "CheckoutSofortPaymentMethodOptions",
  "properties": {
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_swish_payment_method_options

{
  "type": "object",
  "title": "CheckoutSwishPaymentMethodOptions",
  "properties": {
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_twint_payment_method_options

{
  "type": "object",
  "title": "CheckoutTwintPaymentMethodOptions",
  "properties": {
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": []
}

object checkout_upi_payment_method_options

{
  "type": "object",
  "title": "CheckoutUPIPaymentMethodOptions",
  "properties": {
    "mandate_options": {
      "$ref": "#/components/schemas/mandate_options_upi"
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session",
        "on_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": [
    "mandate_options"
  ]
}

object checkout_us_bank_account_payment_method_options

{
  "type": "object",
  "title": "CheckoutUsBankAccountPaymentMethodOptions",
  "properties": {
    "target_date": {
      "type": "string",
      "maxLength": 5000,
      "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now."
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session",
        "on_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    },
    "verification_method": {
      "enum": [
        "automatic",
        "instant"
      ],
      "type": "string",
      "description": "Bank account verification method. The default value is `automatic`.",
      "x-stripeBypassValidation": true
    },
    "financial_connections": {
      "$ref": "#/components/schemas/linked_account_options_common"
    }
  },
  "description": "",
  "x-expandableFields": [
    "financial_connections"
  ]
}

object climate.order

{
  "type": "object",
  "title": "ClimateRemovalsOrders",
  "required": [
    "amount_fees",
    "amount_subtotal",
    "amount_total",
    "created",
    "currency",
    "delivery_details",
    "expected_delivery_year",
    "id",
    "livemode",
    "metadata",
    "metric_tons",
    "object",
    "product",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "climate.order"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "awaiting_funds",
        "canceled",
        "confirmed",
        "delivered",
        "open"
      ],
      "type": "string",
      "description": "The current status of this order."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "product": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/climate.product"
        }
      ],
      "description": "Unique ID for the Climate `Product` this order is purchasing.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/climate.product"
          }
        ]
      }
    },
    "currency": {
      "type": "string",
      "maxLength": 5000,
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase, representing the currency for this order."
    },
    "livemode": {
      "type": "boolean",
      "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "delayed_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Time at which the order's expected_delivery_year was delayed. Measured in seconds since the Unix epoch."
    },
    "amount_fees": {
      "type": "integer",
      "description": "Total amount of [Frontier](https://frontierclimate.com/)'s service fees in the currency's smallest unit."
    },
    "beneficiary": {
      "$ref": "#/components/schemas/climate_removals_beneficiary"
    },
    "canceled_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Time at which the order was canceled. Measured in seconds since the Unix epoch."
    },
    "certificate": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "For delivered orders, a URL to a delivery certificate for the order."
    },
    "metric_tons": {
      "type": "string",
      "format": "decimal",
      "description": "Quantity of carbon removal that is included in this order."
    },
    "amount_total": {
      "type": "integer",
      "description": "Total amount of the order including fees in the currency's smallest unit."
    },
    "confirmed_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Time at which the order was confirmed. Measured in seconds since the Unix epoch."
    },
    "delivered_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Time at which the order was delivered. Measured in seconds since the Unix epoch."
    },
    "amount_subtotal": {
      "type": "integer",
      "description": "Total amount of the carbon removal in the currency's smallest unit."
    },
    "delivery_details": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/climate_removals_order_deliveries"
      },
      "description": "Details about the delivery of carbon removal for this order."
    },
    "cancellation_reason": {
      "enum": [
        "expired",
        "product_unavailable",
        "requested"
      ],
      "type": "string",
      "nullable": true,
      "description": "Reason for the cancellation of this order.",
      "x-stripeBypassValidation": true
    },
    "expected_delivery_year": {
      "type": "integer",
      "description": "The year this order is expected to be delivered."
    },
    "product_substituted_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Time at which the order's product was substituted for a different product. Measured in seconds since the Unix epoch."
    }
  },
  "description": "Orders represent your intent to purchase a particular Climate product. When you create an order, the\npayment is deducted from your merchant balance.",
  "x-resourceId": "climate.order",
  "x-expandableFields": [
    "beneficiary",
    "delivery_details",
    "product"
  ]
}

object climate.product

{
  "type": "object",
  "title": "ClimateRemovalsProducts",
  "required": [
    "created",
    "current_prices_per_metric_ton",
    "id",
    "livemode",
    "metric_tons_available",
    "name",
    "object",
    "suppliers"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object. For convenience, Climate product IDs are human-readable strings\nthat start with `climsku_`. See [carbon removal inventory](https://stripe.com/docs/climate/orders/carbon-removal-inventory)\nfor a list of available carbon removal products."
    },
    "name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The Climate product's name."
    },
    "object": {
      "enum": [
        "climate.product"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "livemode": {
      "type": "boolean",
      "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."
    },
    "suppliers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/climate.supplier"
      },
      "description": "The carbon removal suppliers that fulfill orders for this Climate product."
    },
    "delivery_year": {
      "type": "integer",
      "nullable": true,
      "description": "The year in which the carbon removal is expected to be delivered."
    },
    "metric_tons_available": {
      "type": "string",
      "format": "decimal",
      "description": "The quantity of metric tons available for reservation."
    },
    "current_prices_per_metric_ton": {
      "type": "object",
      "description": "Current prices for a metric ton of carbon removal in a currency's smallest unit.",
      "additionalProperties": {
        "$ref": "#/components/schemas/climate_removals_products_price"
      }
    }
  },
  "description": "A Climate product represents a type of carbon removal unit available for reservation.\nYou can retrieve it to see the current price and availability.",
  "x-resourceId": "climate.product",
  "x-expandableFields": [
    "current_prices_per_metric_ton",
    "suppliers"
  ]
}

object climate.supplier

{
  "type": "object",
  "title": "ClimateRemovalsSuppliers",
  "required": [
    "id",
    "info_url",
    "livemode",
    "locations",
    "name",
    "object",
    "removal_pathway"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "name": {
      "type": "string",
      "maxLength": 5000,
      "description": "Name of this carbon removal supplier."
    },
    "object": {
      "enum": [
        "climate.supplier"
      ],
      "type": "string",
      "description": "String representing the object’s type. Objects of the same type share the same value."
    },
    "info_url": {
      "type": "string",
      "maxLength": 5000,
      "description": "Link to a webpage to learn more about the supplier."
    },
    "livemode": {
      "type": "boolean",
      "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."
    },
    "locations": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/climate_removals_location"
      },
      "description": "The locations in which this supplier operates."
    },
    "removal_pathway": {
      "enum": [
        "biomass_carbon_removal_and_storage",
        "direct_air_capture",
        "enhanced_weathering",
        "marine_carbon_removal"
      ],
      "type": "string",
      "description": "The scientific pathway used for carbon removal.",
      "x-stripeBypassValidation": true
    }
  },
  "description": "A supplier of carbon removal.",
  "x-resourceId": "climate.supplier",
  "x-expandableFields": [
    "locations"
  ]
}

object climate_removals_beneficiary

{
  "type": "object",
  "title": "ClimateRemovalsBeneficiary",
  "required": [
    "public_name"
  ],
  "properties": {
    "public_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "Publicly displayable name for the end beneficiary of carbon removal."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object climate_removals_location

{
  "type": "object",
  "title": "ClimateRemovalsLocation",
  "required": [
    "country"
  ],
  "properties": {
    "city": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The city where the supplier is located."
    },
    "region": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The state/county/province/region where the supplier is located."
    },
    "country": {
      "type": "string",
      "maxLength": 5000,
      "description": "Two-letter ISO code representing the country where the supplier is located."
    },
    "latitude": {
      "type": "number",
      "nullable": true,
      "description": "The geographic latitude where the supplier is located."
    },
    "longitude": {
      "type": "number",
      "nullable": true,
      "description": "The geographic longitude where the supplier is located."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object climate_removals_order_deliveries

{
  "type": "object",
  "title": "ClimateRemovalsOrderDeliveries",
  "required": [
    "delivered_at",
    "metric_tons",
    "supplier"
  ],
  "properties": {
    "location": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/climate_removals_location"
        }
      ],
      "nullable": true,
      "description": "Specific location of this delivery."
    },
    "supplier": {
      "$ref": "#/components/schemas/climate.supplier"
    },
    "metric_tons": {
      "type": "string",
      "maxLength": 5000,
      "description": "Quantity of carbon removal supplied by this delivery."
    },
    "delivered_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the delivery occurred. Measured in seconds since the Unix epoch."
    },
    "registry_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Once retired, a URL to the registry entry for the tons from this delivery."
    }
  },
  "description": "The delivery of a specified quantity of carbon for an order.",
  "x-expandableFields": [
    "location",
    "supplier"
  ]
}

object climate_removals_products_price

{
  "type": "object",
  "title": "ClimateRemovalsProductsPrice",
  "required": [
    "amount_fees",
    "amount_subtotal",
    "amount_total"
  ],
  "properties": {
    "amount_fees": {
      "type": "integer",
      "description": "Fees for one metric ton of carbon removal in the currency's smallest unit."
    },
    "amount_total": {
      "type": "integer",
      "description": "Total for one metric ton of carbon removal (including fees) in the currency's smallest unit."
    },
    "amount_subtotal": {
      "type": "integer",
      "description": "Subtotal for one metric ton of carbon removal (excluding fees) in the currency's smallest unit."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object confirmation_token

{
  "type": "object",
  "title": "ConfirmationTokensResourceConfirmationToken",
  "required": [
    "created",
    "id",
    "livemode",
    "object",
    "use_stripe_sdk"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "confirmation_token"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "shipping": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/confirmation_tokens_resource_shipping"
        }
      ],
      "nullable": true,
      "description": "Shipping information collected on this ConfirmationToken."
    },
    "expires_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent."
    },
    "return_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Return URL used to confirm the Intent."
    },
    "mandate_data": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/confirmation_tokens_resource_mandate_data"
        }
      ],
      "nullable": true,
      "description": "Data used for generating a Mandate."
    },
    "setup_intent": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used."
    },
    "payment_intent": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used."
    },
    "use_stripe_sdk": {
      "type": "boolean",
      "description": "Indicates whether the Stripe SDK is used to handle confirmation flow. Defaults to `true` on ConfirmationToken."
    },
    "setup_future_usage": {
      "enum": [
        "off_session",
        "on_session"
      ],
      "type": "string",
      "nullable": true,
      "description": "Indicates that you intend to make future payments with this ConfirmationToken's payment method.\n\nThe presence of this property will [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete."
    },
    "payment_method_options": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/confirmation_tokens_resource_payment_method_options"
        }
      ],
      "nullable": true,
      "description": "Payment-method-specific configuration for this ConfirmationToken."
    },
    "payment_method_preview": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/confirmation_tokens_resource_payment_method_preview"
        }
      ],
      "nullable": true,
      "description": "Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken."
    }
  },
  "description": "ConfirmationTokens help transport client side data collected by Stripe JS over\nto your server for confirming a PaymentIntent or SetupIntent. If the confirmation\nis successful, values present on the ConfirmationToken are written onto the Intent.\n\nTo learn more about how to use ConfirmationToken, visit the related guides:\n- [Finalize payments on the server](https://docs.stripe.com/payments/finalize-payments-on-the-server)\n- [Build two-step confirmation](https://docs.stripe.com/payments/build-a-two-step-confirmation).",
  "x-resourceId": "confirmation_token",
  "x-expandableFields": [
    "mandate_data",
    "payment_method_options",
    "payment_method_preview",
    "shipping"
  ]
}

object confirmation_tokens_resource_mandate_data

{
  "type": "object",
  "title": "ConfirmationTokensResourceMandateData",
  "required": [
    "customer_acceptance"
  ],
  "properties": {
    "customer_acceptance": {
      "$ref": "#/components/schemas/confirmation_tokens_resource_mandate_data_resource_customer_acceptance"
    }
  },
  "description": "Data used for generating a Mandate.",
  "x-expandableFields": [
    "customer_acceptance"
  ]
}

object confirmation_tokens_resource_mandate_data_resource_customer_acceptance

{
  "type": "object",
  "title": "ConfirmationTokensResourceMandateDataResourceCustomerAcceptance",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "type": "string",
      "maxLength": 5000,
      "description": "The type of customer acceptance information included with the Mandate."
    },
    "online": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_online"
        }
      ],
      "nullable": true,
      "description": "If this is a Mandate accepted online, this hash contains details about the online acceptance."
    }
  },
  "description": "This hash contains details about the customer acceptance of the Mandate.",
  "x-expandableFields": [
    "online"
  ]
}

object confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_online

{
  "type": "object",
  "title": "ConfirmationTokensResourceMandateDataResourceCustomerAcceptanceResourceOnline",
  "properties": {
    "ip_address": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The IP address from which the Mandate was accepted by the customer."
    },
    "user_agent": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The user agent of the browser from which the Mandate was accepted by the customer."
    }
  },
  "description": "This hash contains details about the online acceptance.",
  "x-expandableFields": []
}

object confirmation_tokens_resource_payment_method_options

{
  "type": "object",
  "title": "ConfirmationTokensResourcePaymentMethodOptions",
  "properties": {
    "card": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/confirmation_tokens_resource_payment_method_options_resource_card"
        }
      ],
      "nullable": true,
      "description": "This hash contains the card payment method options."
    }
  },
  "description": "Payment-method-specific configuration",
  "x-expandableFields": [
    "card"
  ]
}

object confirmation_tokens_resource_payment_method_options_resource_card

{
  "type": "object",
  "title": "ConfirmationTokensResourcePaymentMethodOptionsResourceCard",
  "properties": {
    "cvc_token": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The `cvc_update` Token collected from the Payment Element."
    },
    "installments": {
      "$ref": "#/components/schemas/confirmation_tokens_resource_payment_method_options_resource_card_resource_installment"
    }
  },
  "description": "This hash contains the card payment method options.",
  "x-expandableFields": [
    "installments"
  ]
}

object confirmation_tokens_resource_payment_method_options_resource_card_resource_installment

{
  "type": "object",
  "title": "ConfirmationTokensResourcePaymentMethodOptionsResourceCardResourceInstallment",
  "properties": {
    "plan": {
      "$ref": "#/components/schemas/payment_method_details_card_installments_plan"
    }
  },
  "description": "Installment configuration for payments.",
  "x-expandableFields": [
    "plan"
  ]
}

object confirmation_tokens_resource_payment_method_preview

{
  "type": "object",
  "title": "ConfirmationTokensResourcePaymentMethodPreview",
  "required": [
    "billing_details",
    "type"
  ],
  "properties": {
    "eps": {
      "$ref": "#/components/schemas/payment_method_eps"
    },
    "fpx": {
      "$ref": "#/components/schemas/payment_method_fpx"
    },
    "p24": {
      "$ref": "#/components/schemas/payment_method_p24"
    },
    "pix": {
      "$ref": "#/components/schemas/payment_method_pix"
    },
    "upi": {
      "$ref": "#/components/schemas/payment_method_upi"
    },
    "zip": {
      "$ref": "#/components/schemas/payment_method_zip"
    },
    "alma": {
      "$ref": "#/components/schemas/payment_method_alma"
    },
    "blik": {
      "$ref": "#/components/schemas/payment_method_blik"
    },
    "card": {
      "$ref": "#/components/schemas/payment_method_card"
    },
    "link": {
      "$ref": "#/components/schemas/payment_method_link"
    },
    "oxxo": {
      "$ref": "#/components/schemas/payment_method_oxxo"
    },
    "type": {
      "enum": [
        "acss_debit",
        "affirm",
        "afterpay_clearpay",
        "alipay",
        "alma",
        "amazon_pay",
        "au_becs_debit",
        "bacs_debit",
        "bancontact",
        "billie",
        "blik",
        "boleto",
        "card",
        "card_present",
        "cashapp",
        "crypto",
        "custom",
        "customer_balance",
        "eps",
        "fpx",
        "giropay",
        "grabpay",
        "ideal",
        "interac_present",
        "kakao_pay",
        "klarna",
        "konbini",
        "kr_card",
        "link",
        "mb_way",
        "mobilepay",
        "multibanco",
        "naver_pay",
        "nz_bank_account",
        "oxxo",
        "p24",
        "pay_by_bank",
        "payco",
        "paynow",
        "paypal",
        "payto",
        "pix",
        "promptpay",
        "revolut_pay",
        "samsung_pay",
        "satispay",
        "sepa_debit",
        "sofort",
        "swish",
        "twint",
        "upi",
        "us_bank_account",
        "wechat_pay",
        "zip"
      ],
      "type": "string",
      "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.",
      "x-stripeBypassValidation": true
    },
    "ideal": {
      "$ref": "#/components/schemas/payment_method_ideal"
    },
    "payco": {
      "$ref": "#/components/schemas/payment_method_payco"
    },
    "payto": {
      "$ref": "#/components/schemas/payment_method_payto"
    },
    "swish": {
      "$ref": "#/components/schemas/payment_method_swish"
    },
    "twint": {
      "$ref": "#/components/schemas/payment_method_twint"
    },
    "affirm": {
      "$ref": "#/components/schemas/payment_method_affirm"
    },
    "alipay": {
      "$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay"
    },
    "billie": {
      "$ref": "#/components/schemas/payment_method_billie"
    },
    "boleto": {
      "$ref": "#/components/schemas/payment_method_boleto"
    },
    "crypto": {
      "$ref": "#/components/schemas/payment_method_crypto"
    },
    "klarna": {
      "$ref": "#/components/schemas/payment_method_klarna"
    },
    "mb_way": {
      "$ref": "#/components/schemas/payment_method_mb_way"
    },
    "paynow": {
      "$ref": "#/components/schemas/payment_method_paynow"
    },
    "paypal": {
      "$ref": "#/components/schemas/payment_method_paypal"
    },
    "sofort": {
      "$ref": "#/components/schemas/payment_method_sofort"
    },
    "cashapp": {
      "$ref": "#/components/schemas/payment_method_cashapp"
    },
    "giropay": {
      "$ref": "#/components/schemas/payment_method_giropay"
    },
    "grabpay": {
      "$ref": "#/components/schemas/payment_method_grabpay"
    },
    "konbini": {
      "$ref": "#/components/schemas/payment_method_konbini"
    },
    "kr_card": {
      "$ref": "#/components/schemas/payment_method_kr_card"
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        }
      ],
      "nullable": true,
      "description": "The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          }
        ]
      }
    },
    "satispay": {
      "$ref": "#/components/schemas/payment_method_satispay"
    },
    "kakao_pay": {
      "$ref": "#/components/schemas/payment_method_kakao_pay"
    },
    "mobilepay": {
      "$ref": "#/components/schemas/payment_method_mobilepay"
    },
    "naver_pay": {
      "$ref": "#/components/schemas/payment_method_naver_pay"
    },
    "promptpay": {
      "$ref": "#/components/schemas/payment_method_promptpay"
    },
    "acss_debit": {
      "$ref": "#/components/schemas/payment_method_acss_debit"
    },
    "amazon_pay": {
      "$ref": "#/components/schemas/payment_method_amazon_pay"
    },
    "bacs_debit": {
      "$ref": "#/components/schemas/payment_method_bacs_debit"
    },
    "bancontact": {
      "$ref": "#/components/schemas/payment_method_bancontact"
    },
    "multibanco": {
      "$ref": "#/components/schemas/payment_method_multibanco"
    },
    "sepa_debit": {
      "$ref": "#/components/schemas/payment_method_sepa_debit"
    },
    "wechat_pay": {
      "$ref": "#/components/schemas/payment_method_wechat_pay"
    },
    "pay_by_bank": {
      "$ref": "#/components/schemas/payment_method_pay_by_bank"
    },
    "revolut_pay": {
      "$ref": "#/components/schemas/payment_method_revolut_pay"
    },
    "samsung_pay": {
      "$ref": "#/components/schemas/payment_method_samsung_pay"
    },
    "card_present": {
      "$ref": "#/components/schemas/payment_method_card_present"
    },
    "au_becs_debit": {
      "$ref": "#/components/schemas/payment_method_au_becs_debit"
    },
    "allow_redisplay": {
      "enum": [
        "always",
        "limited",
        "unspecified"
      ],
      "type": "string",
      "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”."
    },
    "billing_details": {
      "$ref": "#/components/schemas/billing_details"
    },
    "interac_present": {
      "$ref": "#/components/schemas/payment_method_interac_present"
    },
    "nz_bank_account": {
      "$ref": "#/components/schemas/payment_method_nz_bank_account"
    },
    "us_bank_account": {
      "$ref": "#/components/schemas/payment_method_us_bank_account"
    },
    "customer_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000
    },
    "customer_balance": {
      "$ref": "#/components/schemas/payment_method_customer_balance"
    },
    "afterpay_clearpay": {
      "$ref": "#/components/schemas/payment_method_afterpay_clearpay"
    }
  },
  "description": "Details of the PaymentMethod collected by Payment Element",
  "x-expandableFields": [
    "acss_debit",
    "affirm",
    "afterpay_clearpay",
    "alipay",
    "alma",
    "amazon_pay",
    "au_becs_debit",
    "bacs_debit",
    "bancontact",
    "billie",
    "billing_details",
    "blik",
    "boleto",
    "card",
    "card_present",
    "cashapp",
    "crypto",
    "customer",
    "customer_balance",
    "eps",
    "fpx",
    "giropay",
    "grabpay",
    "ideal",
    "interac_present",
    "kakao_pay",
    "klarna",
    "konbini",
    "kr_card",
    "link",
    "mb_way",
    "mobilepay",
    "multibanco",
    "naver_pay",
    "nz_bank_account",
    "oxxo",
    "p24",
    "pay_by_bank",
    "payco",
    "paynow",
    "paypal",
    "payto",
    "pix",
    "promptpay",
    "revolut_pay",
    "samsung_pay",
    "satispay",
    "sepa_debit",
    "sofort",
    "swish",
    "twint",
    "upi",
    "us_bank_account",
    "wechat_pay",
    "zip"
  ]
}

object confirmation_tokens_resource_shipping

{
  "type": "object",
  "title": "ConfirmationTokensResourceShipping",
  "required": [
    "address",
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 5000,
      "description": "Recipient name."
    },
    "phone": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Recipient phone (including extension)."
    },
    "address": {
      "$ref": "#/components/schemas/address"
    }
  },
  "description": "",
  "x-expandableFields": [
    "address"
  ]
}

object connect_account_reference

{
  "type": "object",
  "title": "ConnectAccountReference",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "account",
        "self"
      ],
      "type": "string",
      "description": "Type of the account referenced.",
      "x-stripeBypassValidation": true
    },
    "account": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/account"
        }
      ],
      "description": "The connected account being referenced when `type` is `account`.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/account"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "account"
  ]
}

object connect_collection_transfer

{
  "type": "object",
  "title": "ConnectCollectionTransfer",
  "required": [
    "amount",
    "currency",
    "destination",
    "id",
    "livemode",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "amount": {
      "type": "integer",
      "description": "Amount transferred, in cents (or local equivalent)."
    },
    "object": {
      "enum": [
        "connect_collection_transfer"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "destination": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/account"
        }
      ],
      "description": "ID of the account that funds are being collected for.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/account"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "destination"
  ]
}

object connect_embedded_account_config_claim

{
  "type": "object",
  "title": "ConnectEmbeddedAccountConfigClaim",
  "required": [
    "enabled",
    "features"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Whether the embedded component is enabled."
    },
    "features": {
      "$ref": "#/components/schemas/connect_embedded_account_features_claim"
    }
  },
  "description": "",
  "x-expandableFields": [
    "features"
  ]
}

object connect_embedded_account_features_claim

{
  "type": "object",
  "title": "ConnectEmbeddedAccountFeaturesClaim",
  "required": [
    "disable_stripe_user_authentication",
    "external_account_collection"
  ],
  "properties": {
    "external_account_collection": {
      "type": "boolean",
      "description": "Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`."
    },
    "disable_stripe_user_authentication": {
      "type": "boolean",
      "description": "Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object connect_embedded_account_session_create_components

{
  "type": "object",
  "title": "ConnectEmbeddedAccountSessionCreateComponents",
  "required": [
    "account_management",
    "account_onboarding",
    "balances",
    "disputes_list",
    "documents",
    "financial_account",
    "financial_account_transactions",
    "instant_payouts_promotion",
    "issuing_card",
    "issuing_cards_list",
    "notification_banner",
    "payment_details",
    "payment_disputes",
    "payments",
    "payout_details",
    "payouts",
    "payouts_list",
    "tax_registrations",
    "tax_settings"
  ],
  "properties": {
    "payouts": {
      "$ref": "#/components/schemas/connect_embedded_payouts_config"
    },
    "balances": {
      "$ref": "#/components/schemas/connect_embedded_payouts_config"
    },
    "payments": {
      "$ref": "#/components/schemas/connect_embedded_payments_config_claim"
    },
    "documents": {
      "$ref": "#/components/schemas/connect_embedded_base_config_claim"
    },
    "issuing_card": {
      "$ref": "#/components/schemas/connect_embedded_issuing_card_config_claim"
    },
    "payouts_list": {
      "$ref": "#/components/schemas/connect_embedded_base_config_claim"
    },
    "tax_settings": {
      "$ref": "#/components/schemas/connect_embedded_base_config_claim"
    },
    "disputes_list": {
      "$ref": "#/components/schemas/connect_embedded_disputes_list_config"
    },
    "payout_details": {
      "$ref": "#/components/schemas/connect_embedded_base_config_claim"
    },
    "payment_details": {
      "$ref": "#/components/schemas/connect_embedded_payments_config_claim"
    },
    "payment_disputes": {
      "$ref": "#/components/schemas/connect_embedded_payment_disputes_config"
    },
    "financial_account": {
      "$ref": "#/components/schemas/connect_embedded_financial_account_config_claim"
    },
    "tax_registrations": {
      "$ref": "#/components/schemas/connect_embedded_base_config_claim"
    },
    "account_management": {
      "$ref": "#/components/schemas/connect_embedded_account_config_claim"
    },
    "account_onboarding": {
      "$ref": "#/components/schemas/connect_embedded_account_config_claim"
    },
    "issuing_cards_list": {
      "$ref": "#/components/schemas/connect_embedded_issuing_cards_list_config_claim"
    },
    "notification_banner": {
      "$ref": "#/components/schemas/connect_embedded_account_config_claim"
    },
    "instant_payouts_promotion": {
      "$ref": "#/components/schemas/connect_embedded_instant_payouts_promotion_config"
    },
    "financial_account_transactions": {
      "$ref": "#/components/schemas/connect_embedded_financial_account_transactions_config_claim"
    }
  },
  "description": "",
  "x-expandableFields": [
    "account_management",
    "account_onboarding",
    "balances",
    "disputes_list",
    "documents",
    "financial_account",
    "financial_account_transactions",
    "instant_payouts_promotion",
    "issuing_card",
    "issuing_cards_list",
    "notification_banner",
    "payment_details",
    "payment_disputes",
    "payments",
    "payout_details",
    "payouts",
    "payouts_list",
    "tax_registrations",
    "tax_settings"
  ]
}

object connect_embedded_base_config_claim

{
  "type": "object",
  "title": "ConnectEmbeddedBaseConfigClaim",
  "required": [
    "enabled",
    "features"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Whether the embedded component is enabled."
    },
    "features": {
      "$ref": "#/components/schemas/connect_embedded_base_features"
    }
  },
  "description": "",
  "x-expandableFields": [
    "features"
  ]
}

object connect_embedded_base_features

{
  "type": "object",
  "title": "ConnectEmbeddedBaseFeatures",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object connect_embedded_disputes_list_config

{
  "type": "object",
  "title": "ConnectEmbeddedDisputesListConfig",
  "required": [
    "enabled",
    "features"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Whether the embedded component is enabled."
    },
    "features": {
      "$ref": "#/components/schemas/connect_embedded_disputes_list_features"
    }
  },
  "description": "",
  "x-expandableFields": [
    "features"
  ]
}

object connect_embedded_disputes_list_features

{
  "type": "object",
  "title": "ConnectEmbeddedDisputesListFeatures",
  "required": [
    "capture_payments",
    "destination_on_behalf_of_charge_management",
    "dispute_management",
    "refund_management"
  ],
  "properties": {
    "capture_payments": {
      "type": "boolean",
      "description": "Whether to allow capturing and cancelling payment intents. This is `true` by default."
    },
    "refund_management": {
      "type": "boolean",
      "description": "Whether sending refunds is enabled. This is `true` by default."
    },
    "dispute_management": {
      "type": "boolean",
      "description": "Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default."
    },
    "destination_on_behalf_of_charge_management": {
      "type": "boolean",
      "description": "Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object connect_embedded_financial_account_config_claim

{
  "type": "object",
  "title": "ConnectEmbeddedFinancialAccountConfigClaim",
  "required": [
    "enabled",
    "features"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Whether the embedded component is enabled."
    },
    "features": {
      "$ref": "#/components/schemas/connect_embedded_financial_account_features"
    }
  },
  "description": "",
  "x-expandableFields": [
    "features"
  ]
}

object connect_embedded_financial_account_features

{
  "type": "object",
  "title": "ConnectEmbeddedFinancialAccountFeatures",
  "required": [
    "disable_stripe_user_authentication",
    "external_account_collection",
    "send_money",
    "transfer_balance"
  ],
  "properties": {
    "send_money": {
      "type": "boolean",
      "description": "Whether to allow sending money."
    },
    "transfer_balance": {
      "type": "boolean",
      "description": "Whether to allow transferring balance."
    },
    "external_account_collection": {
      "type": "boolean",
      "description": "Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`."
    },
    "disable_stripe_user_authentication": {
      "type": "boolean",
      "description": "Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object connect_embedded_financial_account_transactions_config_claim

{
  "type": "object",
  "title": "ConnectEmbeddedFinancialAccountTransactionsConfigClaim",
  "required": [
    "enabled",
    "features"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Whether the embedded component is enabled."
    },
    "features": {
      "$ref": "#/components/schemas/connect_embedded_financial_account_transactions_features"
    }
  },
  "description": "",
  "x-expandableFields": [
    "features"
  ]
}

object connect_embedded_financial_account_transactions_features

{
  "type": "object",
  "title": "ConnectEmbeddedFinancialAccountTransactionsFeatures",
  "required": [
    "card_spend_dispute_management"
  ],
  "properties": {
    "card_spend_dispute_management": {
      "type": "boolean",
      "description": "Whether to allow card spend dispute management features."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object connect_embedded_instant_payouts_promotion_config

{
  "type": "object",
  "title": "ConnectEmbeddedInstantPayoutsPromotionConfig",
  "required": [
    "enabled",
    "features"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Whether the embedded component is enabled."
    },
    "features": {
      "$ref": "#/components/schemas/connect_embedded_instant_payouts_promotion_features"
    }
  },
  "description": "",
  "x-expandableFields": [
    "features"
  ]
}

object connect_embedded_instant_payouts_promotion_features

{
  "type": "object",
  "title": "ConnectEmbeddedInstantPayoutsPromotionFeatures",
  "required": [
    "disable_stripe_user_authentication",
    "external_account_collection",
    "instant_payouts"
  ],
  "properties": {
    "instant_payouts": {
      "type": "boolean",
      "description": "Whether to allow creation of instant payouts. The default value is `enabled` when Stripe is responsible for negative account balances, and `use_dashboard_rules` otherwise."
    },
    "external_account_collection": {
      "type": "boolean",
      "description": "Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`."
    },
    "disable_stripe_user_authentication": {
      "type": "boolean",
      "description": "Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object connect_embedded_issuing_card_config_claim

{
  "type": "object",
  "title": "ConnectEmbeddedIssuingCardConfigClaim",
  "required": [
    "enabled",
    "features"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Whether the embedded component is enabled."
    },
    "features": {
      "$ref": "#/components/schemas/connect_embedded_issuing_card_features"
    }
  },
  "description": "",
  "x-expandableFields": [
    "features"
  ]
}

object connect_embedded_issuing_card_features

{
  "type": "object",
  "title": "ConnectEmbeddedIssuingCardFeatures",
  "required": [
    "card_management",
    "card_spend_dispute_management",
    "cardholder_management",
    "spend_control_management"
  ],
  "properties": {
    "card_management": {
      "type": "boolean",
      "description": "Whether to allow card management features."
    },
    "cardholder_management": {
      "type": "boolean",
      "description": "Whether to allow cardholder management features."
    },
    "spend_control_management": {
      "type": "boolean",
      "description": "Whether to allow spend control management features."
    },
    "card_spend_dispute_management": {
      "type": "boolean",
      "description": "Whether to allow card spend dispute management features."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object connect_embedded_issuing_cards_list_config_claim

{
  "type": "object",
  "title": "ConnectEmbeddedIssuingCardsListConfigClaim",
  "required": [
    "enabled",
    "features"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Whether the embedded component is enabled."
    },
    "features": {
      "$ref": "#/components/schemas/connect_embedded_issuing_cards_list_features"
    }
  },
  "description": "",
  "x-expandableFields": [
    "features"
  ]
}

object connect_embedded_issuing_cards_list_features

{
  "type": "object",
  "title": "ConnectEmbeddedIssuingCardsListFeatures",
  "required": [
    "card_management",
    "card_spend_dispute_management",
    "cardholder_management",
    "disable_stripe_user_authentication",
    "spend_control_management"
  ],
  "properties": {
    "card_management": {
      "type": "boolean",
      "description": "Whether to allow card management features."
    },
    "cardholder_management": {
      "type": "boolean",
      "description": "Whether to allow cardholder management features."
    },
    "spend_control_management": {
      "type": "boolean",
      "description": "Whether to allow spend control management features."
    },
    "card_spend_dispute_management": {
      "type": "boolean",
      "description": "Whether to allow card spend dispute management features."
    },
    "disable_stripe_user_authentication": {
      "type": "boolean",
      "description": "Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object connect_embedded_payment_disputes_config

{
  "type": "object",
  "title": "ConnectEmbeddedPaymentDisputesConfig",
  "required": [
    "enabled",
    "features"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Whether the embedded component is enabled."
    },
    "features": {
      "$ref": "#/components/schemas/connect_embedded_payment_disputes_features"
    }
  },
  "description": "",
  "x-expandableFields": [
    "features"
  ]
}

object connect_embedded_payment_disputes_features

{
  "type": "object",
  "title": "ConnectEmbeddedPaymentDisputesFeatures",
  "required": [
    "destination_on_behalf_of_charge_management",
    "dispute_management",
    "refund_management"
  ],
  "properties": {
    "refund_management": {
      "type": "boolean",
      "description": "Whether sending refunds is enabled. This is `true` by default."
    },
    "dispute_management": {
      "type": "boolean",
      "description": "Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default."
    },
    "destination_on_behalf_of_charge_management": {
      "type": "boolean",
      "description": "Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object connect_embedded_payments_config_claim

{
  "type": "object",
  "title": "ConnectEmbeddedPaymentsConfigClaim",
  "required": [
    "enabled",
    "features"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Whether the embedded component is enabled."
    },
    "features": {
      "$ref": "#/components/schemas/connect_embedded_payments_features"
    }
  },
  "description": "",
  "x-expandableFields": [
    "features"
  ]
}

object connect_embedded_payments_features

{
  "type": "object",
  "title": "ConnectEmbeddedPaymentsFeatures",
  "required": [
    "capture_payments",
    "destination_on_behalf_of_charge_management",
    "dispute_management",
    "refund_management"
  ],
  "properties": {
    "capture_payments": {
      "type": "boolean",
      "description": "Whether to allow capturing and cancelling payment intents. This is `true` by default."
    },
    "refund_management": {
      "type": "boolean",
      "description": "Whether sending refunds is enabled. This is `true` by default."
    },
    "dispute_management": {
      "type": "boolean",
      "description": "Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default."
    },
    "destination_on_behalf_of_charge_management": {
      "type": "boolean",
      "description": "Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object connect_embedded_payouts_config

{
  "type": "object",
  "title": "ConnectEmbeddedPayoutsConfig",
  "required": [
    "enabled",
    "features"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Whether the embedded component is enabled."
    },
    "features": {
      "$ref": "#/components/schemas/connect_embedded_payouts_features"
    }
  },
  "description": "",
  "x-expandableFields": [
    "features"
  ]
}

object connect_embedded_payouts_features

{
  "type": "object",
  "title": "ConnectEmbeddedPayoutsFeatures",
  "required": [
    "disable_stripe_user_authentication",
    "edit_payout_schedule",
    "external_account_collection",
    "instant_payouts",
    "standard_payouts"
  ],
  "properties": {
    "instant_payouts": {
      "type": "boolean",
      "description": "Whether to allow creation of instant payouts. The default value is `enabled` when Stripe is responsible for negative account balances, and `use_dashboard_rules` otherwise."
    },
    "standard_payouts": {
      "type": "boolean",
      "description": "Whether to allow creation of standard payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`."
    },
    "edit_payout_schedule": {
      "type": "boolean",
      "description": "Whether to allow payout schedule to be changed. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`."
    },
    "external_account_collection": {
      "type": "boolean",
      "description": "Whether external account collection is enabled. This feature can only be `false` for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`."
    },
    "disable_stripe_user_authentication": {
      "type": "boolean",
      "description": "Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object country_spec

{
  "type": "object",
  "title": "CountrySpec",
  "required": [
    "default_currency",
    "id",
    "object",
    "supported_bank_account_currencies",
    "supported_payment_currencies",
    "supported_payment_methods",
    "supported_transfer_countries",
    "verification_fields"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object. Represented as the ISO country code for this country."
    },
    "object": {
      "enum": [
        "country_spec"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "default_currency": {
      "type": "string",
      "maxLength": 5000,
      "description": "The default currency for this country. This applies to both payment methods and bank accounts."
    },
    "verification_fields": {
      "$ref": "#/components/schemas/country_spec_verification_fields"
    },
    "supported_payment_methods": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Payment methods available in the specified country. You may need to enable some payment methods (e.g., [ACH](https://stripe.com/docs/ach)) on your account before they appear in this list. The `stripe` payment method refers to [charging through your platform](https://stripe.com/docs/connect/destination-charges)."
    },
    "supported_payment_currencies": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Currencies that can be accepted in the specified country (for payments)."
    },
    "supported_transfer_countries": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Countries that can accept transfers from the specified country."
    },
    "supported_bank_account_currencies": {
      "type": "object",
      "description": "Currencies that can be accepted in the specific country (for transfers).",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string",
          "maxLength": 5000
        }
      }
    }
  },
  "description": "Stripe needs to collect certain pieces of information about each account\ncreated. These requirements can differ depending on the account's country. The\nCountry Specs API makes these rules available to your integration.\n\nYou can also view the information from this API call as [an online\nguide](/docs/connect/required-verification-information).",
  "x-resourceId": "country_spec",
  "x-expandableFields": [
    "verification_fields"
  ]
}

object country_spec_verification_field_details

{
  "type": "object",
  "title": "CountrySpecVerificationFieldDetails",
  "required": [
    "additional",
    "minimum"
  ],
  "properties": {
    "minimum": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Fields which every account must eventually provide."
    },
    "additional": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Additional fields which are only required for some users."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object country_spec_verification_fields

{
  "type": "object",
  "title": "CountrySpecVerificationFields",
  "required": [
    "company",
    "individual"
  ],
  "properties": {
    "company": {
      "$ref": "#/components/schemas/country_spec_verification_field_details"
    },
    "individual": {
      "$ref": "#/components/schemas/country_spec_verification_field_details"
    }
  },
  "description": "",
  "x-expandableFields": [
    "company",
    "individual"
  ]
}

object coupon

{
  "type": "object",
  "title": "Coupon",
  "required": [
    "created",
    "duration",
    "id",
    "livemode",
    "object",
    "times_redeemed",
    "valid"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Name of the coupon displayed to customers on for instance invoices or receipts."
    },
    "valid": {
      "type": "boolean",
      "description": "Taking account of the above properties, whether this coupon can still be applied to a customer."
    },
    "object": {
      "enum": [
        "coupon"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "nullable": true,
      "description": "If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off."
    },
    "duration": {
      "enum": [
        "forever",
        "once",
        "repeating"
      ],
      "type": "string",
      "description": "One of `forever`, `once`, or `repeating`. Describes how long a customer who applies this coupon will get the discount.",
      "x-stripeBypassValidation": true
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "redeem_by": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Date after which the coupon can no longer be redeemed."
    },
    "amount_off": {
      "type": "integer",
      "nullable": true,
      "description": "Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer."
    },
    "applies_to": {
      "$ref": "#/components/schemas/coupon_applies_to"
    },
    "percent_off": {
      "type": "number",
      "nullable": true,
      "description": "Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead."
    },
    "times_redeemed": {
      "type": "integer",
      "description": "Number of times this coupon has been applied to a customer."
    },
    "max_redemptions": {
      "type": "integer",
      "nullable": true,
      "description": "Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid."
    },
    "currency_options": {
      "type": "object",
      "description": "Coupons defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).",
      "additionalProperties": {
        "$ref": "#/components/schemas/coupon_currency_option"
      }
    },
    "duration_in_months": {
      "type": "integer",
      "nullable": true,
      "description": "If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`."
    }
  },
  "description": "A coupon contains information about a percent-off or amount-off discount you\nmight want to apply to a customer. Coupons may be applied to [subscriptions](https://api.stripe.com#subscriptions), [invoices](https://api.stripe.com#invoices),\n[checkout sessions](https://docs.stripe.com/api/checkout/sessions), [quotes](https://api.stripe.com#quotes), and more. Coupons do not work with conventional one-off [charges](/api/charges/create) or [payment intents](https://docs.stripe.com/api/payment_intents).",
  "x-resourceId": "coupon",
  "x-expandableFields": [
    "applies_to",
    "currency_options"
  ]
}

object coupon_applies_to

{
  "type": "object",
  "title": "CouponAppliesTo",
  "required": [
    "products"
  ],
  "properties": {
    "products": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "A list of product IDs this coupon applies to"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object coupon_currency_option

{
  "type": "object",
  "title": "CouponCurrencyOption",
  "required": [
    "amount_off"
  ],
  "properties": {
    "amount_off": {
      "type": "integer",
      "description": "Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object credit_balance

{
  "type": "object",
  "title": "CreditBalance",
  "required": [
    "available_balance",
    "ledger_balance"
  ],
  "properties": {
    "ledger_balance": {
      "$ref": "#/components/schemas/billing_credit_grants_resource_amount"
    },
    "available_balance": {
      "$ref": "#/components/schemas/billing_credit_grants_resource_amount"
    }
  },
  "description": "",
  "x-expandableFields": [
    "available_balance",
    "ledger_balance"
  ]
}

object credit_note

{
  "type": "object",
  "title": "CreditNote",
  "required": [
    "amount",
    "amount_shipping",
    "created",
    "currency",
    "customer",
    "discount_amount",
    "discount_amounts",
    "id",
    "invoice",
    "lines",
    "livemode",
    "number",
    "object",
    "pdf",
    "post_payment_amount",
    "pre_payment_amount",
    "pretax_credit_amounts",
    "refunds",
    "status",
    "subtotal",
    "total",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "pdf": {
      "type": "string",
      "maxLength": 5000,
      "description": "The link to download the PDF of the credit note."
    },
    "memo": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Customer-facing text that appears on the credit note PDF."
    },
    "type": {
      "enum": [
        "mixed",
        "post_payment",
        "pre_payment"
      ],
      "type": "string",
      "description": "Type of this credit note, one of `pre_payment` or `post_payment`. A `pre_payment` credit note means it was issued when the invoice was open. A `post_payment` credit note means it was issued when the invoice was paid."
    },
    "lines": {
      "type": "object",
      "title": "CreditNoteLinesList",
      "required": [
        "data",
        "has_more",
        "object",
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "maxLength": 5000,
          "description": "The URL where this list can be accessed."
        },
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/credit_note_line_item"
          },
          "description": "Details about each object."
        },
        "object": {
          "enum": [
            "list"
          ],
          "type": "string",
          "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
        },
        "has_more": {
          "type": "boolean",
          "description": "True if this list has another page of items after this one that can be fetched."
        }
      },
      "description": "Line items that make up the credit note",
      "x-expandableFields": [
        "data"
      ]
    },
    "total": {
      "type": "integer",
      "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount."
    },
    "amount": {
      "type": "integer",
      "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax."
    },
    "number": {
      "type": "string",
      "maxLength": 5000,
      "description": "A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice."
    },
    "object": {
      "enum": [
        "credit_note"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "reason": {
      "enum": [
        "duplicate",
        "fraudulent",
        "order_change",
        "product_unsatisfactory"
      ],
      "type": "string",
      "nullable": true,
      "description": "Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`"
    },
    "status": {
      "enum": [
        "issued",
        "void"
      ],
      "type": "string",
      "description": "Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit notes](https://docs.stripe.com/billing/invoices/credit-notes#voiding).",
      "x-stripeBypassValidation": true
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "invoice": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/invoice"
        }
      ],
      "description": "ID of the invoice.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/invoice"
          }
        ]
      }
    },
    "refunds": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/credit_note_refund"
      },
      "description": "Refunds related to this credit note."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        },
        {
          "$ref": "#/components/schemas/deleted_customer"
        }
      ],
      "description": "ID of the customer.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          },
          {
            "$ref": "#/components/schemas/deleted_customer"
          }
        ]
      }
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "subtotal": {
      "type": "integer",
      "description": "The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts."
    },
    "voided_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The time that the credit note was voided."
    },
    "total_taxes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billing_bill_resource_invoicing_taxes_tax"
      },
      "nullable": true,
      "description": "The aggregate tax information for all line items."
    },
    "effective_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF."
    },
    "shipping_cost": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/invoices_resource_shipping_cost"
        }
      ],
      "nullable": true,
      "description": "The details of the cost of shipping, including the ShippingRate applied to the invoice."
    },
    "amount_shipping": {
      "type": "integer",
      "description": "This is the sum of all the shipping amounts."
    },
    "discount_amount": {
      "type": "integer",
      "description": "The integer amount in cents (or local equivalent) representing the total amount of discount that was credited."
    },
    "customer_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the account representing the customer."
    },
    "discount_amounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/discounts_resource_discount_amount"
      },
      "description": "The aggregate amounts calculated per discount for all line items."
    },
    "out_of_band_amount": {
      "type": "integer",
      "nullable": true,
      "description": "Amount that was credited outside of Stripe."
    },
    "pre_payment_amount": {
      "type": "integer",
      "description": "The amount of the credit note by which the invoice's `amount_remaining` and `amount_due` were reduced."
    },
    "post_payment_amount": {
      "type": "integer",
      "description": "The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof."
    },
    "total_excluding_tax": {
      "type": "integer",
      "nullable": true,
      "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts."
    },
    "pretax_credit_amounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/credit_notes_pretax_credit_amount"
      },
      "description": "The pretax credit amounts (ex: discount, credit grants, etc) for all line items."
    },
    "subtotal_excluding_tax": {
      "type": "integer",
      "nullable": true,
      "description": "The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts."
    },
    "customer_balance_transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer_balance_transaction"
        }
      ],
      "nullable": true,
      "description": "Customer balance transaction related to this credit note.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer_balance_transaction"
          }
        ]
      }
    }
  },
  "description": "Issue a credit note to adjust an invoice's amount after the invoice is finalized.\n\nRelated guide: [Credit notes](https://docs.stripe.com/billing/invoices/credit-notes)",
  "x-resourceId": "credit_note",
  "x-expandableFields": [
    "customer",
    "customer_balance_transaction",
    "discount_amounts",
    "invoice",
    "lines",
    "pretax_credit_amounts",
    "refunds",
    "shipping_cost",
    "total_taxes"
  ]
}

object credit_note_line_item

{
  "type": "object",
  "title": "CreditNoteLineItem",
  "required": [
    "amount",
    "discount_amount",
    "discount_amounts",
    "id",
    "livemode",
    "object",
    "pretax_credit_amounts",
    "tax_rates",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "type": {
      "enum": [
        "custom_line_item",
        "invoice_line_item"
      ],
      "type": "string",
      "description": "The type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. When the type is `invoice_line_item` there is an additional `invoice_line_item` property on the resource the value of which is the id of the credited line item on the invoice."
    },
    "taxes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billing_bill_resource_invoicing_taxes_tax"
      },
      "nullable": true,
      "description": "The tax information of the line item."
    },
    "amount": {
      "type": "integer",
      "description": "The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts."
    },
    "object": {
      "enum": [
        "credit_note_line_item"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "quantity": {
      "type": "integer",
      "nullable": true,
      "description": "The number of units of product being credited."
    },
    "tax_rates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/tax_rate"
      },
      "description": "The tax rates which apply to the line item."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Description of the item being credited."
    },
    "unit_amount": {
      "type": "integer",
      "nullable": true,
      "description": "The cost of each unit of product being credited."
    },
    "discount_amount": {
      "type": "integer",
      "description": "The integer amount in cents (or local equivalent) representing the discount being credited for this line item."
    },
    "discount_amounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/discounts_resource_discount_amount"
      },
      "description": "The amount of discount calculated per discount for this line item"
    },
    "invoice_line_item": {
      "type": "string",
      "maxLength": 5000,
      "description": "ID of the invoice line item being credited"
    },
    "unit_amount_decimal": {
      "type": "string",
      "format": "decimal",
      "nullable": true,
      "description": "Same as `unit_amount`, but contains a decimal value with at most 12 decimal places."
    },
    "pretax_credit_amounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/credit_notes_pretax_credit_amount"
      },
      "description": "The pretax credit amounts (ex: discount, credit grants, etc) for this line item."
    }
  },
  "description": "The credit note line item object",
  "x-resourceId": "credit_note_line_item",
  "x-expandableFields": [
    "discount_amounts",
    "pretax_credit_amounts",
    "tax_rates",
    "taxes"
  ]
}

object credit_note_refund

{
  "type": "object",
  "title": "CreditNoteRefund",
  "required": [
    "amount_refunded",
    "refund"
  ],
  "properties": {
    "type": {
      "enum": [
        "payment_record_refund",
        "refund"
      ],
      "type": "string",
      "nullable": true,
      "description": "Type of the refund, one of `refund` or `payment_record_refund`."
    },
    "refund": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/refund"
        }
      ],
      "description": "ID of the refund.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/refund"
          }
        ]
      }
    },
    "amount_refunded": {
      "type": "integer",
      "description": "Amount of the refund that applies to this credit note, in cents (or local equivalent)."
    },
    "payment_record_refund": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/credit_notes_payment_record_refund"
        }
      ],
      "nullable": true,
      "description": "The PaymentRecord refund details associated with this credit note refund."
    }
  },
  "description": "",
  "x-expandableFields": [
    "payment_record_refund",
    "refund"
  ]
}

object credit_notes_payment_record_refund

{
  "type": "object",
  "title": "CreditNotesPaymentRecordRefund",
  "required": [
    "payment_record",
    "refund_group"
  ],
  "properties": {
    "refund_group": {
      "type": "string",
      "maxLength": 5000,
      "description": "ID of the refund group."
    },
    "payment_record": {
      "type": "string",
      "maxLength": 5000,
      "description": "ID of the payment record."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object credit_notes_pretax_credit_amount

{
  "type": "object",
  "title": "CreditNotesPretaxCreditAmount",
  "required": [
    "amount",
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "credit_balance_transaction",
        "discount"
      ],
      "type": "string",
      "description": "Type of the pretax credit amount referenced."
    },
    "amount": {
      "type": "integer",
      "description": "The amount, in cents (or local equivalent), of the pretax credit amount."
    },
    "discount": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/discount"
        },
        {
          "$ref": "#/components/schemas/deleted_discount"
        }
      ],
      "description": "The discount that was applied to get this pretax credit amount.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/discount"
          },
          {
            "$ref": "#/components/schemas/deleted_discount"
          }
        ]
      }
    },
    "credit_balance_transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/billing.credit_balance_transaction"
        }
      ],
      "description": "The credit balance transaction that was applied to get this pretax credit amount.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/billing.credit_balance_transaction"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "credit_balance_transaction",
    "discount"
  ]
}

object currency_option

{
  "type": "object",
  "title": "CurrencyOption",
  "properties": {
    "tiers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/price_tier"
      },
      "description": "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`."
    },
    "unit_amount": {
      "type": "integer",
      "nullable": true,
      "description": "The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`."
    },
    "tax_behavior": {
      "enum": [
        "exclusive",
        "inclusive",
        "unspecified"
      ],
      "type": "string",
      "nullable": true,
      "description": "Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed."
    },
    "custom_unit_amount": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/custom_unit_amount"
        }
      ],
      "nullable": true,
      "description": "When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links."
    },
    "unit_amount_decimal": {
      "type": "string",
      "format": "decimal",
      "nullable": true,
      "description": "The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`."
    }
  },
  "description": "",
  "x-expandableFields": [
    "custom_unit_amount",
    "tiers"
  ]
}

object custom_logo

{
  "type": "object",
  "title": "custom_logo",
  "required": [
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 5000,
      "description": "URL of the Dashboard-only CustomPaymentMethodType logo."
    },
    "content_type": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Content type of the Dashboard-only CustomPaymentMethodType logo."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object custom_unit_amount

{
  "type": "object",
  "title": "CustomUnitAmount",
  "properties": {
    "preset": {
      "type": "integer",
      "nullable": true,
      "description": "The starting unit amount which can be updated by the customer."
    },
    "maximum": {
      "type": "integer",
      "nullable": true,
      "description": "The maximum unit amount the customer can specify for this item."
    },
    "minimum": {
      "type": "integer",
      "nullable": true,
      "description": "The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object customer

{
  "type": "object",
  "title": "Customer",
  "required": [
    "created",
    "id",
    "livemode",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "tax": {
      "$ref": "#/components/schemas/customer_tax"
    },
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The customer's full name or business name."
    },
    "email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The customer's email address."
    },
    "phone": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The customer's phone number."
    },
    "object": {
      "enum": [
        "customer"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "address": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/address"
        }
      ],
      "nullable": true,
      "description": "The customer's address."
    },
    "balance": {
      "type": "integer",
      "description": "The current balance, if any, that's stored on the customer in their default currency. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. For multi-currency balances, see [invoice_credit_balance](https://docs.stripe.com/api/customers/object#customer_object-invoice_credit_balance)."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "sources": {
      "type": "object",
      "title": "ApmsSourcesSourceList",
      "required": [
        "data",
        "has_more",
        "object",
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "maxLength": 5000,
          "description": "The URL where this list can be accessed."
        },
        "data": {
          "type": "array",
          "items": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/bank_account"
              },
              {
                "$ref": "#/components/schemas/card"
              },
              {
                "$ref": "#/components/schemas/source"
              }
            ],
            "title": "Polymorphic",
            "x-stripeBypassValidation": true
          },
          "description": "Details about each object."
        },
        "object": {
          "enum": [
            "list"
          ],
          "type": "string",
          "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
        },
        "has_more": {
          "type": "boolean",
          "description": "True if this list has another page of items after this one that can be fetched."
        }
      },
      "description": "The customer's payment sources, if any.",
      "x-expandableFields": [
        "data"
      ]
    },
    "tax_ids": {
      "type": "object",
      "title": "TaxIDsList",
      "required": [
        "data",
        "has_more",
        "object",
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "maxLength": 5000,
          "description": "The URL where this list can be accessed."
        },
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/tax_id"
          },
          "description": "Details about each object."
        },
        "object": {
          "enum": [
            "list"
          ],
          "type": "string",
          "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
        },
        "has_more": {
          "type": "boolean",
          "description": "True if this list has another page of items after this one that can be fetched."
        }
      },
      "description": "The customer's tax IDs.",
      "x-expandableFields": [
        "data"
      ]
    },
    "currency": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes."
    },
    "discount": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/discount"
        }
      ],
      "nullable": true,
      "description": "Describes the current discount active on the customer, if there is one."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "shipping": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/shipping"
        }
      ],
      "nullable": true,
      "description": "Mailing and shipping address for the customer. Appears on invoices emailed to this customer."
    },
    "delinquent": {
      "type": "boolean",
      "nullable": true,
      "description": "Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the `invoice.due_date` will set this field to `true`.\n\nIf an invoice becomes uncollectible by [dunning](https://docs.stripe.com/billing/automatic-collection), `delinquent` doesn't reset to `false`.\n\nIf you care whether the customer has paid their most recent subscription invoice, use `subscription.status` instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to `false`."
    },
    "tax_exempt": {
      "enum": [
        "exempt",
        "none",
        "reverse"
      ],
      "type": "string",
      "nullable": true,
      "description": "Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **\"Reverse charge\"**."
    },
    "test_clock": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/test_helpers.test_clock"
        }
      ],
      "nullable": true,
      "description": "ID of the test clock that this customer belongs to.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/test_helpers.test_clock"
          }
        ]
      }
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An arbitrary string attached to the object. Often useful for displaying to users."
    },
    "cash_balance": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/cash_balance"
        }
      ],
      "nullable": true,
      "description": "The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is \"cash_balance\". The `settings[reconciliation_mode]` field describes if these funds apply to these payment intents manually or automatically."
    },
    "business_name": {
      "type": "string",
      "maxLength": 150,
      "description": "The customer's business name."
    },
    "subscriptions": {
      "type": "object",
      "title": "SubscriptionList",
      "required": [
        "data",
        "has_more",
        "object",
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "maxLength": 5000,
          "description": "The URL where this list can be accessed."
        },
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/subscription"
          },
          "description": "Details about each object."
        },
        "object": {
          "enum": [
            "list"
          ],
          "type": "string",
          "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
        },
        "has_more": {
          "type": "boolean",
          "description": "True if this list has another page of items after this one that can be fetched."
        }
      },
      "description": "The customer's current subscriptions, if any.",
      "x-expandableFields": [
        "data"
      ]
    },
    "default_source": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/bank_account"
        },
        {
          "$ref": "#/components/schemas/card"
        },
        {
          "$ref": "#/components/schemas/source"
        }
      ],
      "nullable": true,
      "description": "ID of the default payment source for the customer.\n\nIf you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/bank_account"
          },
          {
            "$ref": "#/components/schemas/card"
          },
          {
            "$ref": "#/components/schemas/source"
          }
        ]
      },
      "x-stripeBypassValidation": true
    },
    "invoice_prefix": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The prefix for the customer used to generate unique invoice numbers."
    },
    "individual_name": {
      "type": "string",
      "maxLength": 150,
      "description": "The customer's individual name."
    },
    "customer_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter."
    },
    "invoice_settings": {
      "$ref": "#/components/schemas/invoice_setting_customer_setting"
    },
    "preferred_locales": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "The customer's preferred locales (languages), ordered by preference."
    },
    "next_invoice_sequence": {
      "type": "integer",
      "description": "The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses."
    },
    "invoice_credit_balance": {
      "type": "object",
      "description": "The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes.",
      "additionalProperties": {
        "type": "integer"
      }
    }
  },
  "description": "This object represents a customer of your business. Use it to [create recurring charges](https://docs.stripe.com/invoicing/customer), [save payment](https://docs.stripe.com/payments/save-during-payment) and contact information,\nand track payments that belong to the same customer.",
  "x-resourceId": "customer",
  "x-expandableFields": [
    "address",
    "cash_balance",
    "default_source",
    "discount",
    "invoice_settings",
    "shipping",
    "sources",
    "subscriptions",
    "tax",
    "tax_ids",
    "test_clock"
  ]
}

object customer_acceptance

{
  "type": "object",
  "title": "customer_acceptance",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "offline",
        "online"
      ],
      "type": "string",
      "description": "The mandate includes the type of customer acceptance information, such as: `online` or `offline`."
    },
    "online": {
      "$ref": "#/components/schemas/online_acceptance"
    },
    "offline": {
      "$ref": "#/components/schemas/offline_acceptance"
    },
    "accepted_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The time that the customer accepts the mandate."
    }
  },
  "description": "",
  "x-expandableFields": [
    "offline",
    "online"
  ]
}

object customer_balance_customer_balance_settings

{
  "type": "object",
  "title": "CustomerBalanceCustomerBalanceSettings",
  "required": [
    "reconciliation_mode",
    "using_merchant_default"
  ],
  "properties": {
    "reconciliation_mode": {
      "enum": [
        "automatic",
        "manual"
      ],
      "type": "string",
      "description": "The configuration for how funds that land in the customer cash balance are reconciled."
    },
    "using_merchant_default": {
      "type": "boolean",
      "description": "A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft

{
  "type": "object",
  "title": "CustomerBalanceResourceCashBalanceTransactionResourceAdjustedForOverdraft",
  "required": [
    "balance_transaction",
    "linked_transaction"
  ],
  "properties": {
    "linked_transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer_cash_balance_transaction"
        }
      ],
      "description": "The [Cash Balance Transaction](https://docs.stripe.com/api/cash_balance_transactions/object) that brought the customer balance negative, triggering the clawback of funds.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer_cash_balance_transaction"
          }
        ]
      }
    },
    "balance_transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/balance_transaction"
        }
      ],
      "description": "The [Balance Transaction](https://docs.stripe.com/api/balance_transactions/object) that corresponds to funds taken out of your Stripe balance.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/balance_transaction"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "balance_transaction",
    "linked_transaction"
  ]
}

object customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction

{
  "type": "object",
  "title": "CustomerBalanceResourceCashBalanceTransactionResourceAppliedToPaymentTransaction",
  "required": [
    "payment_intent"
  ],
  "properties": {
    "payment_intent": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_intent"
        }
      ],
      "description": "The [Payment Intent](https://docs.stripe.com/api/payment_intents/object) that funds were applied to.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_intent"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "payment_intent"
  ]
}

object customer_balance_resource_cash_balance_transaction_resource_funded_transaction

{
  "type": "object",
  "title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransaction",
  "required": [
    "bank_transfer"
  ],
  "properties": {
    "bank_transfer": {
      "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer"
    }
  },
  "description": "",
  "x-expandableFields": [
    "bank_transfer"
  ]
}

object customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer

{
  "type": "object",
  "title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransfer",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "eu_bank_transfer",
        "gb_bank_transfer",
        "jp_bank_transfer",
        "mx_bank_transfer",
        "us_bank_transfer"
      ],
      "type": "string",
      "description": "The funding method type used to fund the customer balance. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.",
      "x-stripeBypassValidation": true
    },
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The user-supplied reference field on the bank transfer."
    },
    "eu_bank_transfer": {
      "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transfer"
    },
    "gb_bank_transfer": {
      "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_gb_bank_transfer"
    },
    "jp_bank_transfer": {
      "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transfer"
    },
    "us_bank_transfer": {
      "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_us_bank_transfer"
    }
  },
  "description": "",
  "x-expandableFields": [
    "eu_bank_transfer",
    "gb_bank_transfer",
    "jp_bank_transfer",
    "us_bank_transfer"
  ]
}

object

customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transfer

{
  "type": "object",
  "title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceEuBankTransfer",
  "properties": {
    "bic": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The BIC of the bank of the sender of the funding."
    },
    "iban_last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The last 4 digits of the IBAN of the sender of the funding."
    },
    "sender_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The full name of the sender, as supplied by the sending bank."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object

customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_gb_bank_transfer

{
  "type": "object",
  "title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceGbBankTransfer",
  "properties": {
    "sort_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The sort code of the bank of the sender of the funding"
    },
    "sender_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The full name of the sender, as supplied by the sending bank."
    },
    "account_number_last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The last 4 digits of the account number of the sender of the funding."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object

customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transfer

{
  "type": "object",
  "title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceJpBankTransfer",
  "properties": {
    "sender_bank": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The name of the bank of the sender of the funding."
    },
    "sender_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The full name of the sender, as supplied by the sending bank."
    },
    "sender_branch": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The name of the bank branch of the sender of the funding."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object

customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_us_bank_transfer

{
  "type": "object",
  "title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceUsBankTransfer",
  "properties": {
    "network": {
      "enum": [
        "ach",
        "domestic_wire_us",
        "swift"
      ],
      "type": "string",
      "description": "The banking network used for this funding."
    },
    "sender_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The full name of the sender, as supplied by the sending bank."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction

{
  "type": "object",
  "title": "CustomerBalanceResourceCashBalanceTransactionResourceRefundedFromPaymentTransaction",
  "required": [
    "refund"
  ],
  "properties": {
    "refund": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/refund"
        }
      ],
      "description": "The [Refund](https://docs.stripe.com/api/refunds/object) that moved these funds into the customer's cash balance.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/refund"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "refund"
  ]
}

object customer_balance_resource_cash_balance_transaction_resource_transferred_to_balance

{
  "type": "object",
  "title": "CustomerBalanceResourceCashBalanceTransactionResourceTransferredToBalance",
  "required": [
    "balance_transaction"
  ],
  "properties": {
    "balance_transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/balance_transaction"
        }
      ],
      "description": "The [Balance Transaction](https://docs.stripe.com/api/balance_transactions/object) that corresponds to funds transferred to your Stripe balance.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/balance_transaction"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "balance_transaction"
  ]
}

object customer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction

{
  "type": "object",
  "title": "CustomerBalanceResourceCashBalanceTransactionResourceUnappliedFromPaymentTransaction",
  "required": [
    "payment_intent"
  ],
  "properties": {
    "payment_intent": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_intent"
        }
      ],
      "description": "The [Payment Intent](https://docs.stripe.com/api/payment_intents/object) that funds were unapplied from.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_intent"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "payment_intent"
  ]
}

object customer_balance_transaction

{
  "type": "object",
  "title": "CustomerBalanceTransaction",
  "required": [
    "amount",
    "created",
    "currency",
    "customer",
    "ending_balance",
    "id",
    "livemode",
    "object",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "type": {
      "enum": [
        "adjustment",
        "applied_to_invoice",
        "checkout_session_subscription_payment",
        "checkout_session_subscription_payment_canceled",
        "credit_note",
        "initial",
        "invoice_overpaid",
        "invoice_too_large",
        "invoice_too_small",
        "migration",
        "unapplied_from_invoice",
        "unspent_receiver_credit"
      ],
      "type": "string",
      "description": "Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_overpaid`, `invoice_too_large`, `invoice_too_small`, `unspent_receiver_credit`, `unapplied_from_invoice`, `checkout_session_subscription_payment`, or `checkout_session_subscription_payment_canceled`. See the [Customer Balance page](https://docs.stripe.com/billing/customer/balance#types) to learn more about transaction types.",
      "x-stripeBypassValidation": true
    },
    "amount": {
      "type": "integer",
      "description": "The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's `balance`."
    },
    "object": {
      "enum": [
        "customer_balance_transaction"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "invoice": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/invoice"
        }
      ],
      "nullable": true,
      "description": "The ID of the invoice (if any) related to the transaction.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/invoice"
          }
        ]
      }
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        }
      ],
      "description": "The ID of the customer the transaction belongs to.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          }
        ]
      }
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "credit_note": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/credit_note"
        }
      ],
      "nullable": true,
      "description": "The ID of the credit note (if any) related to the transaction.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/credit_note"
          }
        ]
      }
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An arbitrary string attached to the object. Often useful for displaying to users."
    },
    "ending_balance": {
      "type": "integer",
      "description": "The customer's `balance` after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice."
    },
    "checkout_session": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/checkout.session"
        }
      ],
      "nullable": true,
      "description": "The ID of the checkout session (if any) that created the transaction.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/checkout.session"
          }
        ]
      }
    },
    "customer_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The ID of an Account representing a customer that the transaction belongs to."
    }
  },
  "description": "Each customer has a [Balance](https://docs.stripe.com/api/customers/object#customer_object-balance) value,\nwhich denotes a debit or credit that's automatically applied to their next invoice upon finalization.\nYou may modify the value directly by using the [update customer API](https://docs.stripe.com/api/customers/update),\nor by creating a Customer Balance Transaction, which increments or decrements the customer's `balance` by the specified `amount`.\n\nRelated guide: [Customer balance](https://docs.stripe.com/billing/customer/balance)",
  "x-resourceId": "customer_balance_transaction",
  "x-expandableFields": [
    "checkout_session",
    "credit_note",
    "customer",
    "invoice"
  ]
}

object customer_cash_balance_transaction

{
  "type": "object",
  "title": "CustomerCashBalanceTransaction",
  "required": [
    "created",
    "currency",
    "customer",
    "ending_balance",
    "id",
    "livemode",
    "net_amount",
    "object",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "type": {
      "enum": [
        "adjusted_for_overdraft",
        "applied_to_payment",
        "funded",
        "funding_reversed",
        "refunded_from_payment",
        "return_canceled",
        "return_initiated",
        "transferred_to_balance",
        "unapplied_from_payment"
      ],
      "type": "string",
      "description": "The type of the cash balance transaction. New types may be added in future. See [Customer Balance](https://docs.stripe.com/payments/customer-balance#types) to learn more about these types."
    },
    "funded": {
      "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction"
    },
    "object": {
      "enum": [
        "customer_cash_balance_transaction"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "currency": {
      "type": "string",
      "maxLength": 5000,
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        }
      ],
      "description": "The customer whose available cash balance changed as a result of this transaction.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          }
        ]
      }
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "net_amount": {
      "type": "integer",
      "description": "The amount by which the cash balance changed, represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance."
    },
    "ending_balance": {
      "type": "integer",
      "description": "The total available cash balance for the specified currency after this transaction was applied. Represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."
    },
    "customer_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The ID of an Account representing a customer whose available cash balance changed as a result of this transaction."
    },
    "applied_to_payment": {
      "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction"
    },
    "refunded_from_payment": {
      "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction"
    },
    "adjusted_for_overdraft": {
      "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft"
    },
    "transferred_to_balance": {
      "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_transferred_to_balance"
    },
    "unapplied_from_payment": {
      "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction"
    }
  },
  "description": "Customers with certain payments enabled have a cash balance, representing funds that were paid\nby the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions\nrepresent when funds are moved into or out of this balance. This includes funding by the customer, allocation\nto payments, and refunds to the customer.",
  "x-resourceId": "customer_cash_balance_transaction",
  "x-expandableFields": [
    "adjusted_for_overdraft",
    "applied_to_payment",
    "customer",
    "funded",
    "refunded_from_payment",
    "transferred_to_balance",
    "unapplied_from_payment"
  ]
}

object customer_session

{
  "type": "object",
  "title": "CustomerSessionResourceCustomerSession",
  "required": [
    "client_secret",
    "created",
    "customer",
    "expires_at",
    "livemode",
    "object"
  ],
  "properties": {
    "object": {
      "enum": [
        "customer_session"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        }
      ],
      "description": "The Customer the Customer Session was created for.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          }
        ]
      }
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "components": {
      "$ref": "#/components/schemas/customer_session_resource_components"
    },
    "expires_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "The timestamp at which this Customer Session will expire."
    },
    "client_secret": {
      "type": "string",
      "maxLength": 5000,
      "description": "The client secret of this Customer Session. Used on the client to set up secure access to the given `customer`.\n\nThe client secret can be used to provide access to `customer` from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret."
    },
    "customer_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Account that the Customer Session was created for."
    }
  },
  "description": "A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access\ncontrol over a Customer.\n\nRelated guides: [Customer Session with the Payment Element](/payments/accept-a-payment-deferred?platform=web&type=payment#save-payment-methods),\n[Customer Session with the Pricing Table](/payments/checkout/pricing-table#customer-session),\n[Customer Session with the Buy Button](/payment-links/buy-button#pass-an-existing-customer).",
  "x-resourceId": "customer_session",
  "x-expandableFields": [
    "components",
    "customer"
  ]
}

object customer_session_resource_components

{
  "type": "object",
  "title": "CustomerSessionResourceComponents",
  "required": [
    "buy_button",
    "customer_sheet",
    "mobile_payment_element",
    "payment_element",
    "pricing_table"
  ],
  "properties": {
    "buy_button": {
      "$ref": "#/components/schemas/customer_session_resource_components_resource_buy_button"
    },
    "pricing_table": {
      "$ref": "#/components/schemas/customer_session_resource_components_resource_pricing_table"
    },
    "customer_sheet": {
      "$ref": "#/components/schemas/customer_session_resource_components_resource_customer_sheet"
    },
    "payment_element": {
      "$ref": "#/components/schemas/customer_session_resource_components_resource_payment_element"
    },
    "mobile_payment_element": {
      "$ref": "#/components/schemas/customer_session_resource_components_resource_mobile_payment_element"
    }
  },
  "description": "Configuration for the components supported by this Customer Session.",
  "x-expandableFields": [
    "buy_button",
    "customer_sheet",
    "mobile_payment_element",
    "payment_element",
    "pricing_table"
  ]
}

object customer_session_resource_components_resource_buy_button

{
  "type": "object",
  "title": "CustomerSessionResourceComponentsResourceBuyButton",
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Whether the buy button is enabled."
    }
  },
  "description": "This hash contains whether the buy button is enabled.",
  "x-expandableFields": []
}

object customer_session_resource_components_resource_customer_sheet

{
  "type": "object",
  "title": "CustomerSessionResourceComponentsResourceCustomerSheet",
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Whether the customer sheet is enabled."
    },
    "features": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/customer_session_resource_components_resource_customer_sheet_resource_features"
        }
      ],
      "nullable": true,
      "description": "This hash defines whether the customer sheet supports certain features."
    }
  },
  "description": "This hash contains whether the customer sheet is enabled and the features it supports.",
  "x-expandableFields": [
    "features"
  ]
}

object customer_session_resource_components_resource_customer_sheet_resource_features

{
  "type": "object",
  "title": "CustomerSessionResourceComponentsResourceCustomerSheetResourceFeatures",
  "properties": {
    "payment_method_remove": {
      "enum": [
        "disabled",
        "enabled"
      ],
      "type": "string",
      "nullable": true,
      "description": "Controls whether the customer sheet displays the option to remove a saved payment method.\"\n\nAllowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).",
      "x-stripeBypassValidation": true
    },
    "payment_method_allow_redisplay_filters": {
      "type": "array",
      "items": {
        "enum": [
          "always",
          "limited",
          "unspecified"
        ],
        "type": "string"
      },
      "nullable": true,
      "description": "A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the customer sheet displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.\n\nIf not specified, defaults to [\"always\"]. In order to display all saved payment methods, specify [\"always\", \"limited\", \"unspecified\"]."
    }
  },
  "description": "This hash contains the features the customer sheet supports.",
  "x-expandableFields": []
}

object customer_session_resource_components_resource_mobile_payment_element

{
  "type": "object",
  "title": "CustomerSessionResourceComponentsResourceMobilePaymentElement",
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Whether the mobile payment element is enabled."
    },
    "features": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/customer_session_resource_components_resource_mobile_payment_element_resource_features"
        }
      ],
      "nullable": true,
      "description": "This hash defines whether the mobile payment element supports certain features."
    }
  },
  "description": "This hash contains whether the mobile payment element is enabled and the features it supports.",
  "x-expandableFields": [
    "features"
  ]
}

object customer_session_resource_components_resource_mobile_payment_element_resource_features

{
  "type": "object",
  "title": "CustomerSessionResourceComponentsResourceMobilePaymentElementResourceFeatures",
  "properties": {
    "payment_method_save": {
      "enum": [
        "disabled",
        "enabled"
      ],
      "type": "string",
      "nullable": true,
      "description": "Controls whether the mobile payment element displays a checkbox offering to save a new payment method.\n\nIf a customer checks the box, the [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) value on the PaymentMethod is set to `'always'` at confirmation time. For PaymentIntents, the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value is also set to the value defined in `payment_method_save_usage`.",
      "x-stripeBypassValidation": true
    },
    "payment_method_remove": {
      "enum": [
        "disabled",
        "enabled"
      ],
      "type": "string",
      "nullable": true,
      "description": "Controls whether the mobile payment element displays the option to remove a saved payment method.\"\n\nAllowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).",
      "x-stripeBypassValidation": true
    },
    "payment_method_redisplay": {
      "enum": [
        "disabled",
        "enabled"
      ],
      "type": "string",
      "nullable": true,
      "description": "Controls whether or not the mobile payment element shows saved payment methods.",
      "x-stripeBypassValidation": true
    },
    "payment_method_allow_redisplay_filters": {
      "type": "array",
      "items": {
        "enum": [
          "always",
          "limited",
          "unspecified"
        ],
        "type": "string"
      },
      "nullable": true,
      "description": "A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the mobile payment element displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.\n\nIf not specified, defaults to [\"always\"]. In order to display all saved payment methods, specify [\"always\", \"limited\", \"unspecified\"]."
    },
    "payment_method_save_allow_redisplay_override": {
      "enum": [
        "always",
        "limited",
        "unspecified"
      ],
      "type": "string",
      "nullable": true,
      "description": "Allows overriding the value of allow_override when saving a new payment method when payment_method_save is set to disabled. Use values: \"always\", \"limited\", or \"unspecified\".\n\nIf not specified, defaults to `nil` (no override value)."
    }
  },
  "description": "This hash contains the features the mobile payment element supports.",
  "x-expandableFields": []
}

object customer_session_resource_components_resource_payment_element

{
  "type": "object",
  "title": "CustomerSessionResourceComponentsResourcePaymentElement",
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Whether the Payment Element is enabled."
    },
    "features": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/customer_session_resource_components_resource_payment_element_resource_features"
        }
      ],
      "nullable": true,
      "description": "This hash defines whether the Payment Element supports certain features."
    }
  },
  "description": "This hash contains whether the Payment Element is enabled and the features it supports.",
  "x-expandableFields": [
    "features"
  ]
}

object customer_session_resource_components_resource_payment_element_resource_features

{
  "type": "object",
  "title": "CustomerSessionResourceComponentsResourcePaymentElementResourceFeatures",
  "required": [
    "payment_method_allow_redisplay_filters",
    "payment_method_redisplay",
    "payment_method_remove",
    "payment_method_save"
  ],
  "properties": {
    "payment_method_save": {
      "enum": [
        "disabled",
        "enabled"
      ],
      "type": "string",
      "description": "Controls whether the Payment Element displays a checkbox offering to save a new payment method. This parameter defaults to `disabled`.\n\nIf a customer checks the box, the [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) value on the PaymentMethod is set to `'always'` at confirmation time. For PaymentIntents, the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value is also set to the value defined in `payment_method_save_usage`.",
      "x-stripeBypassValidation": true
    },
    "payment_method_remove": {
      "enum": [
        "disabled",
        "enabled"
      ],
      "type": "string",
      "description": "Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to `disabled`.\n\nAllowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).",
      "x-stripeBypassValidation": true
    },
    "payment_method_redisplay": {
      "enum": [
        "disabled",
        "enabled"
      ],
      "type": "string",
      "description": "Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to `disabled`.",
      "x-stripeBypassValidation": true
    },
    "payment_method_save_usage": {
      "enum": [
        "off_session",
        "on_session"
      ],
      "type": "string",
      "nullable": true,
      "description": "When using PaymentIntents and the customer checks the save checkbox, this field determines the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value used to confirm the PaymentIntent.\n\nWhen using SetupIntents, directly configure the [`usage`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-usage) value on SetupIntent creation."
    },
    "payment_method_redisplay_limit": {
      "type": "integer",
      "nullable": true,
      "description": "Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`. The maximum redisplay limit is `10`."
    },
    "payment_method_allow_redisplay_filters": {
      "type": "array",
      "items": {
        "enum": [
          "always",
          "limited",
          "unspecified"
        ],
        "type": "string"
      },
      "description": "A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the Payment Element displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.\n\nIf not specified, defaults to [\"always\"]. In order to display all saved payment methods, specify [\"always\", \"limited\", \"unspecified\"]."
    }
  },
  "description": "This hash contains the features the Payment Element supports.",
  "x-expandableFields": []
}

object customer_session_resource_components_resource_pricing_table

{
  "type": "object",
  "title": "CustomerSessionResourceComponentsResourcePricingTable",
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Whether the pricing table is enabled."
    }
  },
  "description": "This hash contains whether the pricing table is enabled.",
  "x-expandableFields": []
}

object customer_tax

{
  "type": "object",
  "title": "CustomerTax",
  "required": [
    "automatic_tax",
    "provider"
  ],
  "properties": {
    "location": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/customer_tax_location"
        }
      ],
      "nullable": true,
      "description": "The identified tax location of the customer."
    },
    "provider": {
      "enum": [
        "anrok",
        "avalara",
        "sphere",
        "stripe"
      ],
      "type": "string",
      "description": "The tax calculation provider used for location resolution. Defaults to `stripe` when not using a [third-party provider](/tax/third-party-apps)."
    },
    "ip_address": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A recent IP address of the customer used for tax reporting and tax location inference."
    },
    "automatic_tax": {
      "enum": [
        "failed",
        "not_collecting",
        "supported",
        "unrecognized_location"
      ],
      "type": "string",
      "description": "Surfaces if automatic tax computation is possible given the current customer location information."
    }
  },
  "description": "",
  "x-expandableFields": [
    "location"
  ]
}

object customer_tax_location

{
  "type": "object",
  "title": "CustomerTaxLocation",
  "required": [
    "country",
    "source"
  ],
  "properties": {
    "state": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The identified tax state, county, province, or region of the customer."
    },
    "source": {
      "enum": [
        "billing_address",
        "ip_address",
        "payment_method",
        "shipping_destination"
      ],
      "type": "string",
      "description": "The data source used to infer the customer's location."
    },
    "country": {
      "type": "string",
      "maxLength": 5000,
      "description": "The identified tax country of the customer."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object deleted_account

{
  "type": "object",
  "title": "DeletedAccount",
  "required": [
    "deleted",
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "account"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "deleted": {
      "enum": [
        true
      ],
      "type": "boolean",
      "description": "Always true for a deleted object"
    }
  },
  "description": "",
  "x-resourceId": "deleted_account",
  "x-expandableFields": []
}

object deleted_apple_pay_domain

{
  "type": "object",
  "title": "DeletedApplePayDomain",
  "required": [
    "deleted",
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "apple_pay_domain"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "deleted": {
      "enum": [
        true
      ],
      "type": "boolean",
      "description": "Always true for a deleted object"
    }
  },
  "description": "",
  "x-resourceId": "deleted_apple_pay_domain",
  "x-expandableFields": []
}

object deleted_application

{
  "type": "object",
  "title": "DeletedApplication",
  "required": [
    "deleted",
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The name of the application."
    },
    "object": {
      "enum": [
        "application"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "deleted": {
      "enum": [
        true
      ],
      "type": "boolean",
      "description": "Always true for a deleted object"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object deleted_bank_account

{
  "type": "object",
  "title": "DeletedBankAccount",
  "required": [
    "deleted",
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "bank_account"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "deleted": {
      "enum": [
        true
      ],
      "type": "boolean",
      "description": "Always true for a deleted object"
    },
    "currency": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object deleted_card

{
  "type": "object",
  "title": "DeletedCard",
  "required": [
    "deleted",
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "card"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "deleted": {
      "enum": [
        true
      ],
      "type": "boolean",
      "description": "Always true for a deleted object"
    },
    "currency": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object deleted_coupon

{
  "type": "object",
  "title": "DeletedCoupon",
  "required": [
    "deleted",
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "coupon"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "deleted": {
      "enum": [
        true
      ],
      "type": "boolean",
      "description": "Always true for a deleted object"
    }
  },
  "description": "",
  "x-resourceId": "deleted_coupon",
  "x-expandableFields": []
}

object deleted_customer

{
  "type": "object",
  "title": "DeletedCustomer",
  "required": [
    "deleted",
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "customer"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "deleted": {
      "enum": [
        true
      ],
      "type": "boolean",
      "description": "Always true for a deleted object"
    }
  },
  "description": "",
  "x-resourceId": "deleted_customer",
  "x-expandableFields": []
}

object deleted_discount

{
  "type": "object",
  "title": "DeletedDiscount",
  "required": [
    "deleted",
    "id",
    "object",
    "source",
    "start"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array."
    },
    "start": {
      "type": "integer",
      "format": "unix-time",
      "description": "Date that the coupon was applied."
    },
    "object": {
      "enum": [
        "discount"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "source": {
      "$ref": "#/components/schemas/discount_source"
    },
    "deleted": {
      "enum": [
        true
      ],
      "type": "boolean",
      "description": "Always true for a deleted object"
    },
    "invoice": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice."
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        },
        {
          "$ref": "#/components/schemas/deleted_customer"
        }
      ],
      "nullable": true,
      "description": "The ID of the customer associated with this discount.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          },
          {
            "$ref": "#/components/schemas/deleted_customer"
          }
        ]
      }
    },
    "invoice_item": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item."
    },
    "subscription": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The subscription that this coupon is applied to, if it is applied to a particular subscription."
    },
    "promotion_code": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/promotion_code"
        }
      ],
      "nullable": true,
      "description": "The promotion code applied to create this discount.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/promotion_code"
          }
        ]
      }
    },
    "checkout_session": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode."
    },
    "customer_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The ID of the account representing the customer associated with this discount."
    },
    "subscription_item": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The subscription item that this coupon is applied to, if it is applied to a particular subscription item."
    }
  },
  "description": "",
  "x-resourceId": "deleted_discount",
  "x-expandableFields": [
    "customer",
    "promotion_code",
    "source"
  ]
}

object deleted_external_account

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/deleted_bank_account"
    },
    {
      "$ref": "#/components/schemas/deleted_card"
    }
  ],
  "title": "Polymorphic",
  "x-resourceId": "deleted_external_account",
  "x-stripeBypassValidation": true
}

object deleted_invoice

{
  "type": "object",
  "title": "DeletedInvoice",
  "required": [
    "deleted",
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "invoice"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "deleted": {
      "enum": [
        true
      ],
      "type": "boolean",
      "description": "Always true for a deleted object"
    }
  },
  "description": "",
  "x-resourceId": "deleted_invoice",
  "x-expandableFields": []
}

object deleted_invoiceitem

{
  "type": "object",
  "title": "DeletedInvoiceItem",
  "required": [
    "deleted",
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "invoiceitem"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "deleted": {
      "enum": [
        true
      ],
      "type": "boolean",
      "description": "Always true for a deleted object"
    }
  },
  "description": "",
  "x-resourceId": "deleted_invoiceitem",
  "x-expandableFields": []
}

object deleted_payment_source

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/deleted_bank_account"
    },
    {
      "$ref": "#/components/schemas/deleted_card"
    }
  ],
  "title": "Polymorphic",
  "x-resourceId": "deleted_payment_source",
  "x-stripeBypassValidation": true
}

object deleted_person

{
  "type": "object",
  "title": "DeletedPerson",
  "required": [
    "deleted",
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "person"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "deleted": {
      "enum": [
        true
      ],
      "type": "boolean",
      "description": "Always true for a deleted object"
    }
  },
  "description": "",
  "x-resourceId": "deleted_person",
  "x-expandableFields": []
}

object deleted_plan

{
  "type": "object",
  "title": "DeletedPlan",
  "required": [
    "deleted",
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "plan"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "deleted": {
      "enum": [
        true
      ],
      "type": "boolean",
      "description": "Always true for a deleted object"
    }
  },
  "description": "",
  "x-resourceId": "deleted_plan",
  "x-expandableFields": []
}

object deleted_price

{
  "type": "object",
  "title": "DeletedPrice",
  "required": [
    "deleted",
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "price"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "deleted": {
      "enum": [
        true
      ],
      "type": "boolean",
      "description": "Always true for a deleted object"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object deleted_product

{
  "type": "object",
  "title": "DeletedProduct",
  "required": [
    "deleted",
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "product"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "deleted": {
      "enum": [
        true
      ],
      "type": "boolean",
      "description": "Always true for a deleted object"
    }
  },
  "description": "",
  "x-resourceId": "deleted_product",
  "x-expandableFields": []
}

object deleted_product_feature

{
  "type": "object",
  "title": "DeletedProductFeature",
  "required": [
    "deleted",
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "product_feature"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "deleted": {
      "enum": [
        true
      ],
      "type": "boolean",
      "description": "Always true for a deleted object"
    }
  },
  "description": "",
  "x-resourceId": "deleted_product_feature",
  "x-expandableFields": []
}

object deleted_radar.value_list

{
  "type": "object",
  "title": "RadarListDeletedList",
  "required": [
    "deleted",
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "radar.value_list"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "deleted": {
      "enum": [
        true
      ],
      "type": "boolean",
      "description": "Always true for a deleted object"
    }
  },
  "description": "",
  "x-resourceId": "deleted_radar.value_list",
  "x-expandableFields": []
}

object deleted_radar.value_list_item

{
  "type": "object",
  "title": "RadarListDeletedListItem",
  "required": [
    "deleted",
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "radar.value_list_item"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "deleted": {
      "enum": [
        true
      ],
      "type": "boolean",
      "description": "Always true for a deleted object"
    }
  },
  "description": "",
  "x-resourceId": "deleted_radar.value_list_item",
  "x-expandableFields": []
}

object deleted_subscription_item

{
  "type": "object",
  "title": "DeletedSubscriptionItem",
  "required": [
    "deleted",
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "subscription_item"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "deleted": {
      "enum": [
        true
      ],
      "type": "boolean",
      "description": "Always true for a deleted object"
    }
  },
  "description": "",
  "x-resourceId": "deleted_subscription_item",
  "x-expandableFields": []
}

object deleted_tax_id

{
  "type": "object",
  "title": "deleted_tax_id",
  "required": [
    "deleted",
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "tax_id"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "deleted": {
      "enum": [
        true
      ],
      "type": "boolean",
      "description": "Always true for a deleted object"
    }
  },
  "description": "",
  "x-resourceId": "deleted_tax_id",
  "x-expandableFields": []
}

object deleted_terminal.configuration

{
  "type": "object",
  "title": "TerminalConfigurationDeletedConfiguration",
  "required": [
    "deleted",
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "terminal.configuration"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "deleted": {
      "enum": [
        true
      ],
      "type": "boolean",
      "description": "Always true for a deleted object"
    }
  },
  "description": "",
  "x-resourceId": "deleted_terminal.configuration",
  "x-expandableFields": []
}

object deleted_terminal.location

{
  "type": "object",
  "title": "TerminalLocationDeletedLocation",
  "required": [
    "deleted",
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "terminal.location"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "deleted": {
      "enum": [
        true
      ],
      "type": "boolean",
      "description": "Always true for a deleted object"
    }
  },
  "description": "",
  "x-resourceId": "deleted_terminal.location",
  "x-expandableFields": []
}

object deleted_terminal.reader

{
  "type": "object",
  "title": "TerminalReaderDeletedReader",
  "required": [
    "deleted",
    "device_type",
    "id",
    "object",
    "serial_number"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "terminal.reader"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "deleted": {
      "enum": [
        true
      ],
      "type": "boolean",
      "description": "Always true for a deleted object"
    },
    "device_type": {
      "enum": [
        "bbpos_chipper2x",
        "bbpos_wisepad3",
        "bbpos_wisepos_e",
        "mobile_phone_reader",
        "simulated_stripe_s700",
        "simulated_stripe_s710",
        "simulated_wisepos_e",
        "stripe_m2",
        "stripe_s700",
        "stripe_s710",
        "verifone_P400"
      ],
      "type": "string",
      "description": "Device type of the reader.",
      "x-stripeBypassValidation": true
    },
    "serial_number": {
      "type": "string",
      "maxLength": 5000,
      "description": "Serial number of the reader."
    }
  },
  "description": "",
  "x-resourceId": "deleted_terminal.reader",
  "x-expandableFields": []
}

object deleted_test_helpers.test_clock

{
  "type": "object",
  "title": "DeletedTestClock",
  "required": [
    "deleted",
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "test_helpers.test_clock"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "deleted": {
      "enum": [
        true
      ],
      "type": "boolean",
      "description": "Always true for a deleted object"
    }
  },
  "description": "",
  "x-resourceId": "deleted_test_helpers.test_clock",
  "x-expandableFields": []
}

object deleted_webhook_endpoint

{
  "type": "object",
  "title": "NotificationWebhookEndpointDeleted",
  "required": [
    "deleted",
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "webhook_endpoint"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "deleted": {
      "enum": [
        true
      ],
      "type": "boolean",
      "description": "Always true for a deleted object"
    }
  },
  "description": "",
  "x-resourceId": "deleted_webhook_endpoint",
  "x-expandableFields": []
}

object destination_details_unimplemented

{
  "type": "object",
  "title": "destination_details_unimplemented",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object discount

{
  "type": "object",
  "title": "Discount",
  "required": [
    "id",
    "object",
    "source",
    "start"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array."
    },
    "end": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null."
    },
    "start": {
      "type": "integer",
      "format": "unix-time",
      "description": "Date that the coupon was applied."
    },
    "object": {
      "enum": [
        "discount"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "source": {
      "$ref": "#/components/schemas/discount_source"
    },
    "invoice": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice."
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        },
        {
          "$ref": "#/components/schemas/deleted_customer"
        }
      ],
      "nullable": true,
      "description": "The ID of the customer associated with this discount.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          },
          {
            "$ref": "#/components/schemas/deleted_customer"
          }
        ]
      }
    },
    "invoice_item": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item."
    },
    "subscription": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The subscription that this coupon is applied to, if it is applied to a particular subscription."
    },
    "promotion_code": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/promotion_code"
        }
      ],
      "nullable": true,
      "description": "The promotion code applied to create this discount.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/promotion_code"
          }
        ]
      }
    },
    "checkout_session": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode."
    },
    "customer_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The ID of the account representing the customer associated with this discount."
    },
    "subscription_item": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The subscription item that this coupon is applied to, if it is applied to a particular subscription item."
    }
  },
  "description": "A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes).\nIt contains information about when the discount began, when it will end, and what it is applied to.\n\nRelated guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts)",
  "x-resourceId": "discount",
  "x-expandableFields": [
    "customer",
    "promotion_code",
    "source"
  ]
}

object discount_source

{
  "type": "object",
  "title": "DiscountSource",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "coupon"
      ],
      "type": "string",
      "description": "The source type of the discount."
    },
    "coupon": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/coupon"
        }
      ],
      "nullable": true,
      "description": "The coupon that was redeemed to create this discount.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/coupon"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "coupon"
  ]
}

object discounts_resource_discount_amount

{
  "type": "object",
  "title": "DiscountsResourceDiscountAmount",
  "required": [
    "amount",
    "discount"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "The amount, in cents (or local equivalent), of the discount."
    },
    "discount": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/discount"
        },
        {
          "$ref": "#/components/schemas/deleted_discount"
        }
      ],
      "description": "The discount that was applied to get this discount amount.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/discount"
          },
          {
            "$ref": "#/components/schemas/deleted_discount"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "discount"
  ]
}

object discounts_resource_stackable_discount_with_discount_end

{
  "type": "object",
  "title": "DiscountsResourceStackableDiscountWithDiscountEnd",
  "properties": {
    "coupon": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/coupon"
        }
      ],
      "nullable": true,
      "description": "ID of the coupon to create a new discount for.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/coupon"
          }
        ]
      }
    },
    "discount": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/discount"
        }
      ],
      "nullable": true,
      "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/discount"
          }
        ]
      }
    },
    "promotion_code": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/promotion_code"
        }
      ],
      "nullable": true,
      "description": "ID of the promotion code to create a new discount for.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/promotion_code"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "coupon",
    "discount",
    "promotion_code"
  ]
}

object dispute

{
  "type": "object",
  "title": "Dispute",
  "required": [
    "amount",
    "balance_transactions",
    "charge",
    "created",
    "currency",
    "enhanced_eligibility_types",
    "evidence",
    "evidence_details",
    "id",
    "is_charge_refundable",
    "livemode",
    "metadata",
    "object",
    "reason",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "amount": {
      "type": "integer",
      "description": "Disputed amount. Usually the amount of the charge, but it can differ (usually because of currency fluctuation or because only part of the order is disputed)."
    },
    "charge": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/charge"
        }
      ],
      "description": "ID of the charge that's disputed.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/charge"
          }
        ]
      }
    },
    "object": {
      "enum": [
        "dispute"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "reason": {
      "type": "string",
      "maxLength": 5000,
      "description": "Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `noncompliant`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://docs.stripe.com/disputes/categories)."
    },
    "status": {
      "enum": [
        "lost",
        "needs_response",
        "prevented",
        "under_review",
        "warning_closed",
        "warning_needs_response",
        "warning_under_review",
        "won"
      ],
      "type": "string",
      "description": "The current status of a dispute. Possible values include:`warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, `lost`, or `prevented`.",
      "x-stripeBypassValidation": true
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "evidence": {
      "$ref": "#/components/schemas/dispute_evidence"
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "payment_intent": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_intent"
        }
      ],
      "nullable": true,
      "description": "ID of the PaymentIntent that's disputed.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_intent"
          }
        ]
      }
    },
    "evidence_details": {
      "$ref": "#/components/schemas/dispute_evidence_details"
    },
    "balance_transactions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/balance_transaction"
      },
      "description": "List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute."
    },
    "is_charge_refundable": {
      "type": "boolean",
      "description": "If true, it's still possible to refund the disputed payment. After the payment has been fully refunded, no further funds are withdrawn from your Stripe account as a result of this dispute."
    },
    "payment_method_details": {
      "$ref": "#/components/schemas/dispute_payment_method_details"
    },
    "enhanced_eligibility_types": {
      "type": "array",
      "items": {
        "enum": [
          "visa_compelling_evidence_3",
          "visa_compliance"
        ],
        "type": "string"
      },
      "description": "List of eligibility types that are included in `enhanced_evidence`."
    }
  },
  "description": "A dispute occurs when a customer questions your charge with their card issuer.\nWhen this happens, you have the opportunity to respond to the dispute with\nevidence that shows that the charge is legitimate.\n\nRelated guide: [Disputes and fraud](https://docs.stripe.com/disputes)",
  "x-resourceId": "dispute",
  "x-expandableFields": [
    "balance_transactions",
    "charge",
    "evidence",
    "evidence_details",
    "payment_intent",
    "payment_method_details"
  ]
}

object dispute_enhanced_eligibility

{
  "type": "object",
  "title": "DisputeEnhancedEligibility",
  "properties": {
    "visa_compliance": {
      "$ref": "#/components/schemas/dispute_enhanced_eligibility_visa_compliance"
    },
    "visa_compelling_evidence_3": {
      "$ref": "#/components/schemas/dispute_enhanced_eligibility_visa_compelling_evidence3"
    }
  },
  "description": "",
  "x-expandableFields": [
    "visa_compelling_evidence_3",
    "visa_compliance"
  ]
}

object dispute_enhanced_eligibility_visa_compelling_evidence3

{
  "type": "object",
  "title": "DisputeEnhancedEligibilityVisaCompellingEvidence3",
  "required": [
    "required_actions",
    "status"
  ],
  "properties": {
    "status": {
      "enum": [
        "not_qualified",
        "qualified",
        "requires_action"
      ],
      "type": "string",
      "description": "Visa Compelling Evidence 3.0 eligibility status."
    },
    "required_actions": {
      "type": "array",
      "items": {
        "enum": [
          "missing_customer_identifiers",
          "missing_disputed_transaction_description",
          "missing_merchandise_or_services",
          "missing_prior_undisputed_transaction_description",
          "missing_prior_undisputed_transactions"
        ],
        "type": "string"
      },
      "description": "List of actions required to qualify dispute for Visa Compelling Evidence 3.0 evidence submission."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object dispute_enhanced_eligibility_visa_compliance

{
  "type": "object",
  "title": "DisputeEnhancedEligibilityVisaCompliance",
  "required": [
    "status"
  ],
  "properties": {
    "status": {
      "enum": [
        "fee_acknowledged",
        "requires_fee_acknowledgement"
      ],
      "type": "string",
      "description": "Visa compliance eligibility status."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object dispute_enhanced_evidence

{
  "type": "object",
  "title": "DisputeEnhancedEvidence",
  "properties": {
    "visa_compliance": {
      "$ref": "#/components/schemas/dispute_enhanced_evidence_visa_compliance"
    },
    "visa_compelling_evidence_3": {
      "$ref": "#/components/schemas/dispute_enhanced_evidence_visa_compelling_evidence3"
    }
  },
  "description": "",
  "x-expandableFields": [
    "visa_compelling_evidence_3",
    "visa_compliance"
  ]
}

object dispute_enhanced_evidence_visa_compelling_evidence3

{
  "type": "object",
  "title": "DisputeEnhancedEvidenceVisaCompellingEvidence3",
  "required": [
    "prior_undisputed_transactions"
  ],
  "properties": {
    "disputed_transaction": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/dispute_visa_compelling_evidence3_disputed_transaction"
        }
      ],
      "nullable": true,
      "description": "Disputed transaction details for Visa Compelling Evidence 3.0 evidence submission."
    },
    "prior_undisputed_transactions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/dispute_visa_compelling_evidence3_prior_undisputed_transaction"
      },
      "description": "List of exactly two prior undisputed transaction objects for Visa Compelling Evidence 3.0 evidence submission."
    }
  },
  "description": "",
  "x-expandableFields": [
    "disputed_transaction",
    "prior_undisputed_transactions"
  ]
}

object dispute_enhanced_evidence_visa_compliance

{
  "type": "object",
  "title": "DisputeEnhancedEvidenceVisaCompliance",
  "required": [
    "fee_acknowledged"
  ],
  "properties": {
    "fee_acknowledged": {
      "type": "boolean",
      "description": "A field acknowledging the fee incurred when countering a Visa compliance dispute. If this field is set to true, evidence can be submitted for the compliance dispute. Stripe collects a 500 USD (or local equivalent) amount to cover the network costs associated with resolving compliance disputes. Stripe refunds the 500 USD network fee if you win the dispute."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object dispute_evidence

{
  "type": "object",
  "title": "DisputeEvidence",
  "required": [
    "enhanced_evidence"
  ],
  "properties": {
    "receipt": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message sent to the customer notifying them of the charge.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    },
    "service_date": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The date on which the customer received or began receiving the purchased service, in a clear human-readable format."
    },
    "customer_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The name of the customer."
    },
    "refund_policy": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    },
    "shipping_date": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The date on which a physical product began its route to the shipping address, in a clear human-readable format."
    },
    "billing_address": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The billing address provided by the customer."
    },
    "shipping_address": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The address to which a physical product was shipped. You should try to include as complete address information as possible."
    },
    "shipping_carrier": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas."
    },
    "enhanced_evidence": {
      "$ref": "#/components/schemas/dispute_enhanced_evidence"
    },
    "customer_signature": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    },
    "uncategorized_file": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    },
    "uncategorized_text": {
      "type": "string",
      "nullable": true,
      "maxLength": 150000,
      "description": "Any additional evidence or statements."
    },
    "access_activity_log": {
      "type": "string",
      "nullable": true,
      "maxLength": 150000,
      "description": "Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity."
    },
    "cancellation_policy": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    },
    "duplicate_charge_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge."
    },
    "product_description": {
      "type": "string",
      "nullable": true,
      "maxLength": 150000,
      "description": "A description of the product or service that was sold."
    },
    "customer_purchase_ip": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The IP address that the customer used when making the purchase."
    },
    "cancellation_rebuttal": {
      "type": "string",
      "nullable": true,
      "maxLength": 150000,
      "description": "A justification for why the customer's subscription was not canceled."
    },
    "service_documentation": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    },
    "customer_communication": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    },
    "customer_email_address": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The email address of the customer."
    },
    "shipping_documentation": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer's full shipping address, if possible.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    },
    "refund_policy_disclosure": {
      "type": "string",
      "nullable": true,
      "maxLength": 150000,
      "description": "Documentation demonstrating that the customer was shown your refund policy prior to purchase."
    },
    "shipping_tracking_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas."
    },
    "refund_refusal_explanation": {
      "type": "string",
      "nullable": true,
      "maxLength": 150000,
      "description": "A justification for why the customer is not entitled to a refund."
    },
    "duplicate_charge_explanation": {
      "type": "string",
      "nullable": true,
      "maxLength": 150000,
      "description": "An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate."
    },
    "cancellation_policy_disclosure": {
      "type": "string",
      "nullable": true,
      "maxLength": 150000,
      "description": "An explanation of how and when the customer was shown your refund policy prior to purchase."
    },
    "duplicate_charge_documentation": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "cancellation_policy",
    "customer_communication",
    "customer_signature",
    "duplicate_charge_documentation",
    "enhanced_evidence",
    "receipt",
    "refund_policy",
    "service_documentation",
    "shipping_documentation",
    "uncategorized_file"
  ]
}

object dispute_evidence_details

{
  "type": "object",
  "title": "DisputeEvidenceDetails",
  "required": [
    "enhanced_eligibility",
    "has_evidence",
    "past_due",
    "submission_count"
  ],
  "properties": {
    "due_by": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Date by which evidence must be submitted in order to successfully challenge dispute. Will be 0 if the customer's bank or credit card company doesn't allow a response for this particular dispute."
    },
    "past_due": {
      "type": "boolean",
      "description": "Whether the last evidence submission was submitted past the due date. Defaults to `false` if no evidence submissions have occurred. If `true`, then delivery of the latest evidence is *not* guaranteed."
    },
    "has_evidence": {
      "type": "boolean",
      "description": "Whether evidence has been staged for this dispute."
    },
    "submission_count": {
      "type": "integer",
      "description": "The number of times evidence has been submitted. Typically, you may only submit evidence once."
    },
    "enhanced_eligibility": {
      "$ref": "#/components/schemas/dispute_enhanced_eligibility"
    }
  },
  "description": "",
  "x-expandableFields": [
    "enhanced_eligibility"
  ]
}

object dispute_payment_method_details

{
  "type": "object",
  "title": "DisputePaymentMethodDetails",
  "required": [
    "type"
  ],
  "properties": {
    "card": {
      "$ref": "#/components/schemas/dispute_payment_method_details_card"
    },
    "type": {
      "enum": [
        "amazon_pay",
        "card",
        "klarna",
        "paypal"
      ],
      "type": "string",
      "description": "Payment method type."
    },
    "klarna": {
      "$ref": "#/components/schemas/dispute_payment_method_details_klarna"
    },
    "paypal": {
      "$ref": "#/components/schemas/dispute_payment_method_details_paypal"
    },
    "amazon_pay": {
      "$ref": "#/components/schemas/dispute_payment_method_details_amazon_pay"
    }
  },
  "description": "",
  "x-expandableFields": [
    "amazon_pay",
    "card",
    "klarna",
    "paypal"
  ]
}

object dispute_payment_method_details_amazon_pay

{
  "type": "object",
  "title": "DisputePaymentMethodDetailsAmazonPay",
  "properties": {
    "dispute_type": {
      "enum": [
        "chargeback",
        "claim"
      ],
      "type": "string",
      "nullable": true,
      "description": "The AmazonPay dispute type, chargeback or claim"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object dispute_payment_method_details_card

{
  "type": "object",
  "title": "DisputePaymentMethodDetailsCard",
  "required": [
    "brand",
    "case_type"
  ],
  "properties": {
    "brand": {
      "type": "string",
      "maxLength": 5000,
      "description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`."
    },
    "case_type": {
      "enum": [
        "block",
        "chargeback",
        "compliance",
        "inquiry",
        "resolution"
      ],
      "type": "string",
      "description": "The type of dispute opened. Different case types may have varying fees and financial impact."
    },
    "network_reason_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The card network's specific dispute reason code, which maps to one of Stripe's primary dispute categories to simplify response guidance. The [Network code map](https://stripe.com/docs/disputes/categories#network-code-map) lists all available dispute reason codes by network."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object dispute_payment_method_details_klarna

{
  "type": "object",
  "title": "DisputePaymentMethodDetailsKlarna",
  "properties": {
    "reason_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The reason for the dispute as defined by Klarna"
    },
    "chargeback_loss_reason_code": {
      "type": "string",
      "maxLength": 5000,
      "description": "Chargeback loss reason mapped by Stripe from Klarna's chargeback loss reason"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object dispute_payment_method_details_paypal

{
  "type": "object",
  "title": "DisputePaymentMethodDetailsPaypal",
  "properties": {
    "case_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The ID of the dispute in PayPal."
    },
    "reason_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The reason for the dispute as defined by PayPal"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object dispute_transaction_shipping_address

{
  "type": "object",
  "title": "DisputeTransactionShippingAddress",
  "properties": {
    "city": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "City, district, suburb, town, or village."
    },
    "line1": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Address line 1, such as the street, PO Box, or company name."
    },
    "line2": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Address line 2, such as the apartment, suite, unit, or building."
    },
    "state": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."
    },
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."
    },
    "postal_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ZIP or postal code."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object dispute_visa_compelling_evidence3_disputed_transaction

{
  "type": "object",
  "title": "DisputeVisaCompellingEvidence3DisputedTransaction",
  "properties": {
    "shipping_address": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/dispute_transaction_shipping_address"
        }
      ],
      "nullable": true,
      "description": "The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission."
    },
    "customer_device_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters."
    },
    "customer_account_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "User Account ID used to log into business platform. Must be recognizable by the user."
    },
    "product_description": {
      "type": "string",
      "nullable": true,
      "maxLength": 150000,
      "description": "A description of the product or service that was sold."
    },
    "customer_purchase_ip": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The IP address that the customer used when making the purchase."
    },
    "customer_email_address": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The email address of the customer."
    },
    "merchandise_or_services": {
      "enum": [
        "merchandise",
        "services"
      ],
      "type": "string",
      "nullable": true,
      "description": "Categorization of disputed payment."
    },
    "customer_device_fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters."
    }
  },
  "description": "",
  "x-expandableFields": [
    "shipping_address"
  ]
}

object dispute_visa_compelling_evidence3_prior_undisputed_transaction

{
  "type": "object",
  "title": "DisputeVisaCompellingEvidence3PriorUndisputedTransaction",
  "required": [
    "charge"
  ],
  "properties": {
    "charge": {
      "type": "string",
      "maxLength": 5000,
      "description": "Stripe charge ID for the Visa Compelling Evidence 3.0 eligible prior charge."
    },
    "shipping_address": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/dispute_transaction_shipping_address"
        }
      ],
      "nullable": true,
      "description": "The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission."
    },
    "customer_device_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters."
    },
    "customer_account_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "User Account ID used to log into business platform. Must be recognizable by the user."
    },
    "product_description": {
      "type": "string",
      "nullable": true,
      "maxLength": 150000,
      "description": "A description of the product or service that was sold."
    },
    "customer_purchase_ip": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The IP address that the customer used when making the purchase."
    },
    "customer_email_address": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The email address of the customer."
    },
    "customer_device_fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters."
    }
  },
  "description": "",
  "x-expandableFields": [
    "shipping_address"
  ]
}

object email_sent

{
  "type": "object",
  "title": "EmailSent",
  "required": [
    "email_sent_at",
    "email_sent_to"
  ],
  "properties": {
    "email_sent_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "The timestamp when the email was sent."
    },
    "email_sent_to": {
      "type": "string",
      "maxLength": 5000,
      "description": "The recipient's email address."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object entitlements.active_entitlement

{
  "type": "object",
  "title": "ActiveEntitlement",
  "required": [
    "feature",
    "id",
    "livemode",
    "lookup_key",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "entitlements.active_entitlement"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "feature": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/entitlements.feature"
        }
      ],
      "description": "The [Feature](https://docs.stripe.com/api/entitlements/feature) that the customer is entitled to.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/entitlements.feature"
          }
        ]
      }
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "lookup_key": {
      "type": "string",
      "maxLength": 5000,
      "description": "A unique key you provide as your own system identifier. This may be up to 80 characters."
    }
  },
  "description": "An active entitlement describes access to a feature for a customer.",
  "x-resourceId": "entitlements.active_entitlement",
  "x-expandableFields": [
    "feature"
  ]
}

object entitlements.feature

{
  "type": "object",
  "title": "Feature",
  "required": [
    "active",
    "id",
    "livemode",
    "lookup_key",
    "metadata",
    "name",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "name": {
      "type": "string",
      "maxLength": 80,
      "description": "The feature's name, for your own purpose, not meant to be displayable to the customer."
    },
    "active": {
      "type": "boolean",
      "description": "Inactive features cannot be attached to new products and will not be returned from the features list endpoint."
    },
    "object": {
      "enum": [
        "entitlements.feature"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "lookup_key": {
      "type": "string",
      "maxLength": 5000,
      "description": "A unique key you provide as your own system identifier. This may be up to 80 characters."
    }
  },
  "description": "A feature represents a monetizable ability or functionality in your system.\nFeatures can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer.",
  "x-resourceId": "entitlements.feature",
  "x-expandableFields": []
}

object ephemeral_key

{
  "type": "object",
  "title": "EphemeralKey",
  "required": [
    "created",
    "expires",
    "id",
    "livemode",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "ephemeral_key"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "secret": {
      "type": "string",
      "maxLength": 5000,
      "description": "The key's secret. You can use this value to make authorized requests to the Stripe API."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "expires": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the key will expire. Measured in seconds since the Unix epoch."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    }
  },
  "description": "",
  "x-resourceId": "ephemeral_key",
  "x-expandableFields": []
}

object error

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "$ref": "#/components/schemas/api_errors"
    }
  },
  "description": "An error response from the Stripe API"
}

object event

{
  "type": "object",
  "title": "NotificationEvent",
  "required": [
    "created",
    "data",
    "id",
    "livemode",
    "object",
    "pending_webhooks",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "data": {
      "$ref": "#/components/schemas/notification_event_data"
    },
    "type": {
      "type": "string",
      "maxLength": 5000,
      "description": "Description of the event (for example, `invoice.created` or `charge.refunded`)."
    },
    "object": {
      "enum": [
        "event"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "account": {
      "type": "string",
      "maxLength": 5000,
      "description": "The connected account that originates the event."
    },
    "context": {
      "type": "string",
      "maxLength": 5000,
      "description": "Authentication context needed to fetch the event or related object."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "request": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/notification_event_request"
        }
      ],
      "nullable": true,
      "description": "Information on the API request that triggers the event."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "api_version": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Stripe API version used to render `data` when the event was created. The contents of `data` never change, so this value remains static regardless of the API version currently in use. This property is populated only for events created on or after October 31, 2014."
    },
    "pending_webhooks": {
      "type": "integer",
      "description": "Number of webhooks that haven't been successfully delivered (for example, to return a 20x response) to the URLs you specify."
    }
  },
  "description": "Snapshot events allow you to track and react to activity in your Stripe integration. When\nthe state of another API resource changes, Stripe creates an `Event` object that contains\nall the relevant information associated with that action, including the affected API\nresource. For example, a successful payment triggers a `charge.succeeded` event, which\ncontains the `Charge` in the event's data property. Some actions trigger multiple events.\nFor example, if you create a new subscription for a customer, it triggers both a\n`customer.subscription.created` event and a `charge.succeeded` event.\n\nConfigure an event destination in your account to listen for events that represent actions\nyour integration needs to respond to. Additionally, you can retrieve an individual event or\na list of events from the API.\n\n[Connect](https://docs.stripe.com/connect) platforms can also receive event notifications\nthat occur in their connected accounts. These events include an account attribute that\nidentifies the relevant connected account.\n\nYou can access events through the [Retrieve Event API](https://docs.stripe.com/api/events#retrieve_event)\nfor 30 days.",
  "x-resourceId": "event",
  "x-expandableFields": [
    "data",
    "request"
  ]
}

object exchange_rate

{
  "type": "object",
  "title": "ExchangeRate",
  "required": [
    "id",
    "object",
    "rates"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object. Represented as the three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) in lowercase."
    },
    "rates": {
      "type": "object",
      "description": "Hash where the keys are supported currencies and the values are the exchange rate at which the base id currency converts to the key currency.",
      "additionalProperties": {
        "type": "number"
      }
    },
    "object": {
      "enum": [
        "exchange_rate"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    }
  },
  "description": "[Deprecated] The `ExchangeRate` APIs are deprecated. Please use the [FX Quotes API](https://docs.stripe.com/payments/currencies/localize-prices/fx-quotes-api) instead.\n\n`ExchangeRate` objects allow you to determine the rates that Stripe is currently\nusing to convert from one currency to another. Since this number is variable\nthroughout the day, there are various reasons why you might want to know the current\nrate (for example, to dynamically price an item for a user with a default\npayment in a foreign currency).\n\nPlease refer to our [Exchange Rates API](https://docs.stripe.com/fx-rates) guide for more details.\n\n*[Note: this integration path is supported but no longer recommended]* Additionally,\nyou can guarantee that a charge is made with an exchange rate that you expect is\ncurrent. To do so, you must pass in the exchange_rate to charges endpoints. If the\nvalue is no longer up to date, the charge won't go through. Please refer to our\n[Using with charges](https://docs.stripe.com/exchange-rates) guide for more details.\n\n-----\n\n&nbsp;\n\n*This Exchange Rates API is a Beta Service and is subject to Stripe's terms of service. You may use the API solely for the purpose of transacting on Stripe. For example, the API may be queried in order to:*\n\n- *localize prices for processing payments on Stripe*\n- *reconcile Stripe transactions*\n- *determine how much money to send to a connected account*\n- *determine app fees to charge a connected account*\n\n*Using this Exchange Rates API beta for any purpose other than to transact on Stripe is strictly prohibited and constitutes a violation of Stripe's terms of service.*",
  "x-resourceId": "exchange_rate",
  "x-expandableFields": []
}

object external_account

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/bank_account"
    },
    {
      "$ref": "#/components/schemas/card"
    }
  ],
  "title": "Polymorphic",
  "x-resourceId": "external_account",
  "x-stripeBypassValidation": true
}

object external_account_requirements

{
  "type": "object",
  "title": "ExternalAccountRequirements",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/account_requirements_error"
      },
      "nullable": true,
      "description": "Details about validation and verification failures for `due` requirements that must be resolved."
    },
    "past_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the external account."
    },
    "currently_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "Fields that need to be resolved to keep the external account enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled."
    },
    "pending_verification": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending."
    }
  },
  "description": "",
  "x-expandableFields": [
    "errors"
  ]
}

object fee

{
  "type": "object",
  "title": "Fee",
  "required": [
    "amount",
    "currency",
    "type"
  ],
  "properties": {
    "type": {
      "type": "string",
      "maxLength": 5000,
      "description": "Type of the fee, one of: `application_fee`, `payment_method_passthrough_fee`, `stripe_fee` or `tax`."
    },
    "amount": {
      "type": "integer",
      "description": "Amount of the fee, in cents."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "application": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the Connect application that earned the fee."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An arbitrary string attached to the object. Often useful for displaying to users."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object fee_refund

{
  "type": "object",
  "title": "FeeRefund",
  "required": [
    "amount",
    "created",
    "currency",
    "fee",
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "fee": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/application_fee"
        }
      ],
      "description": "ID of the application fee that was refunded.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/application_fee"
          }
        ]
      }
    },
    "amount": {
      "type": "integer",
      "description": "Amount, in cents (or local equivalent)."
    },
    "object": {
      "enum": [
        "fee_refund"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "balance_transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/balance_transaction"
        }
      ],
      "nullable": true,
      "description": "Balance transaction that describes the impact on your account balance.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/balance_transaction"
          }
        ]
      }
    }
  },
  "description": "`Application Fee Refund` objects allow you to refund an application fee that\nhas previously been created but not yet refunded. Funds will be refunded to\nthe Stripe account from which the fee was originally collected.\n\nRelated guide: [Refunding application fees](https://docs.stripe.com/connect/destination-charges#refunding-app-fee)",
  "x-resourceId": "fee_refund",
  "x-expandableFields": [
    "balance_transaction",
    "fee"
  ]
}

object file

{
  "type": "object",
  "title": "File",
  "required": [
    "created",
    "id",
    "object",
    "purpose",
    "size"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Use your live secret API key to download the file from this URL."
    },
    "size": {
      "type": "integer",
      "description": "The size of the file object in bytes."
    },
    "type": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`)."
    },
    "links": {
      "type": "object",
      "title": "FileResourceFileLinkList",
      "nullable": true,
      "required": [
        "data",
        "has_more",
        "object",
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "pattern": "^/v1/file_links",
          "maxLength": 5000,
          "description": "The URL where this list can be accessed."
        },
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/file_link"
          },
          "description": "Details about each object."
        },
        "object": {
          "enum": [
            "list"
          ],
          "type": "string",
          "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
        },
        "has_more": {
          "type": "boolean",
          "description": "True if this list has another page of items after this one that can be fetched."
        }
      },
      "description": "A list of [file links](https://api.stripe.com#file_links) that point at this file.",
      "x-expandableFields": [
        "data"
      ]
    },
    "title": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A suitable title for the document."
    },
    "object": {
      "enum": [
        "file"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "purpose": {
      "enum": [
        "account_requirement",
        "additional_verification",
        "business_icon",
        "business_logo",
        "customer_signature",
        "dispute_evidence",
        "document_provider_identity_document",
        "finance_report_run",
        "financial_account_statement",
        "identity_document",
        "identity_document_downloadable",
        "issuing_regulatory_reporting",
        "pci_document",
        "platform_terms_of_service",
        "selfie",
        "sigma_scheduled_query",
        "tax_document_user_upload",
        "terminal_android_apk",
        "terminal_reader_splashscreen",
        "terminal_wifi_certificate",
        "terminal_wifi_private_key"
      ],
      "type": "string",
      "description": "The [purpose](https://docs.stripe.com/file-upload#uploading-a-file) of the uploaded file.",
      "x-stripeBypassValidation": true
    },
    "filename": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The suitable name for saving the file to a filesystem."
    },
    "expires_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The file expires and isn't available at this time in epoch seconds."
    }
  },
  "description": "This object represents files hosted on Stripe's servers. You can upload\nfiles with the [create file](https://api.stripe.com#create_file) request\n(for example, when uploading dispute evidence). Stripe also\ncreates files independently (for example, the results of a [Sigma scheduled\nquery](#scheduled_queries)).\n\nRelated guide: [File upload guide](https://docs.stripe.com/file-upload)",
  "x-resourceId": "file",
  "x-expandableFields": [
    "links"
  ]
}

object file_link

{
  "type": "object",
  "title": "FileLink",
  "required": [
    "created",
    "expired",
    "file",
    "id",
    "livemode",
    "metadata",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The publicly accessible URL to download the file."
    },
    "file": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "description": "The file object this link points to.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    },
    "object": {
      "enum": [
        "file_link"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "expired": {
      "type": "boolean",
      "description": "Returns if the link is already expired."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "expires_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Time that the link expires."
    }
  },
  "description": "To share the contents of a `File` object with non-Stripe users, you can\ncreate a `FileLink`. `FileLink`s contain a URL that you can use to\nretrieve the contents of the file without authentication.",
  "x-resourceId": "file_link",
  "x-expandableFields": [
    "file"
  ]
}

object financial_connections.account

{
  "type": "object",
  "title": "BankConnectionsResourceLinkedAccount",
  "required": [
    "category",
    "created",
    "id",
    "institution_name",
    "livemode",
    "object",
    "status",
    "subcategory",
    "supported_payment_method_types"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The last 4 digits of the account number. If present, this will be 4 numeric characters."
    },
    "object": {
      "enum": [
        "financial_connections.account"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "active",
        "disconnected",
        "inactive"
      ],
      "type": "string",
      "description": "The status of the link to the account."
    },
    "balance": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/bank_connections_resource_balance"
        }
      ],
      "nullable": true,
      "description": "The most recent information about the account's balance."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "category": {
      "enum": [
        "cash",
        "credit",
        "investment",
        "other"
      ],
      "type": "string",
      "description": "The type of the account. Account category is further divided in `subcategory`."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "ownership": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/financial_connections.account_ownership"
        }
      ],
      "nullable": true,
      "description": "The most recent information about the account's owners.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/financial_connections.account_ownership"
          }
        ]
      }
    },
    "permissions": {
      "type": "array",
      "items": {
        "enum": [
          "balances",
          "ownership",
          "payment_method",
          "transactions"
        ],
        "type": "string",
        "x-stripeBypassValidation": true
      },
      "nullable": true,
      "description": "The list of permissions granted by this account."
    },
    "subcategory": {
      "enum": [
        "checking",
        "credit_card",
        "line_of_credit",
        "mortgage",
        "other",
        "savings"
      ],
      "type": "string",
      "description": "If `category` is `cash`, one of:\n\n - `checking`\n - `savings`\n - `other`\n\nIf `category` is `credit`, one of:\n\n - `mortgage`\n - `line_of_credit`\n - `credit_card`\n - `other`\n\nIf `category` is `investment` or `other`, this will be `other`."
    },
    "display_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A human-readable name that has been assigned to this account, either by the account holder or by the institution."
    },
    "subscriptions": {
      "type": "array",
      "items": {
        "enum": [
          "transactions"
        ],
        "type": "string",
        "x-stripeBypassValidation": true
      },
      "nullable": true,
      "description": "The list of data refresh subscriptions requested on this account."
    },
    "account_holder": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/bank_connections_resource_accountholder"
        }
      ],
      "nullable": true,
      "description": "The account holder that this account belongs to."
    },
    "account_numbers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/bank_connections_resource_account_number_details"
      },
      "nullable": true,
      "description": "Details about the account numbers."
    },
    "balance_refresh": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/bank_connections_resource_balance_refresh"
        }
      ],
      "nullable": true,
      "description": "The state of the most recent attempt to refresh the account balance."
    },
    "institution_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The name of the institution that holds this account."
    },
    "ownership_refresh": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/bank_connections_resource_ownership_refresh"
        }
      ],
      "nullable": true,
      "description": "The state of the most recent attempt to refresh the account owners."
    },
    "transaction_refresh": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/bank_connections_resource_transaction_refresh"
        }
      ],
      "nullable": true,
      "description": "The state of the most recent attempt to refresh the account transactions."
    },
    "supported_payment_method_types": {
      "type": "array",
      "items": {
        "enum": [
          "link",
          "us_bank_account"
        ],
        "type": "string",
        "x-stripeBypassValidation": true
      },
      "description": "The [PaymentMethod type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account."
    }
  },
  "description": "A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.",
  "x-resourceId": "financial_connections.account",
  "x-expandableFields": [
    "account_holder",
    "account_numbers",
    "balance",
    "balance_refresh",
    "ownership",
    "ownership_refresh",
    "transaction_refresh"
  ]
}

object financial_connections.account_owner

{
  "type": "object",
  "title": "BankConnectionsResourceOwner",
  "required": [
    "id",
    "name",
    "object",
    "ownership"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The full name of the owner."
    },
    "email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The email address of the owner."
    },
    "phone": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The raw phone number of the owner."
    },
    "object": {
      "enum": [
        "financial_connections.account_owner"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "ownership": {
      "type": "string",
      "maxLength": 5000,
      "description": "The ownership object that this owner belongs to."
    },
    "raw_address": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The raw physical address of the owner."
    },
    "refreshed_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The timestamp of the refresh that updated this owner."
    }
  },
  "description": "Describes an owner of an account.",
  "x-resourceId": "financial_connections.account_owner",
  "x-expandableFields": []
}

object financial_connections.account_ownership

{
  "type": "object",
  "title": "BankConnectionsResourceOwnership",
  "required": [
    "created",
    "id",
    "object",
    "owners"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "financial_connections.account_ownership"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "owners": {
      "type": "object",
      "title": "BankConnectionsResourceOwnerList",
      "required": [
        "data",
        "has_more",
        "object",
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "maxLength": 5000,
          "description": "The URL where this list can be accessed."
        },
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/financial_connections.account_owner"
          },
          "description": "Details about each object."
        },
        "object": {
          "enum": [
            "list"
          ],
          "type": "string",
          "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
        },
        "has_more": {
          "type": "boolean",
          "description": "True if this list has another page of items after this one that can be fetched."
        }
      },
      "description": "A paginated list of owners for this account.",
      "x-expandableFields": [
        "data"
      ]
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    }
  },
  "description": "Describes a snapshot of the owners of an account at a particular point in time.",
  "x-expandableFields": [
    "owners"
  ]
}

object financial_connections.session

{
  "type": "object",
  "title": "BankConnectionsResourceLinkAccountSession",
  "required": [
    "accounts",
    "id",
    "livemode",
    "object",
    "permissions"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "financial_connections.session"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "filters": {
      "$ref": "#/components/schemas/bank_connections_resource_link_account_session_filters"
    },
    "accounts": {
      "type": "object",
      "title": "BankConnectionsResourceLinkedAccountList",
      "required": [
        "data",
        "has_more",
        "object",
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "pattern": "^/v1/financial_connections/accounts",
          "maxLength": 5000,
          "description": "The URL where this list can be accessed."
        },
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/financial_connections.account"
          },
          "description": "Details about each object."
        },
        "object": {
          "enum": [
            "list"
          ],
          "type": "string",
          "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
        },
        "has_more": {
          "type": "boolean",
          "description": "True if this list has another page of items after this one that can be fetched."
        }
      },
      "description": "The accounts that were collected as part of this Session.",
      "x-expandableFields": [
        "data"
      ]
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "prefetch": {
      "type": "array",
      "items": {
        "enum": [
          "balances",
          "ownership",
          "transactions"
        ],
        "type": "string",
        "x-stripeBypassValidation": true
      },
      "nullable": true,
      "description": "Data features requested to be retrieved upon account creation."
    },
    "return_url": {
      "type": "string",
      "maxLength": 5000,
      "description": "For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app."
    },
    "permissions": {
      "type": "array",
      "items": {
        "enum": [
          "balances",
          "ownership",
          "payment_method",
          "transactions"
        ],
        "type": "string",
        "x-stripeBypassValidation": true
      },
      "description": "Permissions requested for accounts collected during this session."
    },
    "client_secret": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A value that will be passed to the client to launch the authentication flow."
    },
    "account_holder": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/bank_connections_resource_accountholder"
        }
      ],
      "nullable": true,
      "description": "The account holder for whom accounts are collected in this session."
    }
  },
  "description": "A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.",
  "x-resourceId": "financial_connections.session",
  "x-expandableFields": [
    "account_holder",
    "accounts",
    "filters"
  ]
}

object financial_connections.transaction

{
  "type": "object",
  "title": "BankConnectionsResourceTransaction",
  "required": [
    "account",
    "amount",
    "currency",
    "description",
    "id",
    "livemode",
    "object",
    "status",
    "status_transitions",
    "transacted_at",
    "transaction_refresh",
    "updated"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "amount": {
      "type": "integer",
      "description": "The amount of this transaction, in cents (or local equivalent)."
    },
    "object": {
      "enum": [
        "financial_connections.transaction"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "pending",
        "posted",
        "void"
      ],
      "type": "string",
      "description": "The status of the transaction."
    },
    "account": {
      "type": "string",
      "maxLength": 5000,
      "description": "The ID of the Financial Connections Account this transaction belongs to."
    },
    "updated": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch."
    },
    "currency": {
      "type": "string",
      "maxLength": 5000,
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "description": {
      "type": "string",
      "maxLength": 5000,
      "description": "The description of this transaction."
    },
    "transacted_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the transaction was transacted. Measured in seconds since the Unix epoch."
    },
    "status_transitions": {
      "$ref": "#/components/schemas/bank_connections_resource_transaction_resource_status_transitions"
    },
    "transaction_refresh": {
      "type": "string",
      "maxLength": 5000,
      "description": "The token of the transaction refresh that last updated or created this transaction."
    }
  },
  "description": "A Transaction represents a real transaction that affects a Financial Connections Account balance.",
  "x-resourceId": "financial_connections.transaction",
  "x-expandableFields": [
    "status_transitions"
  ]
}

object financial_reporting_finance_report_run_run_parameters

{
  "type": "object",
  "title": "FinancialReportingFinanceReportRunRunParameters",
  "properties": {
    "payout": {
      "type": "string",
      "maxLength": 5000,
      "description": "Payout ID by which to filter the report run."
    },
    "columns": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "The set of output columns requested for inclusion in the report run."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Currency of objects to be included in the report run."
    },
    "timezone": {
      "type": "string",
      "maxLength": 5000,
      "description": "Defaults to `Etc/UTC`. The output timezone for all timestamps in the report. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). Has no effect on `interval_start` or `interval_end`."
    },
    "interval_end": {
      "type": "integer",
      "format": "unix-time",
      "description": "Ending timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after the user specified `interval_start` and 1 second before this report's last `data_available_end` value."
    },
    "interval_start": {
      "type": "integer",
      "format": "unix-time",
      "description": "Starting timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after this report's `data_available_start` and 1 second before the user specified `interval_end` value."
    },
    "connected_account": {
      "type": "string",
      "maxLength": 5000,
      "description": "Connected account ID by which to filter the report run."
    },
    "reporting_category": {
      "type": "string",
      "maxLength": 5000,
      "description": "Category of balance transactions to be included in the report run."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object forwarded_request_context

{
  "type": "object",
  "title": "ForwardedRequestContext",
  "required": [
    "destination_duration",
    "destination_ip_address"
  ],
  "properties": {
    "destination_duration": {
      "type": "integer",
      "description": "The time it took in milliseconds for the destination endpoint to respond."
    },
    "destination_ip_address": {
      "type": "string",
      "maxLength": 5000,
      "description": "The IP address of the destination."
    }
  },
  "description": "Metadata about the forwarded request.",
  "x-expandableFields": []
}

object forwarded_request_details

{
  "type": "object",
  "title": "ForwardedRequestDetails",
  "required": [
    "body",
    "headers",
    "http_method"
  ],
  "properties": {
    "body": {
      "type": "string",
      "maxLength": 5000,
      "description": "The body payload to send to the destination endpoint."
    },
    "headers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/forwarded_request_header"
      },
      "description": "The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included."
    },
    "http_method": {
      "enum": [
        "POST"
      ],
      "type": "string",
      "description": "The HTTP method used to call the destination endpoint."
    }
  },
  "description": "Details about the request forwarded to the destination endpoint.",
  "x-expandableFields": [
    "headers"
  ]
}

object forwarded_request_header

{
  "type": "object",
  "title": "ForwardedRequestHeader",
  "required": [
    "name",
    "value"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The header name."
    },
    "value": {
      "type": "string",
      "maxLength": 5000,
      "description": "The header value."
    }
  },
  "description": "Header data.",
  "x-expandableFields": []
}

object forwarded_response_details

{
  "type": "object",
  "title": "ForwardedResponseDetails",
  "required": [
    "body",
    "headers",
    "status"
  ],
  "properties": {
    "body": {
      "type": "string",
      "maxLength": 5000,
      "description": "The response body from the destination endpoint to Stripe."
    },
    "status": {
      "type": "integer",
      "description": "The HTTP status code that the destination endpoint returned."
    },
    "headers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/forwarded_request_header"
      },
      "description": "HTTP headers that the destination endpoint returned."
    }
  },
  "description": "Details about the response from the destination endpoint.",
  "x-expandableFields": [
    "headers"
  ]
}

object forwarding.request

{
  "type": "object",
  "title": "ForwardingRequest",
  "required": [
    "created",
    "id",
    "livemode",
    "object",
    "payment_method",
    "replacements"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The destination URL for the forwarded request. Must be supported by the config."
    },
    "object": {
      "enum": [
        "forwarding.request"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "replacements": {
      "type": "array",
      "items": {
        "enum": [
          "card_cvc",
          "card_expiry",
          "card_number",
          "cardholder_name",
          "request_signature"
        ],
        "type": "string",
        "x-stripeBypassValidation": true
      },
      "description": "The field kinds to be replaced in the forwarded request."
    },
    "payment_method": {
      "type": "string",
      "maxLength": 5000,
      "description": "The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed."
    },
    "request_context": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/forwarded_request_context"
        }
      ],
      "nullable": true,
      "description": "Context about the request from Stripe's servers to the destination endpoint."
    },
    "request_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/forwarded_request_details"
        }
      ],
      "nullable": true,
      "description": "The request that was sent to the destination endpoint. We redact any sensitive fields."
    },
    "response_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/forwarded_response_details"
        }
      ],
      "nullable": true,
      "description": "The response that the destination endpoint returned to us. We redact any sensitive fields."
    }
  },
  "description": "Instructs Stripe to make a request on your behalf using the destination URL. The destination URL\nis activated by Stripe at the time of onboarding. Stripe verifies requests with your credentials\nprovided during onboarding, and injects card details from the payment_method into the request.\n\nStripe redacts all sensitive fields and headers, including authentication credentials and card numbers,\nbefore storing the request and response data in the forwarding Request object, which are subject to a\n30-day retention period.\n\nYou can provide a Stripe idempotency key to make sure that requests with the same key result in only one\noutbound request. The Stripe idempotency key provided should be unique and different from any idempotency\nkeys provided on the underlying third-party request.\n\nForwarding Requests are synchronous requests that return a response or time out according to\nStripe’s limits.\n\nRelated guide: [Forward card details to third-party API endpoints](https://docs.stripe.com/payments/forwarding).",
  "x-resourceId": "forwarding.request",
  "x-expandableFields": [
    "request_context",
    "request_details",
    "response_details"
  ]
}

object funding_instructions

{
  "type": "object",
  "title": "CustomerBalanceFundingInstructionsCustomerBalanceFundingInstructions",
  "required": [
    "bank_transfer",
    "currency",
    "funding_type",
    "livemode",
    "object"
  ],
  "properties": {
    "object": {
      "enum": [
        "funding_instructions"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "currency": {
      "type": "string",
      "maxLength": 5000,
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "funding_type": {
      "enum": [
        "bank_transfer"
      ],
      "type": "string",
      "description": "The `funding_type` of the returned instructions"
    },
    "bank_transfer": {
      "$ref": "#/components/schemas/funding_instructions_bank_transfer"
    }
  },
  "description": "Each customer has a [`balance`](https://docs.stripe.com/api/customers/object#customer_object-balance) that is\nautomatically applied to future invoices and payments using the `customer_balance` payment method.\nCustomers can fund this balance by initiating a bank transfer to any account in the\n`financial_addresses` field.\nRelated guide: [Customer balance funding instructions](https://docs.stripe.com/payments/customer-balance/funding-instructions)",
  "x-resourceId": "funding_instructions",
  "x-expandableFields": [
    "bank_transfer"
  ]
}

object funding_instructions_bank_transfer

{
  "type": "object",
  "title": "FundingInstructionsBankTransfer",
  "required": [
    "country",
    "financial_addresses",
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "eu_bank_transfer",
        "jp_bank_transfer"
      ],
      "type": "string",
      "description": "The bank_transfer type",
      "x-stripeBypassValidation": true
    },
    "country": {
      "type": "string",
      "maxLength": 5000,
      "description": "The country of the bank account to fund"
    },
    "financial_addresses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/funding_instructions_bank_transfer_financial_address"
      },
      "description": "A list of financial addresses that can be used to fund a particular balance"
    }
  },
  "description": "",
  "x-expandableFields": [
    "financial_addresses"
  ]
}

object funding_instructions_bank_transfer_aba_record

{
  "type": "object",
  "title": "FundingInstructionsBankTransferABARecord",
  "required": [
    "account_holder_address",
    "account_holder_name",
    "account_number",
    "account_type",
    "bank_address",
    "bank_name",
    "routing_number"
  ],
  "properties": {
    "bank_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The bank name"
    },
    "account_type": {
      "type": "string",
      "maxLength": 5000,
      "description": "The account type"
    },
    "bank_address": {
      "$ref": "#/components/schemas/address"
    },
    "account_number": {
      "type": "string",
      "maxLength": 5000,
      "description": "The ABA account number"
    },
    "routing_number": {
      "type": "string",
      "maxLength": 5000,
      "description": "The ABA routing number"
    },
    "account_holder_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The account holder name"
    },
    "account_holder_address": {
      "$ref": "#/components/schemas/address"
    }
  },
  "description": "ABA Records contain U.S. bank account details per the ABA format.",
  "x-expandableFields": [
    "account_holder_address",
    "bank_address"
  ]
}

object funding_instructions_bank_transfer_financial_address

{
  "type": "object",
  "title": "FundingInstructionsBankTransferFinancialAddress",
  "required": [
    "type"
  ],
  "properties": {
    "aba": {
      "$ref": "#/components/schemas/funding_instructions_bank_transfer_aba_record"
    },
    "iban": {
      "$ref": "#/components/schemas/funding_instructions_bank_transfer_iban_record"
    },
    "spei": {
      "$ref": "#/components/schemas/funding_instructions_bank_transfer_spei_record"
    },
    "type": {
      "enum": [
        "aba",
        "iban",
        "sort_code",
        "spei",
        "swift",
        "zengin"
      ],
      "type": "string",
      "description": "The type of financial address",
      "x-stripeBypassValidation": true
    },
    "swift": {
      "$ref": "#/components/schemas/funding_instructions_bank_transfer_swift_record"
    },
    "zengin": {
      "$ref": "#/components/schemas/funding_instructions_bank_transfer_zengin_record"
    },
    "sort_code": {
      "$ref": "#/components/schemas/funding_instructions_bank_transfer_sort_code_record"
    },
    "supported_networks": {
      "type": "array",
      "items": {
        "enum": [
          "ach",
          "bacs",
          "domestic_wire_us",
          "fps",
          "sepa",
          "spei",
          "swift",
          "zengin"
        ],
        "type": "string",
        "x-stripeBypassValidation": true
      },
      "description": "The payment networks supported by this FinancialAddress"
    }
  },
  "description": "FinancialAddresses contain identifying information that resolves to a FinancialAccount.",
  "x-expandableFields": [
    "aba",
    "iban",
    "sort_code",
    "spei",
    "swift",
    "zengin"
  ]
}

object funding_instructions_bank_transfer_iban_record

{
  "type": "object",
  "title": "FundingInstructionsBankTransferIbanRecord",
  "required": [
    "account_holder_address",
    "account_holder_name",
    "bank_address",
    "bic",
    "country",
    "iban"
  ],
  "properties": {
    "bic": {
      "type": "string",
      "maxLength": 5000,
      "description": "The BIC/SWIFT code of the account."
    },
    "iban": {
      "type": "string",
      "maxLength": 5000,
      "description": "The IBAN of the account."
    },
    "country": {
      "type": "string",
      "maxLength": 5000,
      "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."
    },
    "bank_address": {
      "$ref": "#/components/schemas/address"
    },
    "account_holder_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The name of the person or business that owns the bank account"
    },
    "account_holder_address": {
      "$ref": "#/components/schemas/address"
    }
  },
  "description": "Iban Records contain E.U. bank account details per the SEPA format.",
  "x-expandableFields": [
    "account_holder_address",
    "bank_address"
  ]
}

object funding_instructions_bank_transfer_sort_code_record

{
  "type": "object",
  "title": "FundingInstructionsBankTransferSortCodeRecord",
  "required": [
    "account_holder_address",
    "account_holder_name",
    "account_number",
    "bank_address",
    "sort_code"
  ],
  "properties": {
    "sort_code": {
      "type": "string",
      "maxLength": 5000,
      "description": "The six-digit sort code"
    },
    "bank_address": {
      "$ref": "#/components/schemas/address"
    },
    "account_number": {
      "type": "string",
      "maxLength": 5000,
      "description": "The account number"
    },
    "account_holder_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The name of the person or business that owns the bank account"
    },
    "account_holder_address": {
      "$ref": "#/components/schemas/address"
    }
  },
  "description": "Sort Code Records contain U.K. bank account details per the sort code format.",
  "x-expandableFields": [
    "account_holder_address",
    "bank_address"
  ]
}

object funding_instructions_bank_transfer_spei_record

{
  "type": "object",
  "title": "FundingInstructionsBankTransferSpeiRecord",
  "required": [
    "account_holder_address",
    "account_holder_name",
    "bank_address",
    "bank_code",
    "bank_name",
    "clabe"
  ],
  "properties": {
    "clabe": {
      "type": "string",
      "maxLength": 5000,
      "description": "The CLABE number"
    },
    "bank_code": {
      "type": "string",
      "maxLength": 5000,
      "description": "The three-digit bank code"
    },
    "bank_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The short banking institution name"
    },
    "bank_address": {
      "$ref": "#/components/schemas/address"
    },
    "account_holder_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The account holder name"
    },
    "account_holder_address": {
      "$ref": "#/components/schemas/address"
    }
  },
  "description": "SPEI Records contain Mexico bank account details per the SPEI format.",
  "x-expandableFields": [
    "account_holder_address",
    "bank_address"
  ]
}

object funding_instructions_bank_transfer_swift_record

{
  "type": "object",
  "title": "FundingInstructionsBankTransferSwiftRecord",
  "required": [
    "account_holder_address",
    "account_holder_name",
    "account_number",
    "account_type",
    "bank_address",
    "bank_name",
    "swift_code"
  ],
  "properties": {
    "bank_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The bank name"
    },
    "swift_code": {
      "type": "string",
      "maxLength": 5000,
      "description": "The SWIFT code"
    },
    "account_type": {
      "type": "string",
      "maxLength": 5000,
      "description": "The account type"
    },
    "bank_address": {
      "$ref": "#/components/schemas/address"
    },
    "account_number": {
      "type": "string",
      "maxLength": 5000,
      "description": "The account number"
    },
    "account_holder_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The account holder name"
    },
    "account_holder_address": {
      "$ref": "#/components/schemas/address"
    }
  },
  "description": "SWIFT Records contain U.S. bank account details per the SWIFT format.",
  "x-expandableFields": [
    "account_holder_address",
    "bank_address"
  ]
}

object funding_instructions_bank_transfer_zengin_record

{
  "type": "object",
  "title": "FundingInstructionsBankTransferZenginRecord",
  "required": [
    "account_holder_address",
    "bank_address"
  ],
  "properties": {
    "bank_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The bank code of the account"
    },
    "bank_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The bank name of the account"
    },
    "branch_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The branch code of the account"
    },
    "branch_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The branch name of the account"
    },
    "account_type": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The bank account type. In Japan, this can only be `futsu` or `toza`."
    },
    "bank_address": {
      "$ref": "#/components/schemas/address"
    },
    "account_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The account number"
    },
    "account_holder_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The account holder name"
    },
    "account_holder_address": {
      "$ref": "#/components/schemas/address"
    }
  },
  "description": "Zengin Records contain Japan bank account details per the Zengin format.",
  "x-expandableFields": [
    "account_holder_address",
    "bank_address"
  ]
}

object gelato_data_document_report_date_of_birth

{
  "type": "object",
  "title": "GelatoDataDocumentReportDateOfBirth",
  "properties": {
    "day": {
      "type": "integer",
      "nullable": true,
      "description": "Numerical day between 1 and 31."
    },
    "year": {
      "type": "integer",
      "nullable": true,
      "description": "The four-digit year."
    },
    "month": {
      "type": "integer",
      "nullable": true,
      "description": "Numerical month between 1 and 12."
    }
  },
  "description": "Point in Time",
  "x-expandableFields": []
}

object gelato_data_document_report_expiration_date

{
  "type": "object",
  "title": "GelatoDataDocumentReportExpirationDate",
  "properties": {
    "day": {
      "type": "integer",
      "nullable": true,
      "description": "Numerical day between 1 and 31."
    },
    "year": {
      "type": "integer",
      "nullable": true,
      "description": "The four-digit year."
    },
    "month": {
      "type": "integer",
      "nullable": true,
      "description": "Numerical month between 1 and 12."
    }
  },
  "description": "Point in Time",
  "x-expandableFields": []
}

object gelato_data_document_report_issued_date

{
  "type": "object",
  "title": "GelatoDataDocumentReportIssuedDate",
  "properties": {
    "day": {
      "type": "integer",
      "nullable": true,
      "description": "Numerical day between 1 and 31."
    },
    "year": {
      "type": "integer",
      "nullable": true,
      "description": "The four-digit year."
    },
    "month": {
      "type": "integer",
      "nullable": true,
      "description": "Numerical month between 1 and 12."
    }
  },
  "description": "Point in Time",
  "x-expandableFields": []
}

object gelato_data_id_number_report_date

{
  "type": "object",
  "title": "GelatoDataIdNumberReportDate",
  "properties": {
    "day": {
      "type": "integer",
      "nullable": true,
      "description": "Numerical day between 1 and 31."
    },
    "year": {
      "type": "integer",
      "nullable": true,
      "description": "The four-digit year."
    },
    "month": {
      "type": "integer",
      "nullable": true,
      "description": "Numerical month between 1 and 12."
    }
  },
  "description": "Point in Time",
  "x-expandableFields": []
}

object gelato_data_verified_outputs_date

{
  "type": "object",
  "title": "GelatoDataVerifiedOutputsDate",
  "properties": {
    "day": {
      "type": "integer",
      "nullable": true,
      "description": "Numerical day between 1 and 31."
    },
    "year": {
      "type": "integer",
      "nullable": true,
      "description": "The four-digit year."
    },
    "month": {
      "type": "integer",
      "nullable": true,
      "description": "Numerical month between 1 and 12."
    }
  },
  "description": "Point in Time",
  "x-expandableFields": []
}

object gelato_document_report

{
  "type": "object",
  "title": "GelatoDocumentReport",
  "required": [
    "status"
  ],
  "properties": {
    "dob": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/gelato_data_document_report_date_of_birth"
        }
      ],
      "nullable": true,
      "description": "Date of birth as it appears in the document."
    },
    "sex": {
      "enum": [
        "[redacted]",
        "female",
        "male",
        "unknown"
      ],
      "type": "string",
      "nullable": true,
      "description": "Sex of the person in the document."
    },
    "type": {
      "enum": [
        "driving_license",
        "id_card",
        "passport"
      ],
      "type": "string",
      "nullable": true,
      "description": "Type of the document."
    },
    "error": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/gelato_document_report_error"
        }
      ],
      "nullable": true,
      "description": "Details on the verification error. Present when status is `unverified`."
    },
    "files": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "Array of [File](https://docs.stripe.com/api/files) ids containing images for this document."
    },
    "number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Document ID number."
    },
    "status": {
      "enum": [
        "unverified",
        "verified"
      ],
      "type": "string",
      "description": "Status of this `document` check.",
      "x-stripeBypassValidation": true
    },
    "address": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/address"
        }
      ],
      "nullable": true,
      "description": "Address as it appears in the document."
    },
    "last_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last name as it appears in the document."
    },
    "first_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "First name as it appears in the document."
    },
    "issued_date": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/gelato_data_document_report_issued_date"
        }
      ],
      "nullable": true,
      "description": "Issued date of the document."
    },
    "unparsed_sex": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Sex as it appears in the document."
    },
    "expiration_date": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/gelato_data_document_report_expiration_date"
        }
      ],
      "nullable": true,
      "description": "Expiration date of the document."
    },
    "issuing_country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Issuing country of the document."
    },
    "unparsed_place_of_birth": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Place of birth as it appears in the document."
    }
  },
  "description": "Result from a document check",
  "x-expandableFields": [
    "address",
    "dob",
    "error",
    "expiration_date",
    "issued_date"
  ]
}

object gelato_document_report_error

{
  "type": "object",
  "title": "GelatoDocumentReportError",
  "properties": {
    "code": {
      "enum": [
        "document_expired",
        "document_type_not_supported",
        "document_unverified_other"
      ],
      "type": "string",
      "nullable": true,
      "description": "A short machine-readable string giving the reason for the verification failure.",
      "x-stripeBypassValidation": true
    },
    "reason": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A human-readable message giving the reason for the failure. These messages can be shown to your users."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object gelato_email_report

{
  "type": "object",
  "title": "GelatoEmailReport",
  "required": [
    "status"
  ],
  "properties": {
    "email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Email to be verified."
    },
    "error": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/gelato_email_report_error"
        }
      ],
      "nullable": true,
      "description": "Details on the verification error. Present when status is `unverified`."
    },
    "status": {
      "enum": [
        "unverified",
        "verified"
      ],
      "type": "string",
      "description": "Status of this `email` check.",
      "x-stripeBypassValidation": true
    }
  },
  "description": "Result from a email check",
  "x-expandableFields": [
    "error"
  ]
}

object gelato_email_report_error

{
  "type": "object",
  "title": "GelatoEmailReportError",
  "properties": {
    "code": {
      "enum": [
        "email_unverified_other",
        "email_verification_declined"
      ],
      "type": "string",
      "nullable": true,
      "description": "A short machine-readable string giving the reason for the verification failure."
    },
    "reason": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A human-readable message giving the reason for the failure. These messages can be shown to your users."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object gelato_id_number_report

{
  "type": "object",
  "title": "GelatoIdNumberReport",
  "required": [
    "status"
  ],
  "properties": {
    "dob": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/gelato_data_id_number_report_date"
        }
      ],
      "nullable": true,
      "description": "Date of birth."
    },
    "error": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/gelato_id_number_report_error"
        }
      ],
      "nullable": true,
      "description": "Details on the verification error. Present when status is `unverified`."
    },
    "status": {
      "enum": [
        "unverified",
        "verified"
      ],
      "type": "string",
      "description": "Status of this `id_number` check.",
      "x-stripeBypassValidation": true
    },
    "id_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID number. When `id_number_type` is `us_ssn`, only the last 4 digits are present."
    },
    "last_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last name."
    },
    "first_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "First name."
    },
    "id_number_type": {
      "enum": [
        "br_cpf",
        "sg_nric",
        "us_ssn"
      ],
      "type": "string",
      "nullable": true,
      "description": "Type of ID number."
    }
  },
  "description": "Result from an id_number check",
  "x-expandableFields": [
    "dob",
    "error"
  ]
}

object gelato_id_number_report_error

{
  "type": "object",
  "title": "GelatoIdNumberReportError",
  "properties": {
    "code": {
      "enum": [
        "id_number_insufficient_document_data",
        "id_number_mismatch",
        "id_number_unverified_other"
      ],
      "type": "string",
      "nullable": true,
      "description": "A short machine-readable string giving the reason for the verification failure."
    },
    "reason": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A human-readable message giving the reason for the failure. These messages can be shown to your users."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object gelato_phone_report

{
  "type": "object",
  "title": "GelatoPhoneReport",
  "required": [
    "status"
  ],
  "properties": {
    "error": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/gelato_phone_report_error"
        }
      ],
      "nullable": true,
      "description": "Details on the verification error. Present when status is `unverified`."
    },
    "phone": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Phone to be verified."
    },
    "status": {
      "enum": [
        "unverified",
        "verified"
      ],
      "type": "string",
      "description": "Status of this `phone` check.",
      "x-stripeBypassValidation": true
    }
  },
  "description": "Result from a phone check",
  "x-expandableFields": [
    "error"
  ]
}

object gelato_phone_report_error

{
  "type": "object",
  "title": "GelatoPhoneReportError",
  "properties": {
    "code": {
      "enum": [
        "phone_unverified_other",
        "phone_verification_declined"
      ],
      "type": "string",
      "nullable": true,
      "description": "A short machine-readable string giving the reason for the verification failure."
    },
    "reason": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A human-readable message giving the reason for the failure. These messages can be shown to your users."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object gelato_provided_details

{
  "type": "object",
  "title": "GelatoProvidedDetails",
  "properties": {
    "email": {
      "type": "string",
      "maxLength": 5000,
      "description": "Email of user being verified"
    },
    "phone": {
      "type": "string",
      "maxLength": 5000,
      "description": "Phone number of user being verified"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object gelato_related_person

{
  "type": "object",
  "title": "GelatoRelatedPerson",
  "required": [
    "account",
    "person"
  ],
  "properties": {
    "person": {
      "type": "string",
      "maxLength": 5000,
      "description": "Token referencing the related Person resource."
    },
    "account": {
      "type": "string",
      "maxLength": 5000,
      "description": "Token referencing the associated Account of the related Person resource."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object gelato_report_document_options

{
  "type": "object",
  "title": "GelatoReportDocumentOptions",
  "properties": {
    "allowed_types": {
      "type": "array",
      "items": {
        "enum": [
          "driving_license",
          "id_card",
          "passport"
        ],
        "type": "string"
      },
      "description": "Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code."
    },
    "require_id_number": {
      "type": "boolean",
      "description": "Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth."
    },
    "require_live_capture": {
      "type": "boolean",
      "description": "Disable image uploads, identity document images have to be captured using the device’s camera."
    },
    "require_matching_selfie": {
      "type": "boolean",
      "description": "Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://docs.stripe.com/identity/selfie)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object gelato_report_id_number_options

{
  "type": "object",
  "title": "GelatoReportIdNumberOptions",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object gelato_selfie_report

{
  "type": "object",
  "title": "GelatoSelfieReport",
  "required": [
    "status"
  ],
  "properties": {
    "error": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/gelato_selfie_report_error"
        }
      ],
      "nullable": true,
      "description": "Details on the verification error. Present when status is `unverified`."
    },
    "selfie": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the [File](https://docs.stripe.com/api/files) holding the image of the selfie used in this check."
    },
    "status": {
      "enum": [
        "unverified",
        "verified"
      ],
      "type": "string",
      "description": "Status of this `selfie` check.",
      "x-stripeBypassValidation": true
    },
    "document": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the [File](https://docs.stripe.com/api/files) holding the image of the identity document used in this check."
    }
  },
  "description": "Result from a selfie check",
  "x-expandableFields": [
    "error"
  ]
}

object gelato_selfie_report_error

{
  "type": "object",
  "title": "GelatoSelfieReportError",
  "properties": {
    "code": {
      "enum": [
        "selfie_document_missing_photo",
        "selfie_face_mismatch",
        "selfie_manipulated",
        "selfie_unverified_other"
      ],
      "type": "string",
      "nullable": true,
      "description": "A short machine-readable string giving the reason for the verification failure.",
      "x-stripeBypassValidation": true
    },
    "reason": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A human-readable message giving the reason for the failure. These messages can be shown to your users."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object gelato_session_document_options

{
  "type": "object",
  "title": "GelatoSessionDocumentOptions",
  "properties": {
    "allowed_types": {
      "type": "array",
      "items": {
        "enum": [
          "driving_license",
          "id_card",
          "passport"
        ],
        "type": "string"
      },
      "description": "Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code."
    },
    "require_id_number": {
      "type": "boolean",
      "description": "Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth."
    },
    "require_live_capture": {
      "type": "boolean",
      "description": "Disable image uploads, identity document images have to be captured using the device’s camera."
    },
    "require_matching_selfie": {
      "type": "boolean",
      "description": "Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://docs.stripe.com/identity/selfie)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object gelato_session_email_options

{
  "type": "object",
  "title": "GelatoSessionEmailOptions",
  "properties": {
    "require_verification": {
      "type": "boolean",
      "description": "Request one time password verification of `provided_details.email`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object gelato_session_id_number_options

{
  "type": "object",
  "title": "GelatoSessionIdNumberOptions",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object gelato_session_last_error

{
  "type": "object",
  "title": "GelatoSessionLastError",
  "properties": {
    "code": {
      "enum": [
        "abandoned",
        "consent_declined",
        "country_not_supported",
        "device_not_supported",
        "document_expired",
        "document_type_not_supported",
        "document_unverified_other",
        "email_unverified_other",
        "email_verification_declined",
        "id_number_insufficient_document_data",
        "id_number_mismatch",
        "id_number_unverified_other",
        "phone_unverified_other",
        "phone_verification_declined",
        "selfie_document_missing_photo",
        "selfie_face_mismatch",
        "selfie_manipulated",
        "selfie_unverified_other",
        "under_supported_age"
      ],
      "type": "string",
      "nullable": true,
      "description": "A short machine-readable string giving the reason for the verification or user-session failure.",
      "x-stripeBypassValidation": true
    },
    "reason": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A message that explains the reason for verification or user-session failure."
    }
  },
  "description": "Shows last VerificationSession error",
  "x-expandableFields": []
}

object gelato_session_matching_options

{
  "type": "object",
  "title": "GelatoSessionMatchingOptions",
  "properties": {
    "dob": {
      "enum": [
        "none",
        "similar"
      ],
      "type": "string",
      "description": "Strictness of the DOB matching policy to apply."
    },
    "name": {
      "enum": [
        "none",
        "similar"
      ],
      "type": "string",
      "description": "Strictness of the name matching policy to apply."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object gelato_session_phone_options

{
  "type": "object",
  "title": "GelatoSessionPhoneOptions",
  "properties": {
    "require_verification": {
      "type": "boolean",
      "description": "Request one time password verification of `provided_details.phone`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object gelato_verification_report_options

{
  "type": "object",
  "title": "GelatoVerificationReportOptions",
  "properties": {
    "document": {
      "$ref": "#/components/schemas/gelato_report_document_options"
    },
    "id_number": {
      "$ref": "#/components/schemas/gelato_report_id_number_options"
    }
  },
  "description": "",
  "x-expandableFields": [
    "document",
    "id_number"
  ]
}

object gelato_verification_session_options

{
  "type": "object",
  "title": "GelatoVerificationSessionOptions",
  "properties": {
    "email": {
      "$ref": "#/components/schemas/gelato_session_email_options"
    },
    "phone": {
      "$ref": "#/components/schemas/gelato_session_phone_options"
    },
    "document": {
      "$ref": "#/components/schemas/gelato_session_document_options"
    },
    "matching": {
      "$ref": "#/components/schemas/gelato_session_matching_options"
    },
    "id_number": {
      "$ref": "#/components/schemas/gelato_session_id_number_options"
    }
  },
  "description": "",
  "x-expandableFields": [
    "document",
    "email",
    "id_number",
    "matching",
    "phone"
  ]
}

object gelato_verified_outputs

{
  "type": "object",
  "title": "GelatoVerifiedOutputs",
  "properties": {
    "dob": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/gelato_data_verified_outputs_date"
        }
      ],
      "nullable": true,
      "description": "The user’s verified date of birth."
    },
    "sex": {
      "enum": [
        "[redacted]",
        "female",
        "male",
        "unknown"
      ],
      "type": "string",
      "nullable": true,
      "description": "The user's verified sex."
    },
    "email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The user's verified email address"
    },
    "phone": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The user's verified phone number"
    },
    "address": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/address"
        }
      ],
      "nullable": true,
      "description": "The user's verified address."
    },
    "id_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The user's verified id number."
    },
    "last_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The user's verified last name."
    },
    "first_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The user's verified first name."
    },
    "unparsed_sex": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The user's verified sex as it appears in the document."
    },
    "id_number_type": {
      "enum": [
        "br_cpf",
        "sg_nric",
        "us_ssn"
      ],
      "type": "string",
      "nullable": true,
      "description": "The user's verified id number type."
    },
    "unparsed_place_of_birth": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The user's verified place of birth as it appears in the document."
    }
  },
  "description": "",
  "x-expandableFields": [
    "address",
    "dob"
  ]
}

object identity.verification_report

{
  "type": "object",
  "title": "GelatoVerificationReport",
  "required": [
    "created",
    "id",
    "livemode",
    "object",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "type": {
      "enum": [
        "document",
        "id_number",
        "verification_flow"
      ],
      "type": "string",
      "description": "Type of report.",
      "x-stripeBypassValidation": true
    },
    "email": {
      "$ref": "#/components/schemas/gelato_email_report"
    },
    "phone": {
      "$ref": "#/components/schemas/gelato_phone_report"
    },
    "object": {
      "enum": [
        "identity.verification_report"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "selfie": {
      "$ref": "#/components/schemas/gelato_selfie_report"
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "options": {
      "$ref": "#/components/schemas/gelato_verification_report_options"
    },
    "document": {
      "$ref": "#/components/schemas/gelato_document_report"
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "id_number": {
      "$ref": "#/components/schemas/gelato_id_number_report"
    },
    "verification_flow": {
      "type": "string",
      "maxLength": 5000,
      "description": "The configuration token of a verification flow from the dashboard."
    },
    "client_reference_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems."
    },
    "verification_session": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the VerificationSession that created this report."
    }
  },
  "description": "A VerificationReport is the result of an attempt to collect and verify data from a user.\nThe collection of verification checks performed is determined from the `type` and `options`\nparameters used. You can find the result of each verification check performed in the\nappropriate sub-resource: `document`, `id_number`, `selfie`.\n\nEach VerificationReport contains a copy of any data collected by the user as well as\nreference IDs which can be used to access collected images through the [FileUpload](https://docs.stripe.com/api/files)\nAPI. To configure and create VerificationReports, use the\n[VerificationSession](https://docs.stripe.com/api/identity/verification_sessions) API.\n\nRelated guide: [Accessing verification results](https://docs.stripe.com/identity/verification-sessions#results).",
  "x-resourceId": "identity.verification_report",
  "x-expandableFields": [
    "document",
    "email",
    "id_number",
    "options",
    "phone",
    "selfie"
  ]
}

object identity.verification_session

{
  "type": "object",
  "title": "GelatoVerificationSession",
  "required": [
    "created",
    "id",
    "livemode",
    "metadata",
    "object",
    "status",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://docs.stripe.com/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe."
    },
    "type": {
      "enum": [
        "document",
        "id_number",
        "verification_flow"
      ],
      "type": "string",
      "description": "The type of [verification check](https://docs.stripe.com/identity/verification-checks) to be performed.",
      "x-stripeBypassValidation": true
    },
    "object": {
      "enum": [
        "identity.verification_session"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "canceled",
        "processing",
        "requires_input",
        "verified"
      ],
      "type": "string",
      "description": "Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://docs.stripe.com/identity/how-sessions-work)."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "options": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/gelato_verification_session_options"
        }
      ],
      "nullable": true,
      "description": "A set of options for the session’s verification checks."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "redaction": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/verification_session_redaction"
        }
      ],
      "nullable": true,
      "description": "Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null."
    },
    "last_error": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/gelato_session_last_error"
        }
      ],
      "nullable": true,
      "description": "If present, this property tells you the last error encountered when processing the verification."
    },
    "client_secret": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The short-lived client secret used by Stripe.js to [show a verification modal](https://docs.stripe.com/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://docs.stripe.com/identity/verification-sessions#client-secret) to learn more."
    },
    "related_person": {
      "$ref": "#/components/schemas/gelato_related_person"
    },
    "provided_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/gelato_provided_details"
        }
      ],
      "nullable": true,
      "description": "Details provided about the user being verified. These details may be shown to the user."
    },
    "related_customer": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Customer ID"
    },
    "verified_outputs": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/gelato_verified_outputs"
        }
      ],
      "nullable": true,
      "description": "The user’s verified data."
    },
    "verification_flow": {
      "type": "string",
      "maxLength": 5000,
      "description": "The configuration token of a verification flow from the dashboard."
    },
    "client_reference_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems."
    },
    "last_verification_report": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/identity.verification_report"
        }
      ],
      "nullable": true,
      "description": "ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://docs.stripe.com/identity/verification-sessions#results)",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/identity.verification_report"
          }
        ]
      }
    },
    "related_customer_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The ID of the Account representing a customer."
    }
  },
  "description": "A VerificationSession guides you through the process of collecting and verifying the identities\nof your users. It contains details about the type of verification, such as what [verification\ncheck](/docs/identity/verification-checks) to perform. Only create one VerificationSession for\neach verification in your system.\n\nA VerificationSession transitions through [multiple\nstatuses](/docs/identity/how-sessions-work) throughout its lifetime as it progresses through\nthe verification flow. The VerificationSession contains the user's verified data after\nverification checks are complete.\n\nRelated guide: [The Verification Sessions API](https://docs.stripe.com/identity/verification-sessions)",
  "x-resourceId": "identity.verification_session",
  "x-expandableFields": [
    "last_error",
    "last_verification_report",
    "options",
    "provided_details",
    "redaction",
    "related_person",
    "verified_outputs"
  ]
}

object inbound_transfers

{
  "type": "object",
  "title": "InboundTransfers",
  "required": [
    "billing_details",
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "us_bank_account"
      ],
      "type": "string",
      "description": "The type of the payment method used in the InboundTransfer.",
      "x-stripeBypassValidation": true
    },
    "billing_details": {
      "$ref": "#/components/schemas/treasury_shared_resource_billing_details"
    },
    "us_bank_account": {
      "$ref": "#/components/schemas/inbound_transfers_payment_method_details_us_bank_account"
    }
  },
  "description": "",
  "x-expandableFields": [
    "billing_details",
    "us_bank_account"
  ]
}

object inbound_transfers_payment_method_details_us_bank_account

{
  "type": "object",
  "title": "inbound_transfers_payment_method_details_us_bank_account",
  "required": [
    "network"
  ],
  "properties": {
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last four digits of the bank account number."
    },
    "mandate": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/mandate"
        }
      ],
      "description": "ID of the mandate used to make this payment.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/mandate"
          }
        ]
      }
    },
    "network": {
      "enum": [
        "ach"
      ],
      "type": "string",
      "description": "The network rails used. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type."
    },
    "bank_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Name of the bank associated with the bank account."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."
    },
    "account_type": {
      "enum": [
        "checking",
        "savings"
      ],
      "type": "string",
      "nullable": true,
      "description": "Account type: checkings or savings. Defaults to checking if omitted."
    },
    "routing_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Routing number of the bank account."
    },
    "account_holder_type": {
      "enum": [
        "company",
        "individual"
      ],
      "type": "string",
      "nullable": true,
      "description": "Account holder type: individual or company."
    }
  },
  "description": "",
  "x-expandableFields": [
    "mandate"
  ]
}

object insights_resources_payment_evaluation_address

{
  "type": "object",
  "title": "InsightsResourcesPaymentEvaluationAddress",
  "properties": {
    "city": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "City, district, suburb, town, or village."
    },
    "line1": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Address line 1, such as the street, PO Box, or company name."
    },
    "line2": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Address line 2, such as the apartment, suite, unit, or building."
    },
    "state": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."
    },
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."
    },
    "postal_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ZIP or postal code."
    }
  },
  "description": "Address data.",
  "x-expandableFields": []
}

object insights_resources_payment_evaluation_billing_details

{
  "type": "object",
  "title": "InsightsResourcesPaymentEvaluationBillingDetails",
  "required": [
    "address"
  ],
  "properties": {
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Full name."
    },
    "email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Email address."
    },
    "phone": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Billing phone number (including extension)."
    },
    "address": {
      "$ref": "#/components/schemas/insights_resources_payment_evaluation_address"
    }
  },
  "description": "Billing details attached to this payment evaluation.",
  "x-expandableFields": [
    "address"
  ]
}

object insights_resources_payment_evaluation_client_device_metadata

{
  "type": "object",
  "title": "InsightsResourcesPaymentEvaluationClientDeviceMetadata",
  "required": [
    "radar_session"
  ],
  "properties": {
    "radar_session": {
      "type": "string",
      "maxLength": 5000,
      "description": "ID for the Radar Session associated with the payment evaluation. A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments."
    }
  },
  "description": "Client device metadata attached to this payment evaluation.",
  "x-expandableFields": []
}

object insights_resources_payment_evaluation_customer_details

{
  "type": "object",
  "title": "InsightsResourcesPaymentEvaluationCustomerDetails",
  "properties": {
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The customer's full name or business name."
    },
    "email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The customer's email address."
    },
    "phone": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The customer's phone number."
    },
    "customer": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The ID of the customer associated with the payment evaluation."
    },
    "customer_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The ID of the Account representing the customer associated with the payment evaluation."
    }
  },
  "description": "Customer details attached to this payment evaluation.",
  "x-expandableFields": []
}

object insights_resources_payment_evaluation_dispute_opened

{
  "type": "object",
  "title": "InsightsResourcesPaymentEvaluationDisputeOpened",
  "required": [
    "amount",
    "currency",
    "reason"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "Amount to dispute for this payment. A positive integer representing how much to charge in [the smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (for example, 100 cents to charge 1.00 USD or 100 to charge 100 Yen, a zero-decimal currency)."
    },
    "reason": {
      "enum": [
        "account_not_available",
        "credit_not_processed",
        "customer_initiated",
        "duplicate",
        "fraudulent",
        "general",
        "noncompliant",
        "product_not_received",
        "product_unacceptable",
        "subscription_canceled",
        "unrecognized"
      ],
      "type": "string",
      "description": "Reason given by cardholder for dispute."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    }
  },
  "description": "Dispute opened event details attached to this payment evaluation.",
  "x-expandableFields": []
}

object insights_resources_payment_evaluation_early_fraud_warning_received

{
  "type": "object",
  "title": "InsightsResourcesPaymentEvaluationEarlyFraudWarningReceived",
  "required": [
    "fraud_type"
  ],
  "properties": {
    "fraud_type": {
      "enum": [
        "made_with_lost_card",
        "made_with_stolen_card",
        "other",
        "unauthorized_use_of_card"
      ],
      "type": "string",
      "description": "The type of fraud labeled by the issuer."
    }
  },
  "description": "Early Fraud Warning Received event details attached to this payment evaluation.",
  "x-expandableFields": []
}

object insights_resources_payment_evaluation_event

{
  "type": "object",
  "title": "InsightsResourcesPaymentEvaluationEvent",
  "required": [
    "occurred_at",
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "dispute_opened",
        "early_fraud_warning_received",
        "refunded",
        "user_intervention_raised",
        "user_intervention_resolved"
      ],
      "type": "string",
      "description": "Indicates the type of event attached to the payment evaluation."
    },
    "refunded": {
      "$ref": "#/components/schemas/insights_resources_payment_evaluation_refunded"
    },
    "occurred_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "Timestamp when the event occurred."
    },
    "dispute_opened": {
      "$ref": "#/components/schemas/insights_resources_payment_evaluation_dispute_opened"
    },
    "user_intervention_raised": {
      "$ref": "#/components/schemas/insights_resources_payment_evaluation_user_intervention_raised"
    },
    "user_intervention_resolved": {
      "$ref": "#/components/schemas/insights_resources_payment_evaluation_user_intervention_resolved"
    },
    "early_fraud_warning_received": {
      "$ref": "#/components/schemas/insights_resources_payment_evaluation_early_fraud_warning_received"
    }
  },
  "description": "Event reported for this payment evaluation.",
  "x-expandableFields": [
    "dispute_opened",
    "early_fraud_warning_received",
    "refunded",
    "user_intervention_raised",
    "user_intervention_resolved"
  ]
}

object insights_resources_payment_evaluation_merchant_blocked

{
  "type": "object",
  "title": "InsightsResourcesPaymentEvaluationMerchantBlocked",
  "required": [
    "reason"
  ],
  "properties": {
    "reason": {
      "enum": [
        "authentication_required",
        "blocked_for_fraud",
        "invalid_payment",
        "other"
      ],
      "type": "string",
      "description": "The reason the payment was blocked by the merchant."
    }
  },
  "description": "Details of a merchant_blocked outcome attached to this payment evaluation.",
  "x-expandableFields": []
}

object insights_resources_payment_evaluation_money_movement_card

{
  "type": "object",
  "title": "InsightsResourcesPaymentEvaluationMoneyMovementCard",
  "properties": {
    "payment_type": {
      "enum": [
        "one_off",
        "recurring",
        "setup_one_off",
        "setup_recurring"
      ],
      "type": "string",
      "nullable": true,
      "description": "Describes the type of payment."
    },
    "customer_presence": {
      "enum": [
        "off_session",
        "on_session"
      ],
      "type": "string",
      "nullable": true,
      "description": "Describes the presence of the customer during the payment."
    }
  },
  "description": "Money Movement card details attached to this payment.",
  "x-expandableFields": []
}

object insights_resources_payment_evaluation_money_movement_details

{
  "type": "object",
  "title": "InsightsResourcesPaymentEvaluationMoneyMovementDetails",
  "required": [
    "money_movement_type"
  ],
  "properties": {
    "card": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/insights_resources_payment_evaluation_money_movement_card"
        }
      ],
      "nullable": true,
      "description": "Describes card money movement details for the payment evaluation."
    },
    "money_movement_type": {
      "enum": [
        "card"
      ],
      "type": "string",
      "description": "Describes the type of money movement. Currently only `card` is supported."
    }
  },
  "description": "Money Movement details attached to this payment.",
  "x-expandableFields": [
    "card"
  ]
}

object insights_resources_payment_evaluation_outcome

{
  "type": "object",
  "title": "InsightsResourcesPaymentEvaluationOutcome",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "failed",
        "merchant_blocked",
        "rejected",
        "succeeded"
      ],
      "type": "string",
      "description": "Indicates the outcome of the payment evaluation."
    },
    "rejected": {
      "$ref": "#/components/schemas/insights_resources_payment_evaluation_rejected"
    },
    "succeeded": {
      "$ref": "#/components/schemas/insights_resources_payment_evaluation_succeeded"
    },
    "merchant_blocked": {
      "$ref": "#/components/schemas/insights_resources_payment_evaluation_merchant_blocked"
    },
    "payment_intent_id": {
      "type": "string",
      "maxLength": 5000,
      "description": "The PaymentIntent ID associated with the payment evaluation."
    }
  },
  "description": "Outcome details for this payment evaluation.",
  "x-expandableFields": [
    "merchant_blocked",
    "rejected",
    "succeeded"
  ]
}

object insights_resources_payment_evaluation_payment_details

{
  "type": "object",
  "title": "InsightsResourcesPaymentEvaluationPaymentDetails",
  "required": [
    "amount",
    "currency"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99)."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An arbitrary string attached to the object. Often useful for displaying to users."
    },
    "shipping_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/insights_resources_payment_evaluation_shipping"
        }
      ],
      "nullable": true,
      "description": "Shipping details for the payment evaluation."
    },
    "statement_descriptor": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Payment statement descriptor."
    },
    "money_movement_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/insights_resources_payment_evaluation_money_movement_details"
        }
      ],
      "nullable": true,
      "description": "Details about the payment's customer presence and type."
    },
    "payment_method_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/insights_resources_payment_evaluation_payment_method_details"
        }
      ],
      "nullable": true,
      "description": "Details about the payment method used for the payment."
    }
  },
  "description": "Payment details attached to this payment evaluation.",
  "x-expandableFields": [
    "money_movement_details",
    "payment_method_details",
    "shipping_details"
  ]
}

object insights_resources_payment_evaluation_payment_method_details

{
  "type": "object",
  "title": "InsightsResourcesPaymentEvaluationPaymentMethodDetails",
  "required": [
    "payment_method"
  ],
  "properties": {
    "payment_method": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_method"
        }
      ],
      "description": "The payment method used in this payment evaluation.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_method"
          }
        ]
      }
    },
    "billing_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/insights_resources_payment_evaluation_billing_details"
        }
      ],
      "nullable": true,
      "description": "Billing information associated with the payment evaluation."
    }
  },
  "description": "Payment method details attached to this payment evaluation.",
  "x-expandableFields": [
    "billing_details",
    "payment_method"
  ]
}

object insights_resources_payment_evaluation_refunded

{
  "type": "object",
  "title": "InsightsResourcesPaymentEvaluationRefunded",
  "required": [
    "amount",
    "currency",
    "reason"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "Amount refunded for this payment. A positive integer representing how much to charge in [the smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (for example, 100 cents to charge 1.00 USD or 100 to charge 100 Yen, a zero-decimal currency)."
    },
    "reason": {
      "enum": [
        "duplicate",
        "fraudulent",
        "other",
        "requested_by_customer"
      ],
      "type": "string",
      "description": "Indicates the reason for the refund."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    }
  },
  "description": "Refunded Event details attached to this payment evaluation.",
  "x-expandableFields": []
}

object insights_resources_payment_evaluation_rejected

{
  "type": "object",
  "title": "InsightsResourcesPaymentEvaluationRejected",
  "properties": {
    "card": {
      "$ref": "#/components/schemas/insights_resources_payment_evaluation_rejected_card"
    }
  },
  "description": "Details of an rejected outcome attached to this payment evaluation.",
  "x-expandableFields": [
    "card"
  ]
}

object insights_resources_payment_evaluation_rejected_card

{
  "type": "object",
  "title": "InsightsResourcesPaymentEvaluationRejectedCard",
  "required": [
    "address_line1_check",
    "address_postal_code_check",
    "cvc_check",
    "reason"
  ],
  "properties": {
    "reason": {
      "enum": [
        "authentication_failed",
        "do_not_honor",
        "expired",
        "incorrect_cvc",
        "incorrect_number",
        "incorrect_postal_code",
        "insufficient_funds",
        "invalid_account",
        "lost_card",
        "other",
        "processing_error",
        "reported_stolen",
        "try_again_later"
      ],
      "type": "string",
      "description": "Card issuer's reason for the network decline."
    },
    "cvc_check": {
      "enum": [
        "fail",
        "pass",
        "unavailable",
        "unchecked"
      ],
      "type": "string",
      "description": "Result of the CVC check."
    },
    "address_line1_check": {
      "enum": [
        "fail",
        "pass",
        "unavailable",
        "unchecked"
      ],
      "type": "string",
      "description": "Result of the address line 1 check."
    },
    "address_postal_code_check": {
      "enum": [
        "fail",
        "pass",
        "unavailable",
        "unchecked"
      ],
      "type": "string",
      "description": "Indicates whether the cardholder provided a postal code and if it matched the cardholder’s billing address."
    }
  },
  "description": "Details of an rejected card outcome attached to this payment evaluation.",
  "x-expandableFields": []
}

object insights_resources_payment_evaluation_shipping

{
  "type": "object",
  "title": "InsightsResourcesPaymentEvaluationShipping",
  "required": [
    "address"
  ],
  "properties": {
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Shipping name."
    },
    "phone": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Shipping phone number."
    },
    "address": {
      "$ref": "#/components/schemas/insights_resources_payment_evaluation_address"
    }
  },
  "description": "Shipping details attached to this payment.",
  "x-expandableFields": [
    "address"
  ]
}

object insights_resources_payment_evaluation_signal_v2

{
  "type": "object",
  "title": "InsightsResourcesPaymentEvaluationSignalV2",
  "required": [
    "evaluated_at",
    "risk_level",
    "score"
  ],
  "properties": {
    "score": {
      "type": "number",
      "description": "Score for this insight. Possible values for evaluated payments are -1 and any value between 0 and 100. The value is returned with two decimal places. A score of -1 indicates a test integration and higher scores indicate a higher likelihood of the signal being true."
    },
    "risk_level": {
      "enum": [
        "elevated",
        "highest",
        "normal"
      ],
      "type": "string",
      "description": "Risk level of this signal, based on the score."
    },
    "evaluated_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "The time when this signal was evaluated."
    }
  },
  "description": "A payment evaluation signal with evaluated_at, risk_level, and score fields.",
  "x-expandableFields": []
}

object insights_resources_payment_evaluation_signals

{
  "type": "object",
  "title": "InsightsResourcesPaymentEvaluationSignals",
  "required": [
    "fraudulent_payment"
  ],
  "properties": {
    "fraudulent_payment": {
      "$ref": "#/components/schemas/insights_resources_payment_evaluation_signal_v2"
    }
  },
  "description": "Collection of signals for this payment evaluation.",
  "x-expandableFields": [
    "fraudulent_payment"
  ]
}

object insights_resources_payment_evaluation_succeeded

{
  "type": "object",
  "title": "InsightsResourcesPaymentEvaluationSucceeded",
  "properties": {
    "card": {
      "$ref": "#/components/schemas/insights_resources_payment_evaluation_succeeded_card"
    }
  },
  "description": "Details of a succeeded outcome attached to this payment evaluation.",
  "x-expandableFields": [
    "card"
  ]
}

object insights_resources_payment_evaluation_succeeded_card

{
  "type": "object",
  "title": "InsightsResourcesPaymentEvaluationSucceededCard",
  "required": [
    "address_line1_check",
    "address_postal_code_check",
    "cvc_check"
  ],
  "properties": {
    "cvc_check": {
      "enum": [
        "fail",
        "pass",
        "unavailable",
        "unchecked"
      ],
      "type": "string",
      "description": "Result of the CVC check."
    },
    "address_line1_check": {
      "enum": [
        "fail",
        "pass",
        "unavailable",
        "unchecked"
      ],
      "type": "string",
      "description": "Result of the address line 1 check."
    },
    "address_postal_code_check": {
      "enum": [
        "fail",
        "pass",
        "unavailable",
        "unchecked"
      ],
      "type": "string",
      "description": "Indicates whether the cardholder provided a postal code and if it matched the cardholder’s billing address."
    }
  },
  "description": "Details of an succeeded card outcome attached to this payment evaluation.",
  "x-expandableFields": []
}

object insights_resources_payment_evaluation_user_intervention_raised

{
  "type": "object",
  "title": "InsightsResourcesPaymentEvaluationUserInterventionRaised",
  "required": [
    "key",
    "type"
  ],
  "properties": {
    "key": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the user intervention event."
    },
    "type": {
      "enum": [
        "3ds",
        "captcha",
        "custom"
      ],
      "type": "string",
      "description": "Type of user intervention raised."
    },
    "custom": {
      "$ref": "#/components/schemas/insights_resources_payment_evaluation_user_intervention_raised_custom"
    }
  },
  "description": "User intervention raised event details attached to this payment evaluation",
  "x-expandableFields": [
    "custom"
  ]
}

object insights_resources_payment_evaluation_user_intervention_raised_custom

{
  "type": "object",
  "title": "InsightsResourcesPaymentEvaluationUserInterventionRaisedCustom",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "type": "string",
      "maxLength": 5000,
      "description": "Custom type of user intervention raised. The string must use a snake case description for the type of intervention performed."
    }
  },
  "description": "User intervention raised custom event details attached to this payment evaluation",
  "x-expandableFields": []
}

object insights_resources_payment_evaluation_user_intervention_resolved

{
  "type": "object",
  "title": "InsightsResourcesPaymentEvaluationUserInterventionResolved",
  "required": [
    "key"
  ],
  "properties": {
    "key": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique ID of this intervention. Use this to provide the result."
    },
    "outcome": {
      "enum": [
        "abandoned",
        "failed",
        "passed"
      ],
      "type": "string",
      "nullable": true,
      "description": "Result of the intervention if it has been completed."
    }
  },
  "description": "User Intervention Resolved Event details attached to this payment evaluation",
  "x-expandableFields": []
}

object internal_card

{
  "type": "object",
  "title": "internal_card",
  "properties": {
    "brand": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Brand of the card used in the transaction"
    },
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The last 4 digits of the card"
    },
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter ISO code representing the country of the card"
    },
    "exp_year": {
      "type": "integer",
      "nullable": true,
      "description": "Two digit number representing the card's expiration year"
    },
    "exp_month": {
      "type": "integer",
      "nullable": true,
      "description": "Two digit number representing the card's expiration month"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object invoice

{
  "type": "object",
  "title": "Invoice",
  "required": [
    "amount_due",
    "amount_overpaid",
    "amount_paid",
    "amount_remaining",
    "amount_shipping",
    "attempt_count",
    "attempted",
    "auto_advance",
    "automatic_tax",
    "collection_method",
    "created",
    "currency",
    "customer",
    "default_tax_rates",
    "discounts",
    "id",
    "issuer",
    "lines",
    "livemode",
    "object",
    "payment_settings",
    "period_end",
    "period_start",
    "post_payment_credit_notes_amount",
    "pre_payment_credit_notes_amount",
    "starting_balance",
    "status_transitions",
    "subtotal",
    "total"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object. For preview invoices created using the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint, this id will be prefixed with `upcoming_in`."
    },
    "lines": {
      "type": "object",
      "title": "InvoiceLinesList",
      "required": [
        "data",
        "has_more",
        "object",
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "maxLength": 5000,
          "description": "The URL where this list can be accessed."
        },
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/line_item"
          },
          "description": "Details about each object."
        },
        "object": {
          "enum": [
            "list"
          ],
          "type": "string",
          "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
        },
        "has_more": {
          "type": "boolean",
          "description": "True if this list has another page of items after this one that can be fetched."
        }
      },
      "description": "The individual line items that make up the invoice. `lines` is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order.",
      "x-expandableFields": [
        "data"
      ]
    },
    "total": {
      "type": "integer",
      "description": "Total after discounts and taxes."
    },
    "footer": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Footer displayed on the invoice."
    },
    "issuer": {
      "$ref": "#/components/schemas/connect_account_reference"
    },
    "number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified."
    },
    "object": {
      "enum": [
        "invoice"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "parent": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_bill_resource_invoicing_parents_invoice_parent"
        }
      ],
      "nullable": true,
      "description": "The parent that generated this invoice"
    },
    "status": {
      "enum": [
        "draft",
        "open",
        "paid",
        "uncollectible",
        "void"
      ],
      "type": "string",
      "nullable": true,
      "description": "The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://docs.stripe.com/billing/invoices/workflow#workflow-overview)",
      "x-stripeBypassValidation": true
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        },
        {
          "$ref": "#/components/schemas/deleted_customer"
        }
      ],
      "description": "The ID of the customer to bill.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          },
          {
            "$ref": "#/components/schemas/deleted_customer"
          }
        ]
      }
    },
    "due_date": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "payments": {
      "type": "object",
      "title": "InvoicesPaymentsListInvoicePayments",
      "required": [
        "data",
        "has_more",
        "object",
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "maxLength": 5000,
          "description": "The URL where this list can be accessed."
        },
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/invoice_payment"
          },
          "description": "Details about each object."
        },
        "object": {
          "enum": [
            "list"
          ],
          "type": "string",
          "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
        },
        "has_more": {
          "type": "boolean",
          "description": "True if this list has another page of items after this one that can be fetched."
        }
      },
      "description": "Payments for this invoice. Use [invoice payment](/api/invoice-payment) to get more details.",
      "x-expandableFields": [
        "data"
      ]
    },
    "subtotal": {
      "type": "integer",
      "description": "Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated"
    },
    "attempted": {
      "type": "boolean",
      "description": "Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users."
    },
    "discounts": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 5000
          },
          {
            "$ref": "#/components/schemas/discount"
          },
          {
            "$ref": "#/components/schemas/deleted_discount"
          }
        ],
        "x-expansionResources": {
          "oneOf": [
            {
              "$ref": "#/components/schemas/discount"
            },
            {
              "$ref": "#/components/schemas/deleted_discount"
            }
          ]
        }
      },
      "description": "The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount."
    },
    "rendering": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/invoices_resource_invoice_rendering"
        }
      ],
      "nullable": true,
      "description": "The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page."
    },
    "amount_due": {
      "type": "integer",
      "description": "Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`."
    },
    "period_end": {
      "type": "integer",
      "format": "unix-time",
      "description": "End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price."
    },
    "test_clock": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/test_helpers.test_clock"
        }
      ],
      "nullable": true,
      "description": "ID of the test clock this invoice belongs to.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/test_helpers.test_clock"
          }
        ]
      }
    },
    "amount_paid": {
      "type": "integer",
      "description": "The amount, in cents (or local equivalent), that was paid."
    },
    "application": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/application"
        },
        {
          "$ref": "#/components/schemas/deleted_application"
        }
      ],
      "nullable": true,
      "description": "ID of the Connect Application that created the invoice.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/application"
          },
          {
            "$ref": "#/components/schemas/deleted_application"
          }
        ]
      }
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard."
    },
    "invoice_pdf": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null."
    },
    "total_taxes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billing_bill_resource_invoicing_taxes_tax"
      },
      "nullable": true,
      "description": "The aggregate tax information of all line items."
    },
    "account_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The public name of the business associated with this invoice, most often the business creating the invoice."
    },
    "auto_advance": {
      "type": "boolean",
      "description": "Controls whether Stripe performs [automatic collection](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action."
    },
    "effective_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt."
    },
    "from_invoice": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/invoices_resource_from_invoice"
        }
      ],
      "nullable": true,
      "description": "Details of the invoice that was cloned. See the [revision documentation](https://docs.stripe.com/invoicing/invoice-revisions) for more details."
    },
    "on_behalf_of": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/account"
        }
      ],
      "nullable": true,
      "description": "The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://docs.stripe.com/billing/invoices/connect) documentation for details.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/account"
          }
        ]
      }
    },
    "period_start": {
      "type": "integer",
      "format": "unix-time",
      "description": "Start of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price."
    },
    "attempt_count": {
      "type": "integer",
      "description": "Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained."
    },
    "automatic_tax": {
      "$ref": "#/components/schemas/automatic_tax"
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/invoice_setting_custom_field"
      },
      "nullable": true,
      "description": "Custom fields displayed on the invoice."
    },
    "customer_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The customer's name. Until the invoice is finalized, this field will equal `customer.name`. Once the invoice is finalized, this field will no longer be updated."
    },
    "shipping_cost": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/invoices_resource_shipping_cost"
        }
      ],
      "nullable": true,
      "description": "The details of the cost of shipping, including the ShippingRate applied on the invoice."
    },
    "billing_reason": {
      "enum": [
        "automatic_pending_invoice_item_invoice",
        "manual",
        "quote_accept",
        "subscription",
        "subscription_create",
        "subscription_cycle",
        "subscription_threshold",
        "subscription_update",
        "upcoming"
      ],
      "type": "string",
      "nullable": true,
      "description": "Indicates the reason why the invoice was created.\n\n* `manual`: Unrelated to a subscription, for example, created via the invoice editor.\n* `subscription`: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.\n* `subscription_create`: A new subscription was created.\n* `subscription_cycle`: A subscription advanced into a new period.\n* `subscription_threshold`: A subscription reached a billing threshold.\n* `subscription_update`: A subscription was updated.\n* `upcoming`: Reserved for upcoming invoices created through the Create Preview Invoice API or when an `invoice.upcoming` event is generated for an upcoming invoice on a subscription."
    },
    "customer_email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated."
    },
    "customer_phone": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The customer's phone number. Until the invoice is finalized, this field will equal `customer.phone`. Once the invoice is finalized, this field will no longer be updated."
    },
    "default_source": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/bank_account"
        },
        {
          "$ref": "#/components/schemas/card"
        },
        {
          "$ref": "#/components/schemas/source"
        }
      ],
      "nullable": true,
      "description": "ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/bank_account"
          },
          {
            "$ref": "#/components/schemas/card"
          },
          {
            "$ref": "#/components/schemas/source"
          }
        ]
      },
      "x-stripeBypassValidation": true
    },
    "ending_balance": {
      "type": "integer",
      "nullable": true,
      "description": "Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null."
    },
    "receipt_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "This is the transaction number that appears on email receipts sent for this invoice."
    },
    "account_country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The country of the business associated with this invoice, most often the business creating the invoice."
    },
    "account_tax_ids": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 5000
          },
          {
            "$ref": "#/components/schemas/tax_id"
          },
          {
            "$ref": "#/components/schemas/deleted_tax_id"
          }
        ],
        "x-expansionResources": {
          "oneOf": [
            {
              "$ref": "#/components/schemas/tax_id"
            },
            {
              "$ref": "#/components/schemas/deleted_tax_id"
            }
          ]
        }
      },
      "nullable": true,
      "description": "The account tax IDs associated with the invoice. Only editable when the invoice is a draft."
    },
    "amount_overpaid": {
      "type": "integer",
      "description": "Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance."
    },
    "amount_shipping": {
      "type": "integer",
      "description": "This is the sum of all the shipping amounts."
    },
    "latest_revision": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/invoice"
        }
      ],
      "nullable": true,
      "description": "The ID of the most recent non-draft revision of this invoice",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/invoice"
          }
        ]
      }
    },
    "amount_remaining": {
      "type": "integer",
      "description": "The difference between amount_due and amount_paid, in cents (or local equivalent)."
    },
    "customer_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The ID of the account representing the customer to bill."
    },
    "customer_address": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/address"
        }
      ],
      "nullable": true,
      "description": "The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated."
    },
    "customer_tax_ids": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/invoices_resource_invoice_tax_id"
      },
      "nullable": true,
      "description": "The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated."
    },
    "payment_settings": {
      "$ref": "#/components/schemas/invoices_payment_settings"
    },
    "shipping_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/shipping"
        }
      ],
      "nullable": true,
      "description": "Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer."
    },
    "starting_balance": {
      "type": "integer",
      "description": "Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice."
    },
    "threshold_reason": {
      "$ref": "#/components/schemas/invoice_threshold_reason"
    },
    "collection_method": {
      "enum": [
        "charge_automatically",
        "send_invoice"
      ],
      "type": "string",
      "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions."
    },
    "customer_shipping": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/shipping"
        }
      ],
      "nullable": true,
      "description": "The customer's shipping information. Until the invoice is finalized, this field will equal `customer.shipping`. Once the invoice is finalized, this field will no longer be updated."
    },
    "default_tax_rates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/tax_rate"
      },
      "description": "The tax rates applied to this invoice, if any."
    },
    "hosted_invoice_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null."
    },
    "status_transitions": {
      "$ref": "#/components/schemas/invoices_resource_status_transitions"
    },
    "confirmation_secret": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/invoices_resource_confirmation_secret"
        }
      ],
      "nullable": true,
      "description": "The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization."
    },
    "customer_tax_exempt": {
      "enum": [
        "exempt",
        "none",
        "reverse"
      ],
      "type": "string",
      "nullable": true,
      "description": "The customer's tax exempt status. Until the invoice is finalized, this field will equal `customer.tax_exempt`. Once the invoice is finalized, this field will no longer be updated."
    },
    "total_excluding_tax": {
      "type": "integer",
      "nullable": true,
      "description": "The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax."
    },
    "next_payment_attempt": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`."
    },
    "statement_descriptor": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Extra information about an invoice for the customer's credit card statement."
    },
    "webhooks_delivered_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://docs.stripe.com/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created."
    },
    "default_payment_method": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_method"
        }
      ],
      "nullable": true,
      "description": "ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_method"
          }
        ]
      }
    },
    "subtotal_excluding_tax": {
      "type": "integer",
      "nullable": true,
      "description": "The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated"
    },
    "total_discount_amounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/discounts_resource_discount_amount"
      },
      "nullable": true,
      "description": "The aggregate amounts calculated per discount across all line items."
    },
    "last_finalization_error": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/api_errors"
        }
      ],
      "nullable": true,
      "description": "The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized."
    },
    "automatically_finalizes_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The time when this invoice is currently scheduled to be automatically finalized. The field will be `null` if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be `null` - see `finalized_at` for the time when an already-finalized invoice was finalized."
    },
    "total_pretax_credit_amounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/invoices_resource_pretax_credit_amount"
      },
      "nullable": true,
      "description": "Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items."
    },
    "pre_payment_credit_notes_amount": {
      "type": "integer",
      "description": "Total amount of all pre-payment credit notes issued for this invoice."
    },
    "post_payment_credit_notes_amount": {
      "type": "integer",
      "description": "Total amount of all post-payment credit notes issued for this invoice."
    }
  },
  "description": "Invoices are statements of amounts owed by a customer, and are either\ngenerated one-off, or generated periodically from a subscription.\n\nThey contain [invoice items](https://api.stripe.com#invoiceitems), and proration adjustments\nthat may be caused by subscription upgrades/downgrades (if necessary).\n\nIf your invoice is configured to be billed through automatic charges,\nStripe automatically finalizes your invoice and attempts payment. Note\nthat finalizing the invoice,\n[when automatic](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection), does\nnot happen immediately as the invoice is created. Stripe waits\nuntil one hour after the last webhook was successfully sent (or the last\nwebhook timed out after failing). If you (and the platforms you may have\nconnected to) have no webhooks configured, Stripe waits one hour after\ncreation to finalize the invoice.\n\nIf your invoice is configured to be billed by sending an email, then based on your\n[email settings](https://dashboard.stripe.com/account/billing/automatic),\nStripe will email the invoice to your customer and await payment. These\nemails can contain a link to a hosted page to pay the invoice.\n\nStripe applies any customer credit on the account before determining the\namount due for the invoice (i.e., the amount that will be actually\ncharged). If the amount due for the invoice is less than Stripe's [minimum allowed charge\nper currency](/docs/currencies#minimum-and-maximum-charge-amounts), the\ninvoice is automatically marked paid, and we add the amount due to the\ncustomer's credit balance which is applied to the next invoice.\n\nMore details on the customer's credit balance are\n[here](https://docs.stripe.com/billing/customer/balance).\n\nRelated guide: [Send invoices to customers](https://docs.stripe.com/billing/invoices/sending)",
  "x-resourceId": "invoice",
  "x-expandableFields": [
    "account_tax_ids",
    "application",
    "automatic_tax",
    "confirmation_secret",
    "custom_fields",
    "customer",
    "customer_address",
    "customer_shipping",
    "customer_tax_ids",
    "default_payment_method",
    "default_source",
    "default_tax_rates",
    "discounts",
    "from_invoice",
    "issuer",
    "last_finalization_error",
    "latest_revision",
    "lines",
    "on_behalf_of",
    "parent",
    "payment_settings",
    "payments",
    "rendering",
    "shipping_cost",
    "shipping_details",
    "status_transitions",
    "test_clock",
    "threshold_reason",
    "total_discount_amounts",
    "total_pretax_credit_amounts",
    "total_taxes"
  ]
}

object invoice_installments_card

{
  "type": "object",
  "title": "invoice_installments_card",
  "properties": {
    "enabled": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether Installments are enabled for this Invoice."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object invoice_item_threshold_reason

{
  "type": "object",
  "title": "InvoiceItemThresholdReason",
  "required": [
    "line_item_ids",
    "usage_gte"
  ],
  "properties": {
    "usage_gte": {
      "type": "integer",
      "description": "The quantity threshold boundary that applied to the given line item."
    },
    "line_item_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "The IDs of the line items that triggered the threshold invoice."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object invoice_line_item_period

{
  "type": "object",
  "title": "InvoiceLineItemPeriod",
  "required": [
    "end",
    "start"
  ],
  "properties": {
    "end": {
      "type": "integer",
      "format": "unix-time",
      "description": "The end of the period, which must be greater than or equal to the start. This value is inclusive."
    },
    "start": {
      "type": "integer",
      "format": "unix-time",
      "description": "The start of the period. This value is inclusive."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object invoice_mandate_options_card

{
  "type": "object",
  "title": "invoice_mandate_options_card",
  "properties": {
    "amount": {
      "type": "integer",
      "nullable": true,
      "description": "Amount to be charged for future payments, specified in the presentment currency."
    },
    "amount_type": {
      "enum": [
        "fixed",
        "maximum"
      ],
      "type": "string",
      "nullable": true,
      "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 200,
      "description": "A description of the mandate or subscription that is meant to be displayed to the customer."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object invoice_mandate_options_payto

{
  "type": "object",
  "title": "invoice_mandate_options_payto",
  "properties": {
    "amount": {
      "type": "integer",
      "nullable": true,
      "description": "The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit."
    },
    "purpose": {
      "enum": [
        "dependant_support",
        "government",
        "loan",
        "mortgage",
        "other",
        "pension",
        "personal",
        "retail",
        "salary",
        "tax",
        "utility"
      ],
      "type": "string",
      "nullable": true,
      "description": "The purpose for which payments are made. Has a default value based on your merchant category code."
    },
    "amount_type": {
      "enum": [
        "fixed",
        "maximum"
      ],
      "type": "string",
      "nullable": true,
      "description": "Only `maximum` is supported."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object invoice_payment

{
  "type": "object",
  "title": "InvoicesInvoicePayment",
  "required": [
    "amount_requested",
    "created",
    "currency",
    "id",
    "invoice",
    "is_default",
    "livemode",
    "object",
    "payment",
    "status",
    "status_transitions"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "invoice_payment"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "type": "string",
      "maxLength": 5000,
      "description": "The status of the payment, one of `open`, `paid`, or `canceled`."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "invoice": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/invoice"
        },
        {
          "$ref": "#/components/schemas/deleted_invoice"
        }
      ],
      "description": "The invoice that was paid.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/invoice"
          },
          {
            "$ref": "#/components/schemas/deleted_invoice"
          }
        ]
      }
    },
    "payment": {
      "$ref": "#/components/schemas/invoices_payments_invoice_payment_associated_payment"
    },
    "currency": {
      "type": "string",
      "maxLength": 5000,
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "is_default": {
      "type": "boolean",
      "description": "Stripe automatically creates a default InvoicePayment when the invoice is finalized, and keeps it synchronized with the invoice’s `amount_remaining`. The PaymentIntent associated with the default payment can’t be edited or canceled directly."
    },
    "amount_paid": {
      "type": "integer",
      "nullable": true,
      "description": "Amount that was actually paid for this invoice, in cents (or local equivalent). This field is null until the payment is `paid`. This amount can be less than the `amount_requested` if the PaymentIntent’s `amount_received` is not sufficient to pay all of the invoices that it is attached to."
    },
    "amount_requested": {
      "type": "integer",
      "description": "Amount intended to be paid toward this invoice, in cents (or local equivalent)"
    },
    "status_transitions": {
      "$ref": "#/components/schemas/invoices_payments_invoice_payment_status_transitions"
    }
  },
  "description": "Invoice Payments represent payments made against invoices. Invoice Payments can\nbe accessed in two ways:\n1. By expanding the `payments` field on the [Invoice](https://api.stripe.com#invoice) resource.\n2. By using the Invoice Payment retrieve and list endpoints.\n\nInvoice Payments include the mapping between payment objects, such as Payment Intent, and Invoices.\nThis resource and its endpoints allows you to easily track if a payment is associated with a specific invoice and\nmonitor the allocation details of the payments.",
  "x-resourceId": "invoice_payment",
  "x-expandableFields": [
    "invoice",
    "payment",
    "status_transitions"
  ]
}

object invoice_payment_method_options_acss_debit

{
  "type": "object",
  "title": "invoice_payment_method_options_acss_debit",
  "properties": {
    "mandate_options": {
      "$ref": "#/components/schemas/invoice_payment_method_options_acss_debit_mandate_options"
    },
    "verification_method": {
      "enum": [
        "automatic",
        "instant",
        "microdeposits"
      ],
      "type": "string",
      "description": "Bank account verification method. The default value is `automatic`.",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": [
    "mandate_options"
  ]
}

object invoice_payment_method_options_acss_debit_mandate_options

{
  "type": "object",
  "title": "invoice_payment_method_options_acss_debit_mandate_options",
  "properties": {
    "transaction_type": {
      "enum": [
        "business",
        "personal"
      ],
      "type": "string",
      "nullable": true,
      "description": "Transaction type of the mandate."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object invoice_payment_method_options_bancontact

{
  "type": "object",
  "title": "invoice_payment_method_options_bancontact",
  "required": [
    "preferred_language"
  ],
  "properties": {
    "preferred_language": {
      "enum": [
        "de",
        "en",
        "fr",
        "nl"
      ],
      "type": "string",
      "description": "Preferred language of the Bancontact authorization page that the customer is redirected to."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object invoice_payment_method_options_card

{
  "type": "object",
  "title": "invoice_payment_method_options_card",
  "properties": {
    "installments": {
      "$ref": "#/components/schemas/invoice_installments_card"
    },
    "request_three_d_secure": {
      "enum": [
        "any",
        "automatic",
        "challenge"
      ],
      "type": "string",
      "nullable": true,
      "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://docs.stripe.com/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine."
    }
  },
  "description": "",
  "x-expandableFields": [
    "installments"
  ]
}

object invoice_payment_method_options_customer_balance

{
  "type": "object",
  "title": "invoice_payment_method_options_customer_balance",
  "properties": {
    "funding_type": {
      "enum": [
        "bank_transfer"
      ],
      "type": "string",
      "nullable": true,
      "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`."
    },
    "bank_transfer": {
      "$ref": "#/components/schemas/invoice_payment_method_options_customer_balance_bank_transfer"
    }
  },
  "description": "",
  "x-expandableFields": [
    "bank_transfer"
  ]
}

object invoice_payment_method_options_customer_balance_bank_transfer

{
  "type": "object",
  "title": "invoice_payment_method_options_customer_balance_bank_transfer",
  "properties": {
    "type": {
      "type": "string",
      "nullable": true,
      "description": "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`."
    },
    "eu_bank_transfer": {
      "$ref": "#/components/schemas/invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer"
    }
  },
  "description": "",
  "x-expandableFields": [
    "eu_bank_transfer"
  ]
}

object invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer

{
  "type": "object",
  "title": "invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer",
  "required": [
    "country"
  ],
  "properties": {
    "country": {
      "enum": [
        "BE",
        "DE",
        "ES",
        "FR",
        "IE",
        "NL"
      ],
      "type": "string",
      "description": "The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object invoice_payment_method_options_konbini

{
  "type": "object",
  "title": "invoice_payment_method_options_konbini",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object invoice_payment_method_options_payto

{
  "type": "object",
  "title": "invoice_payment_method_options_payto",
  "properties": {
    "mandate_options": {
      "$ref": "#/components/schemas/invoice_mandate_options_payto"
    }
  },
  "description": "",
  "x-expandableFields": [
    "mandate_options"
  ]
}

object invoice_payment_method_options_sepa_debit

{
  "type": "object",
  "title": "invoice_payment_method_options_sepa_debit",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object invoice_payment_method_options_us_bank_account

{
  "type": "object",
  "title": "invoice_payment_method_options_us_bank_account",
  "properties": {
    "verification_method": {
      "enum": [
        "automatic",
        "instant",
        "microdeposits"
      ],
      "type": "string",
      "description": "Bank account verification method. The default value is `automatic`.",
      "x-stripeBypassValidation": true
    },
    "financial_connections": {
      "$ref": "#/components/schemas/invoice_payment_method_options_us_bank_account_linked_account_options"
    }
  },
  "description": "",
  "x-expandableFields": [
    "financial_connections"
  ]
}

object invoice_payment_method_options_us_bank_account_linked_account_options

{
  "type": "object",
  "title": "invoice_payment_method_options_us_bank_account_linked_account_options",
  "properties": {
    "filters": {
      "$ref": "#/components/schemas/invoice_payment_method_options_us_bank_account_linked_account_options_filters"
    },
    "prefetch": {
      "type": "array",
      "items": {
        "enum": [
          "balances",
          "ownership",
          "transactions"
        ],
        "type": "string",
        "x-stripeBypassValidation": true
      },
      "nullable": true,
      "description": "Data features requested to be retrieved upon account creation."
    },
    "permissions": {
      "type": "array",
      "items": {
        "enum": [
          "balances",
          "ownership",
          "payment_method",
          "transactions"
        ],
        "type": "string"
      },
      "description": "The list of permissions to request. The `payment_method` permission must be included."
    }
  },
  "description": "",
  "x-expandableFields": [
    "filters"
  ]
}

object invoice_payment_method_options_us_bank_account_linked_account_options_filters

{
  "type": "object",
  "title": "invoice_payment_method_options_us_bank_account_linked_account_options_filters",
  "properties": {
    "account_subcategories": {
      "type": "array",
      "items": {
        "enum": [
          "checking",
          "savings"
        ],
        "type": "string"
      },
      "description": "The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object invoice_rendering_pdf

{
  "type": "object",
  "title": "InvoiceRenderingPdf",
  "properties": {
    "page_size": {
      "enum": [
        "a4",
        "auto",
        "letter"
      ],
      "type": "string",
      "nullable": true,
      "description": "Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object invoice_rendering_template

{
  "type": "object",
  "title": "InvoiceRenderingTemplate",
  "required": [
    "created",
    "id",
    "livemode",
    "object",
    "status",
    "version"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "invoice_rendering_template"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "active",
        "archived"
      ],
      "type": "string",
      "description": "The status of the template, one of `active` or `archived`."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "version": {
      "type": "integer",
      "description": "Version of this template; version increases by one when an update on the template changes any field that controls invoice rendering"
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "nickname": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A brief description of the template, hidden from customers"
    }
  },
  "description": "Invoice Rendering Templates are used to configure how invoices are rendered on surfaces like the PDF. Invoice Rendering Templates\ncan be created from within the Dashboard, and they can be used over the API when creating invoices.",
  "x-resourceId": "invoice_rendering_template",
  "x-expandableFields": []
}

object invoice_setting_checkout_rendering_options

{
  "type": "object",
  "title": "invoice_setting_checkout_rendering_options",
  "properties": {
    "template": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the invoice rendering template to be used for the generated invoice."
    },
    "amount_tax_display": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object invoice_setting_custom_field

{
  "type": "object",
  "title": "InvoiceSettingCustomField",
  "required": [
    "name",
    "value"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The name of the custom field."
    },
    "value": {
      "type": "string",
      "maxLength": 5000,
      "description": "The value of the custom field."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object invoice_setting_customer_rendering_options

{
  "type": "object",
  "title": "InvoiceSettingCustomerRenderingOptions",
  "properties": {
    "template": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice."
    },
    "amount_tax_display": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object invoice_setting_customer_setting

{
  "type": "object",
  "title": "InvoiceSettingCustomerSetting",
  "properties": {
    "footer": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Default footer to be displayed on invoices for this customer."
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/invoice_setting_custom_field"
      },
      "nullable": true,
      "description": "Default custom fields to be displayed on invoices for this customer."
    },
    "rendering_options": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/invoice_setting_customer_rendering_options"
        }
      ],
      "nullable": true,
      "description": "Default options for invoice PDF rendering for this customer."
    },
    "default_payment_method": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_method"
        }
      ],
      "nullable": true,
      "description": "ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_method"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "custom_fields",
    "default_payment_method",
    "rendering_options"
  ]
}

object invoice_setting_quote_setting

{
  "type": "object",
  "title": "InvoiceSettingQuoteSetting",
  "required": [
    "issuer"
  ],
  "properties": {
    "issuer": {
      "$ref": "#/components/schemas/connect_account_reference"
    },
    "days_until_due": {
      "type": "integer",
      "nullable": true,
      "description": "Number of days within which a customer must pay invoices generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`."
    }
  },
  "description": "",
  "x-expandableFields": [
    "issuer"
  ]
}

object invoice_setting_subscription_schedule_phase_setting

{
  "type": "object",
  "title": "InvoiceSettingSubscriptionSchedulePhaseSetting",
  "properties": {
    "issuer": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/connect_account_reference"
        }
      ],
      "nullable": true,
      "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account."
    },
    "days_until_due": {
      "type": "integer",
      "nullable": true,
      "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`."
    },
    "account_tax_ids": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 5000
          },
          {
            "$ref": "#/components/schemas/tax_id"
          },
          {
            "$ref": "#/components/schemas/deleted_tax_id"
          }
        ],
        "x-expansionResources": {
          "oneOf": [
            {
              "$ref": "#/components/schemas/tax_id"
            },
            {
              "$ref": "#/components/schemas/deleted_tax_id"
            }
          ]
        }
      },
      "nullable": true,
      "description": "The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule."
    }
  },
  "description": "",
  "x-expandableFields": [
    "account_tax_ids",
    "issuer"
  ]
}

object invoice_setting_subscription_schedule_setting

{
  "type": "object",
  "title": "InvoiceSettingSubscriptionScheduleSetting",
  "required": [
    "issuer"
  ],
  "properties": {
    "issuer": {
      "$ref": "#/components/schemas/connect_account_reference"
    },
    "days_until_due": {
      "type": "integer",
      "nullable": true,
      "description": "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`."
    },
    "account_tax_ids": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 5000
          },
          {
            "$ref": "#/components/schemas/tax_id"
          },
          {
            "$ref": "#/components/schemas/deleted_tax_id"
          }
        ],
        "x-expansionResources": {
          "oneOf": [
            {
              "$ref": "#/components/schemas/tax_id"
            },
            {
              "$ref": "#/components/schemas/deleted_tax_id"
            }
          ]
        }
      },
      "nullable": true,
      "description": "The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule."
    }
  },
  "description": "",
  "x-expandableFields": [
    "account_tax_ids",
    "issuer"
  ]
}

object invoice_threshold_reason

{
  "type": "object",
  "title": "InvoiceThresholdReason",
  "required": [
    "item_reasons"
  ],
  "properties": {
    "amount_gte": {
      "type": "integer",
      "nullable": true,
      "description": "The total invoice amount threshold boundary if it triggered the threshold invoice."
    },
    "item_reasons": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/invoice_item_threshold_reason"
      },
      "description": "Indicates which line items triggered a threshold invoice."
    }
  },
  "description": "",
  "x-expandableFields": [
    "item_reasons"
  ]
}

object invoiceitem

{
  "type": "object",
  "title": "InvoiceItem",
  "required": [
    "amount",
    "currency",
    "customer",
    "date",
    "discountable",
    "id",
    "livemode",
    "object",
    "period",
    "proration",
    "quantity",
    "quantity_decimal"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "date": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "amount": {
      "type": "integer",
      "description": "Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`."
    },
    "object": {
      "enum": [
        "invoiceitem"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "parent": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_bill_resource_invoice_item_parents_invoice_item_parent"
        }
      ],
      "nullable": true,
      "description": "The parent that generated this invoice item."
    },
    "period": {
      "$ref": "#/components/schemas/invoice_line_item_period"
    },
    "invoice": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/invoice"
        }
      ],
      "nullable": true,
      "description": "The ID of the invoice this invoice item belongs to.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/invoice"
          }
        ]
      }
    },
    "pricing": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_bill_resource_invoicing_pricing_pricing"
        }
      ],
      "nullable": true,
      "description": "The pricing information of the invoice item."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        },
        {
          "$ref": "#/components/schemas/deleted_customer"
        }
      ],
      "description": "The ID of the customer to bill for this invoice item.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          },
          {
            "$ref": "#/components/schemas/deleted_customer"
          }
        ]
      }
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "quantity": {
      "type": "integer",
      "description": "Quantity of units for the invoice item in integer format, with any decimal precision truncated. For the item's full-precision decimal quantity, use `quantity_decimal`. This field will be deprecated in favor of `quantity_decimal` in a future version. If the invoice item is a proration, the quantity of the subscription that the proration was computed for."
    },
    "discounts": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 5000
          },
          {
            "$ref": "#/components/schemas/discount"
          }
        ],
        "x-expansionResources": {
          "oneOf": [
            {
              "$ref": "#/components/schemas/discount"
            }
          ]
        }
      },
      "nullable": true,
      "description": "The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount."
    },
    "proration": {
      "type": "boolean",
      "description": "Whether the invoice item was created automatically as a proration adjustment when the customer switched plans."
    },
    "tax_rates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/tax_rate"
      },
      "nullable": true,
      "description": "The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item."
    },
    "net_amount": {
      "type": "integer",
      "description": "The amount after discounts, but before credits and taxes. This field is `null` for `discountable=true` items."
    },
    "test_clock": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/test_helpers.test_clock"
        }
      ],
      "nullable": true,
      "description": "ID of the test clock this invoice item belongs to.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/test_helpers.test_clock"
          }
        ]
      }
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An arbitrary string attached to the object. Often useful for displaying to users."
    },
    "discountable": {
      "type": "boolean",
      "description": "If true, discounts will apply to this invoice item. Always false for prorations."
    },
    "customer_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The ID of the account to bill for this invoice item."
    },
    "quantity_decimal": {
      "type": "string",
      "format": "decimal",
      "description": "Non-negative decimal with at most 12 decimal places. The quantity of units for the invoice item."
    },
    "proration_details": {
      "$ref": "#/components/schemas/proration_details"
    }
  },
  "description": "Invoice Items represent the component lines of an [invoice](https://docs.stripe.com/api/invoices). When you create an invoice item with an `invoice` field, it is attached to the specified invoice and included as [an invoice line item](https://docs.stripe.com/api/invoices/line_item) within [invoice.lines](https://docs.stripe.com/api/invoices/object#invoice_object-lines).\n\nInvoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined\nwith a [subscription](https://docs.stripe.com/api/subscriptions). Sometimes you want to add a charge or credit to a customer, but actually charge\nor credit the customer's card only at the end of a regular billing cycle. This is useful for combining several charges\n(to minimize per-transaction fees), or for having Stripe tabulate your usage-based billing totals.\n\nRelated guides: [Integrate with the Invoicing API](https://docs.stripe.com/invoicing/integration), [Subscription Invoices](https://docs.stripe.com/billing/invoices/subscription#adding-upcoming-invoice-items).",
  "x-resourceId": "invoiceitem",
  "x-expandableFields": [
    "customer",
    "discounts",
    "invoice",
    "parent",
    "period",
    "pricing",
    "proration_details",
    "tax_rates",
    "test_clock"
  ]
}

object invoices_payment_method_options

{
  "type": "object",
  "title": "InvoicesPaymentMethodOptions",
  "properties": {
    "card": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/invoice_payment_method_options_card"
        }
      ],
      "nullable": true,
      "description": "If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent."
    },
    "payto": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/invoice_payment_method_options_payto"
        }
      ],
      "nullable": true,
      "description": "If paying by `payto`, this sub-hash contains details about the PayTo payment method options to pass to the invoice’s PaymentIntent."
    },
    "konbini": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/invoice_payment_method_options_konbini"
        }
      ],
      "nullable": true,
      "description": "If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent."
    },
    "acss_debit": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/invoice_payment_method_options_acss_debit"
        }
      ],
      "nullable": true,
      "description": "If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent."
    },
    "bancontact": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/invoice_payment_method_options_bancontact"
        }
      ],
      "nullable": true,
      "description": "If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent."
    },
    "sepa_debit": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/invoice_payment_method_options_sepa_debit"
        }
      ],
      "nullable": true,
      "description": "If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent."
    },
    "us_bank_account": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/invoice_payment_method_options_us_bank_account"
        }
      ],
      "nullable": true,
      "description": "If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent."
    },
    "customer_balance": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/invoice_payment_method_options_customer_balance"
        }
      ],
      "nullable": true,
      "description": "If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent."
    }
  },
  "description": "",
  "x-expandableFields": [
    "acss_debit",
    "bancontact",
    "card",
    "customer_balance",
    "konbini",
    "payto",
    "sepa_debit",
    "us_bank_account"
  ]
}

object invoices_payment_settings

{
  "type": "object",
  "title": "InvoicesPaymentSettings",
  "properties": {
    "default_mandate": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set."
    },
    "payment_method_types": {
      "type": "array",
      "items": {
        "enum": [
          "ach_credit_transfer",
          "ach_debit",
          "acss_debit",
          "affirm",
          "amazon_pay",
          "au_becs_debit",
          "bacs_debit",
          "bancontact",
          "boleto",
          "card",
          "cashapp",
          "crypto",
          "custom",
          "customer_balance",
          "eps",
          "fpx",
          "giropay",
          "grabpay",
          "ideal",
          "jp_credit_transfer",
          "kakao_pay",
          "klarna",
          "konbini",
          "kr_card",
          "link",
          "multibanco",
          "naver_pay",
          "nz_bank_account",
          "p24",
          "pay_by_bank",
          "payco",
          "paynow",
          "paypal",
          "payto",
          "promptpay",
          "revolut_pay",
          "sepa_credit_transfer",
          "sepa_debit",
          "sofort",
          "swish",
          "us_bank_account",
          "wechat_pay"
        ],
        "type": "string",
        "x-stripeBypassValidation": true
      },
      "nullable": true,
      "description": "The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice)."
    },
    "payment_method_options": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/invoices_payment_method_options"
        }
      ],
      "nullable": true,
      "description": "Payment-method-specific configuration to provide to the invoice’s PaymentIntent."
    }
  },
  "description": "",
  "x-expandableFields": [
    "payment_method_options"
  ]
}

object invoices_payments_invoice_payment_associated_payment

{
  "type": "object",
  "title": "InvoicesPaymentsInvoicePaymentAssociatedPayment",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "charge",
        "payment_intent",
        "payment_record"
      ],
      "type": "string",
      "description": "Type of payment object associated with this invoice payment."
    },
    "charge": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/charge"
        }
      ],
      "description": "ID of the successful charge for this payment when `type` is `charge`.Note: charge is only surfaced if the charge object is not associated with a payment intent. If the charge object does have a payment intent, the Invoice Payment surfaces the payment intent instead.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/charge"
          }
        ]
      }
    },
    "payment_intent": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_intent"
        }
      ],
      "description": "ID of the PaymentIntent associated with this payment when `type` is `payment_intent`. Note: This property is only populated for invoices finalized on or after March 15th, 2019.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_intent"
          }
        ]
      }
    },
    "payment_record": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_record"
        }
      ],
      "description": "ID of the PaymentRecord associated with this payment when `type` is `payment_record`.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_record"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "charge",
    "payment_intent",
    "payment_record"
  ]
}

object invoices_payments_invoice_payment_status_transitions

{
  "type": "object",
  "title": "InvoicesPaymentsInvoicePaymentStatusTransitions",
  "properties": {
    "paid_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The time that the payment succeeded."
    },
    "canceled_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The time that the payment was canceled."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object invoices_resource_confirmation_secret

{
  "type": "object",
  "title": "InvoicesResourceConfirmationSecret",
  "required": [
    "client_secret",
    "type"
  ],
  "properties": {
    "type": {
      "type": "string",
      "maxLength": 5000,
      "description": "The type of client_secret. Currently this is always payment_intent, referencing the default payment_intent that Stripe creates during invoice finalization"
    },
    "client_secret": {
      "type": "string",
      "maxLength": 5000,
      "description": "The client_secret of the payment that Stripe creates for the invoice after finalization."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object invoices_resource_from_invoice

{
  "type": "object",
  "title": "InvoicesResourceFromInvoice",
  "required": [
    "action",
    "invoice"
  ],
  "properties": {
    "action": {
      "type": "string",
      "maxLength": 5000,
      "description": "The relation between this invoice and the cloned invoice"
    },
    "invoice": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/invoice"
        }
      ],
      "description": "The invoice that was cloned.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/invoice"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "invoice"
  ]
}

object invoices_resource_invoice_rendering

{
  "type": "object",
  "title": "InvoicesResourceInvoiceRendering",
  "properties": {
    "pdf": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/invoice_rendering_pdf"
        }
      ],
      "nullable": true,
      "description": "Invoice pdf rendering options"
    },
    "template": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the rendering template that the invoice is formatted by."
    },
    "template_version": {
      "type": "integer",
      "nullable": true,
      "description": "Version of the rendering template that the invoice is using."
    },
    "amount_tax_display": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs."
    }
  },
  "description": "",
  "x-expandableFields": [
    "pdf"
  ]
}

object invoices_resource_invoice_tax_id

{
  "type": "object",
  "title": "InvoicesResourceInvoiceTaxID",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "ad_nrt",
        "ae_trn",
        "al_tin",
        "am_tin",
        "ao_tin",
        "ar_cuit",
        "au_abn",
        "au_arn",
        "aw_tin",
        "az_tin",
        "ba_tin",
        "bb_tin",
        "bd_bin",
        "bf_ifu",
        "bg_uic",
        "bh_vat",
        "bj_ifu",
        "bo_tin",
        "br_cnpj",
        "br_cpf",
        "bs_tin",
        "by_tin",
        "ca_bn",
        "ca_gst_hst",
        "ca_pst_bc",
        "ca_pst_mb",
        "ca_pst_sk",
        "ca_qst",
        "cd_nif",
        "ch_uid",
        "ch_vat",
        "cl_tin",
        "cm_niu",
        "cn_tin",
        "co_nit",
        "cr_tin",
        "cv_nif",
        "de_stn",
        "do_rcn",
        "ec_ruc",
        "eg_tin",
        "es_cif",
        "et_tin",
        "eu_oss_vat",
        "eu_vat",
        "gb_vat",
        "ge_vat",
        "gn_nif",
        "hk_br",
        "hr_oib",
        "hu_tin",
        "id_npwp",
        "il_vat",
        "in_gst",
        "is_vat",
        "jp_cn",
        "jp_rn",
        "jp_trn",
        "ke_pin",
        "kg_tin",
        "kh_tin",
        "kr_brn",
        "kz_bin",
        "la_tin",
        "li_uid",
        "li_vat",
        "lk_vat",
        "ma_vat",
        "md_vat",
        "me_pib",
        "mk_vat",
        "mr_nif",
        "mx_rfc",
        "my_frp",
        "my_itn",
        "my_sst",
        "ng_tin",
        "no_vat",
        "no_voec",
        "np_pan",
        "nz_gst",
        "om_vat",
        "pe_ruc",
        "ph_tin",
        "pl_nip",
        "ro_tin",
        "rs_pib",
        "ru_inn",
        "ru_kpp",
        "sa_vat",
        "sg_gst",
        "sg_uen",
        "si_tin",
        "sn_ninea",
        "sr_fin",
        "sv_nit",
        "th_vat",
        "tj_tin",
        "tr_tin",
        "tw_vat",
        "tz_vat",
        "ua_vat",
        "ug_tin",
        "unknown",
        "us_ein",
        "uy_ruc",
        "uz_tin",
        "uz_vat",
        "ve_rif",
        "vn_tin",
        "za_vat",
        "zm_tin",
        "zw_tin"
      ],
      "type": "string",
      "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`"
    },
    "value": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The value of the tax ID."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object invoices_resource_pretax_credit_amount

{
  "type": "object",
  "title": "InvoicesResourcePretaxCreditAmount",
  "required": [
    "amount",
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "credit_balance_transaction",
        "discount"
      ],
      "type": "string",
      "description": "Type of the pretax credit amount referenced.",
      "x-stripeBypassValidation": true
    },
    "amount": {
      "type": "integer",
      "description": "The amount, in cents (or local equivalent), of the pretax credit amount."
    },
    "discount": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/discount"
        },
        {
          "$ref": "#/components/schemas/deleted_discount"
        }
      ],
      "description": "The discount that was applied to get this pretax credit amount.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/discount"
          },
          {
            "$ref": "#/components/schemas/deleted_discount"
          }
        ]
      }
    },
    "credit_balance_transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/billing.credit_balance_transaction"
        }
      ],
      "nullable": true,
      "description": "The credit balance transaction that was applied to get this pretax credit amount.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/billing.credit_balance_transaction"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "credit_balance_transaction",
    "discount"
  ]
}

object invoices_resource_shipping_cost

{
  "type": "object",
  "title": "InvoicesResourceShippingCost",
  "required": [
    "amount_subtotal",
    "amount_tax",
    "amount_total"
  ],
  "properties": {
    "taxes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/line_items_tax_amount"
      },
      "description": "The taxes applied to the shipping rate."
    },
    "amount_tax": {
      "type": "integer",
      "description": "Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0."
    },
    "amount_total": {
      "type": "integer",
      "description": "Total shipping cost after taxes are applied."
    },
    "shipping_rate": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/shipping_rate"
        }
      ],
      "nullable": true,
      "description": "The ID of the ShippingRate for this invoice.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/shipping_rate"
          }
        ]
      }
    },
    "amount_subtotal": {
      "type": "integer",
      "description": "Total shipping cost before any taxes are applied."
    }
  },
  "description": "",
  "x-expandableFields": [
    "shipping_rate",
    "taxes"
  ]
}

object invoices_resource_status_transitions

{
  "type": "object",
  "title": "InvoicesResourceStatusTransitions",
  "properties": {
    "paid_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The time that the invoice was paid."
    },
    "voided_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The time that the invoice was voided."
    },
    "finalized_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The time that the invoice draft was finalized."
    },
    "marked_uncollectible_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The time that the invoice was marked uncollectible."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing.authorization

{
  "type": "object",
  "title": "IssuingAuthorization",
  "required": [
    "amount",
    "approved",
    "authorization_method",
    "balance_transactions",
    "card",
    "created",
    "currency",
    "id",
    "livemode",
    "merchant_amount",
    "merchant_currency",
    "merchant_data",
    "metadata",
    "object",
    "request_history",
    "status",
    "transactions",
    "verification_data"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "card": {
      "$ref": "#/components/schemas/issuing.card"
    },
    "fuel": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_authorization_fuel_data"
        }
      ],
      "nullable": true,
      "description": "Information about fuel that was purchased with this transaction. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed."
    },
    "fleet": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_authorization_fleet_data"
        }
      ],
      "nullable": true,
      "description": "Fleet-specific information for authorizations using Fleet cards."
    },
    "token": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/issuing.token"
        }
      ],
      "nullable": true,
      "description": "[Token](https://docs.stripe.com/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/issuing.token"
          }
        ]
      }
    },
    "amount": {
      "type": "integer",
      "description": "The total amount that was authorized or rejected. This amount is in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `amount` should be the same as `merchant_amount`, unless `currency` and `merchant_currency` are different."
    },
    "object": {
      "enum": [
        "issuing.authorization"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "closed",
        "expired",
        "pending",
        "reversed"
      ],
      "type": "string",
      "description": "The current status of the authorization in its lifecycle."
    },
    "wallet": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "approved": {
      "type": "boolean",
      "description": "Whether the authorization has been approved."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "treasury": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_authorization_treasury"
        }
      ],
      "nullable": true,
      "description": "[Treasury](https://docs.stripe.com/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://docs.stripe.com/api/treasury/financial_accounts)."
    },
    "cardholder": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/issuing.cardholder"
        }
      ],
      "nullable": true,
      "description": "The cardholder to whom this authorization belongs.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/issuing.cardholder"
          }
        ]
      }
    },
    "network_data": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_authorization_network_data"
        }
      ],
      "nullable": true,
      "description": "Details about the authorization, such as identifiers, set by the card network."
    },
    "transactions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/issuing.transaction"
      },
      "description": "List of [transactions](https://docs.stripe.com/api/issuing/transactions) associated with this authorization."
    },
    "merchant_data": {
      "$ref": "#/components/schemas/issuing_authorization_merchant_data"
    },
    "amount_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_authorization_amount_details"
        }
      ],
      "nullable": true,
      "description": "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."
    },
    "merchant_amount": {
      "type": "integer",
      "description": "The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `merchant_amount` should be the same as `amount`, unless `merchant_currency` and `currency` are different."
    },
    "pending_request": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_authorization_pending_request"
        }
      ],
      "nullable": true,
      "description": "The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook."
    },
    "request_history": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/issuing_authorization_request"
      },
      "description": "History of every time a `pending_request` authorization was approved/declined, either by you directly or by Stripe (e.g. based on your spending_controls). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined."
    },
    "fraud_challenges": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/issuing_authorization_fraud_challenge"
      },
      "nullable": true,
      "description": "Fraud challenges sent to the cardholder, if this authorization was declined for fraud risk reasons."
    },
    "merchant_currency": {
      "type": "string",
      "format": "currency",
      "description": "The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "verification_data": {
      "$ref": "#/components/schemas/issuing_authorization_verification_data"
    },
    "authorization_method": {
      "enum": [
        "chip",
        "contactless",
        "keyed_in",
        "online",
        "swipe"
      ],
      "type": "string",
      "description": "How the card details were provided."
    },
    "balance_transactions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/balance_transaction"
      },
      "description": "List of balance transactions associated with this authorization."
    },
    "verified_by_fraud_challenge": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether the authorization bypassed fraud risk checks because the cardholder has previously completed a fraud challenge on a similar high-risk authorization from the same merchant."
    }
  },
  "description": "When an [issued card](https://docs.stripe.com/issuing) is used to make a purchase, an Issuing `Authorization`\nobject is created. [Authorizations](https://docs.stripe.com/issuing/purchases/authorizations) must be approved for the\npurchase to be completed successfully.\n\nRelated guide: [Issued card authorizations](https://docs.stripe.com/issuing/purchases/authorizations)",
  "x-resourceId": "issuing.authorization",
  "x-expandableFields": [
    "amount_details",
    "balance_transactions",
    "card",
    "cardholder",
    "fleet",
    "fraud_challenges",
    "fuel",
    "merchant_data",
    "network_data",
    "pending_request",
    "request_history",
    "token",
    "transactions",
    "treasury",
    "verification_data"
  ]
}

object issuing.card

{
  "type": "object",
  "title": "IssuingCard",
  "required": [
    "brand",
    "cardholder",
    "created",
    "currency",
    "exp_month",
    "exp_year",
    "id",
    "last4",
    "livemode",
    "metadata",
    "object",
    "spending_controls",
    "status",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "cvc": {
      "type": "string",
      "maxLength": 5000,
      "description": "The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://docs.stripe.com/api/expanding_objects). Additionally, it's only available via the [\"Retrieve a card\" endpoint](https://docs.stripe.com/api/issuing/cards/retrieve), not via \"List all cards\" or any other endpoint."
    },
    "type": {
      "enum": [
        "physical",
        "virtual"
      ],
      "type": "string",
      "description": "The type of the card."
    },
    "brand": {
      "type": "string",
      "maxLength": 5000,
      "description": "The brand of the card."
    },
    "last4": {
      "type": "string",
      "maxLength": 5000,
      "description": "The last 4 digits of the card number."
    },
    "number": {
      "type": "string",
      "maxLength": 5000,
      "description": "The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://docs.stripe.com/api/expanding_objects). Additionally, it's only available via the [\"Retrieve a card\" endpoint](https://docs.stripe.com/api/issuing/cards/retrieve), not via \"List all cards\" or any other endpoint."
    },
    "object": {
      "enum": [
        "issuing.card"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "active",
        "canceled",
        "inactive"
      ],
      "type": "string",
      "description": "Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`.",
      "x-stripeBypassValidation": true
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "wallets": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_card_wallets"
        }
      ],
      "nullable": true,
      "description": "Information relating to digital wallets (like Apple Pay and Google Pay)."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Supported currencies are `usd` in the US, `eur` in the EU, and `gbp` in the UK."
    },
    "exp_year": {
      "type": "integer",
      "description": "The expiration year of the card."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "shipping": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_card_shipping"
        }
      ],
      "nullable": true,
      "description": "Where and how the card will be shipped."
    },
    "exp_month": {
      "type": "integer",
      "description": "The expiration month of the card."
    },
    "cardholder": {
      "$ref": "#/components/schemas/issuing.cardholder"
    },
    "replaced_by": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/issuing.card"
        }
      ],
      "nullable": true,
      "description": "The latest card that replaces this card, if any.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/issuing.card"
          }
        ]
      }
    },
    "second_line": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Text separate from cardholder name, printed on the card."
    },
    "replacement_for": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/issuing.card"
        }
      ],
      "nullable": true,
      "description": "The card this card replaces, if any.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/issuing.card"
          }
        ]
      }
    },
    "financial_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The financial account this card is attached to."
    },
    "spending_controls": {
      "$ref": "#/components/schemas/issuing_card_authorization_controls"
    },
    "lifecycle_controls": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_card_lifecycle_controls"
        }
      ],
      "nullable": true,
      "description": "Rules that control the lifecycle of this card, such as automatic cancellation. Refer to our [documentation](/issuing/controls/lifecycle-controls) for more details."
    },
    "replacement_reason": {
      "enum": [
        "damaged",
        "expired",
        "lost",
        "stolen"
      ],
      "type": "string",
      "nullable": true,
      "description": "The reason why the previous card needed to be replaced.",
      "x-stripeBypassValidation": true
    },
    "cancellation_reason": {
      "enum": [
        "design_rejected",
        "lost",
        "stolen"
      ],
      "type": "string",
      "nullable": true,
      "description": "The reason why the card was canceled.",
      "x-stripeBypassValidation": true
    },
    "latest_fraud_warning": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_card_fraud_warning"
        }
      ],
      "nullable": true,
      "description": "Stripe’s assessment of whether this card’s details have been compromised. If this property isn't null, cancel and reissue the card to prevent fraudulent activity risk."
    },
    "personalization_design": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/issuing.personalization_design"
        }
      ],
      "nullable": true,
      "description": "The personalization design object belonging to this card.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/issuing.personalization_design"
          }
        ]
      }
    }
  },
  "description": "You can [create physical or virtual cards](https://docs.stripe.com/issuing) that are issued to cardholders.",
  "x-resourceId": "issuing.card",
  "x-expandableFields": [
    "cardholder",
    "latest_fraud_warning",
    "lifecycle_controls",
    "personalization_design",
    "replaced_by",
    "replacement_for",
    "shipping",
    "spending_controls",
    "wallets"
  ]
}

object issuing.cardholder

{
  "type": "object",
  "title": "IssuingCardholder",
  "required": [
    "billing",
    "created",
    "id",
    "livemode",
    "metadata",
    "name",
    "object",
    "requirements",
    "status",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The cardholder's name. This will be printed on cards issued to them."
    },
    "type": {
      "enum": [
        "company",
        "individual"
      ],
      "type": "string",
      "description": "One of `individual` or `company`. See [Choose a cardholder type](https://docs.stripe.com/issuing/other/choose-cardholder) for more details.",
      "x-stripeBypassValidation": true
    },
    "email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The cardholder's email address."
    },
    "object": {
      "enum": [
        "issuing.cardholder"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "active",
        "blocked",
        "inactive"
      ],
      "type": "string",
      "description": "Specifies whether to permit authorizations on this cardholder's cards."
    },
    "billing": {
      "$ref": "#/components/schemas/issuing_cardholder_address"
    },
    "company": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_cardholder_company"
        }
      ],
      "nullable": true,
      "description": "Additional information about a `company` cardholder."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "individual": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_cardholder_individual"
        }
      ],
      "nullable": true,
      "description": "Additional information about an `individual` cardholder."
    },
    "phone_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://docs.stripe.com/issuing/3d-secure#when-is-3d-secure-applied) for more details."
    },
    "requirements": {
      "$ref": "#/components/schemas/issuing_cardholder_requirements"
    },
    "preferred_locales": {
      "type": "array",
      "items": {
        "enum": [
          "de",
          "en",
          "es",
          "fr",
          "it"
        ],
        "type": "string",
        "x-stripeBypassValidation": true
      },
      "nullable": true,
      "description": "The cardholder’s preferred locales (languages), ordered by preference. Locales can be `da`, `de`, `en`, `es`, `fr`, `it`, `pl`, or `sv`.\n This changes the language of the [3D Secure flow](https://docs.stripe.com/issuing/3d-secure) and one-time password messages sent to the cardholder."
    },
    "spending_controls": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_cardholder_authorization_controls"
        }
      ],
      "nullable": true,
      "description": "Rules that control spending across this cardholder's cards. Refer to our [documentation](https://docs.stripe.com/issuing/controls/spending-controls) for more details."
    }
  },
  "description": "An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://docs.stripe.com/issuing) cards.\n\nRelated guide: [How to create a cardholder](https://docs.stripe.com/issuing/cards/virtual/issue-cards#create-cardholder)",
  "x-resourceId": "issuing.cardholder",
  "x-expandableFields": [
    "billing",
    "company",
    "individual",
    "requirements",
    "spending_controls"
  ]
}

object issuing.dispute

{
  "type": "object",
  "title": "IssuingDispute",
  "required": [
    "amount",
    "created",
    "currency",
    "evidence",
    "id",
    "livemode",
    "metadata",
    "object",
    "status",
    "transaction"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "amount": {
      "type": "integer",
      "description": "Disputed amount in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation)."
    },
    "object": {
      "enum": [
        "issuing.dispute"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "expired",
        "lost",
        "submitted",
        "unsubmitted",
        "won"
      ],
      "type": "string",
      "description": "Current status of the dispute."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "The currency the `transaction` was made in."
    },
    "evidence": {
      "$ref": "#/components/schemas/issuing_dispute_evidence"
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "treasury": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_dispute_treasury"
        }
      ],
      "nullable": true,
      "description": "[Treasury](https://docs.stripe.com/api/treasury) details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts"
    },
    "loss_reason": {
      "enum": [
        "cardholder_authentication_issuer_liability",
        "eci5_token_transaction_with_tavv",
        "excess_disputes_in_timeframe",
        "has_not_met_the_minimum_dispute_amount_requirements",
        "invalid_duplicate_dispute",
        "invalid_incorrect_amount_dispute",
        "invalid_no_authorization",
        "invalid_use_of_disputes",
        "merchandise_delivered_or_shipped",
        "merchandise_or_service_as_described",
        "not_cancelled",
        "other",
        "refund_issued",
        "submitted_beyond_allowable_time_limit",
        "transaction_3ds_required",
        "transaction_approved_after_prior_fraud_dispute",
        "transaction_authorized",
        "transaction_electronically_read",
        "transaction_qualifies_for_visa_easy_payment_service",
        "transaction_unattended"
      ],
      "type": "string",
      "description": "The enum that describes the dispute loss outcome. If the dispute is not lost, this field will be absent. New enum values may be added in the future, so be sure to handle unknown values."
    },
    "transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/issuing.transaction"
        }
      ],
      "description": "The transaction being disputed.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/issuing.transaction"
          }
        ]
      }
    },
    "balance_transactions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/balance_transaction"
      },
      "nullable": true,
      "description": "List of balance transactions associated with the dispute."
    }
  },
  "description": "As a [card issuer](https://docs.stripe.com/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with.\n\nRelated guide: [Issuing disputes](https://docs.stripe.com/issuing/purchases/disputes)",
  "x-resourceId": "issuing.dispute",
  "x-expandableFields": [
    "balance_transactions",
    "evidence",
    "transaction",
    "treasury"
  ]
}

object issuing.personalization_design

{
  "type": "object",
  "title": "IssuingPersonalizationDesign",
  "required": [
    "created",
    "id",
    "livemode",
    "metadata",
    "object",
    "physical_bundle",
    "preferences",
    "rejection_reasons",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Friendly display name."
    },
    "object": {
      "enum": [
        "issuing.personalization_design"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "active",
        "inactive",
        "rejected",
        "review"
      ],
      "type": "string",
      "description": "Whether this personalization design can be used to create cards."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "card_logo": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "The file for the card logo to use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    },
    "lookup_key": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters."
    },
    "preferences": {
      "$ref": "#/components/schemas/issuing_personalization_design_preferences"
    },
    "carrier_text": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_personalization_design_carrier_text"
        }
      ],
      "nullable": true,
      "description": "Hash containing carrier text, for use with physical bundles that support carrier text."
    },
    "physical_bundle": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/issuing.physical_bundle"
        }
      ],
      "description": "The physical bundle object belonging to this personalization design.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/issuing.physical_bundle"
          }
        ]
      }
    },
    "rejection_reasons": {
      "$ref": "#/components/schemas/issuing_personalization_design_rejection_reasons"
    }
  },
  "description": "A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line.",
  "x-resourceId": "issuing.personalization_design",
  "x-expandableFields": [
    "card_logo",
    "carrier_text",
    "physical_bundle",
    "preferences",
    "rejection_reasons"
  ]
}

object issuing.physical_bundle

{
  "type": "object",
  "title": "IssuingPhysicalBundle",
  "required": [
    "features",
    "id",
    "livemode",
    "name",
    "object",
    "status",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "name": {
      "type": "string",
      "maxLength": 5000,
      "description": "Friendly display name."
    },
    "type": {
      "enum": [
        "custom",
        "standard"
      ],
      "type": "string",
      "description": "Whether this physical bundle is a standard Stripe offering or custom-made for you."
    },
    "object": {
      "enum": [
        "issuing.physical_bundle"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "active",
        "inactive",
        "review"
      ],
      "type": "string",
      "description": "Whether this physical bundle can be used to create cards."
    },
    "features": {
      "$ref": "#/components/schemas/issuing_physical_bundle_features"
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    }
  },
  "description": "A Physical Bundle represents the bundle of physical items - card stock, carrier letter, and envelope - that is shipped to a cardholder when you create a physical card.",
  "x-resourceId": "issuing.physical_bundle",
  "x-expandableFields": [
    "features"
  ]
}

object issuing.settlement

{
  "type": "object",
  "title": "IssuingSettlement",
  "required": [
    "bin",
    "clearing_date",
    "created",
    "currency",
    "id",
    "interchange_fees_amount",
    "livemode",
    "metadata",
    "net_total_amount",
    "network",
    "network_fees_amount",
    "network_settlement_identifier",
    "object",
    "settlement_service",
    "status",
    "transaction_amount",
    "transaction_count"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "bin": {
      "type": "string",
      "maxLength": 5000,
      "description": "The Bank Identification Number reflecting this settlement record."
    },
    "object": {
      "enum": [
        "issuing.settlement"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "complete",
        "pending"
      ],
      "type": "string",
      "description": "The current processing status of this settlement."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "network": {
      "enum": [
        "maestro",
        "visa"
      ],
      "type": "string",
      "description": "The card network for this settlement report. One of [\"visa\", \"maestro\"]"
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "clearing_date": {
      "type": "integer",
      "format": "unix-time",
      "description": "The date that the transactions are cleared and posted to user's accounts."
    },
    "net_total_amount": {
      "type": "integer",
      "description": "The total net amount required to settle with the network."
    },
    "transaction_count": {
      "type": "integer",
      "description": "The total number of transactions reflected in this settlement."
    },
    "settlement_service": {
      "type": "string",
      "maxLength": 5000,
      "description": "One of `international` or `uk_national_net`."
    },
    "transaction_amount": {
      "type": "integer",
      "description": "The total transaction amount reflected in this settlement."
    },
    "network_fees_amount": {
      "type": "integer",
      "description": "The total amount of fees owed to the network."
    },
    "interchange_fees_amount": {
      "type": "integer",
      "description": "The total interchange received as reimbursement for the transactions."
    },
    "network_settlement_identifier": {
      "type": "string",
      "maxLength": 5000,
      "description": "The Settlement Identification Number assigned by the network."
    }
  },
  "description": "When a non-stripe BIN is used, any use of an [issued card](https://docs.stripe.com/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object.",
  "x-resourceId": "issuing.settlement",
  "x-expandableFields": []
}

object issuing.token

{
  "type": "object",
  "title": "IssuingNetworkToken",
  "required": [
    "card",
    "created",
    "id",
    "livemode",
    "network",
    "network_updated_at",
    "object",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "card": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/issuing.card"
        }
      ],
      "description": "Card associated with this token.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/issuing.card"
          }
        ]
      }
    },
    "last4": {
      "type": "string",
      "maxLength": 5000,
      "description": "The last four digits of the token."
    },
    "object": {
      "enum": [
        "issuing.token"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "active",
        "deleted",
        "requested",
        "suspended"
      ],
      "type": "string",
      "description": "The usage state of the token."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "network": {
      "enum": [
        "mastercard",
        "visa"
      ],
      "type": "string",
      "description": "The token service provider / card network associated with the token."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "network_data": {
      "$ref": "#/components/schemas/issuing_network_token_network_data"
    },
    "wallet_provider": {
      "enum": [
        "apple_pay",
        "google_pay",
        "samsung_pay"
      ],
      "type": "string",
      "description": "The digital wallet for this token, if one was used."
    },
    "device_fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The hashed ID derived from the device ID from the card network associated with the token."
    },
    "network_updated_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the token was last updated by the card network. Measured in seconds since the Unix epoch."
    }
  },
  "description": "An issuing token object is created when an issued card is added to a digital wallet. As a [card issuer](https://docs.stripe.com/issuing), you can [view and manage these tokens](https://docs.stripe.com/issuing/controls/token-management) through Stripe.",
  "x-resourceId": "issuing.token",
  "x-expandableFields": [
    "card",
    "network_data"
  ]
}

object issuing.transaction

{
  "type": "object",
  "title": "IssuingTransaction",
  "required": [
    "amount",
    "card",
    "created",
    "currency",
    "id",
    "livemode",
    "merchant_amount",
    "merchant_currency",
    "merchant_data",
    "metadata",
    "object",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "card": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/issuing.card"
        }
      ],
      "description": "The card used to make this transaction.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/issuing.card"
          }
        ]
      }
    },
    "type": {
      "enum": [
        "capture",
        "refund"
      ],
      "type": "string",
      "description": "The nature of the transaction.",
      "x-stripeBypassValidation": true
    },
    "token": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/issuing.token"
        }
      ],
      "nullable": true,
      "description": "[Token](https://docs.stripe.com/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/issuing.token"
          }
        ]
      }
    },
    "amount": {
      "type": "integer",
      "description": "The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."
    },
    "object": {
      "enum": [
        "issuing.transaction"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "wallet": {
      "enum": [
        "apple_pay",
        "google_pay",
        "samsung_pay"
      ],
      "type": "string",
      "nullable": true,
      "description": "The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "dispute": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/issuing.dispute"
        }
      ],
      "nullable": true,
      "description": "If you've disputed the transaction, the ID of the dispute.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/issuing.dispute"
          }
        ]
      }
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "treasury": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_transaction_treasury"
        }
      ],
      "nullable": true,
      "description": "[Treasury](https://docs.stripe.com/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts"
    },
    "cardholder": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/issuing.cardholder"
        }
      ],
      "nullable": true,
      "description": "The cardholder to whom this transaction belongs.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/issuing.cardholder"
          }
        ]
      }
    },
    "network_data": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_transaction_network_data"
        }
      ],
      "nullable": true,
      "description": "Details about the transaction, such as processing dates, set by the card network."
    },
    "authorization": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/issuing.authorization"
        }
      ],
      "nullable": true,
      "description": "The `Authorization` object that led to this transaction.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/issuing.authorization"
          }
        ]
      }
    },
    "merchant_data": {
      "$ref": "#/components/schemas/issuing_authorization_merchant_data"
    },
    "amount_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_transaction_amount_details"
        }
      ],
      "nullable": true,
      "description": "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."
    },
    "merchant_amount": {
      "type": "integer",
      "description": "The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency."
    },
    "purchase_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_transaction_purchase_details"
        }
      ],
      "nullable": true,
      "description": "Additional purchase information that is optionally provided by the merchant."
    },
    "merchant_currency": {
      "type": "string",
      "format": "currency",
      "description": "The currency with which the merchant is taking payment."
    },
    "balance_transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/balance_transaction"
        }
      ],
      "nullable": true,
      "description": "ID of the [balance transaction](https://docs.stripe.com/api/balance_transactions) associated with this transaction.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/balance_transaction"
          }
        ]
      }
    }
  },
  "description": "Any use of an [issued card](https://docs.stripe.com/issuing) that results in funds entering or leaving\nyour Stripe account, such as a completed purchase or refund, is represented by an Issuing\n`Transaction` object.\n\nRelated guide: [Issued card transactions](https://docs.stripe.com/issuing/purchases/transactions)",
  "x-resourceId": "issuing.transaction",
  "x-expandableFields": [
    "amount_details",
    "authorization",
    "balance_transaction",
    "card",
    "cardholder",
    "dispute",
    "merchant_data",
    "network_data",
    "purchase_details",
    "token",
    "treasury"
  ]
}

object issuing_authorization_amount_details

{
  "type": "object",
  "title": "IssuingAuthorizationAmountDetails",
  "properties": {
    "atm_fee": {
      "type": "integer",
      "nullable": true,
      "description": "The fee charged by the ATM for the cash withdrawal."
    },
    "cashback_amount": {
      "type": "integer",
      "nullable": true,
      "description": "The amount of cash requested by the cardholder."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_authorization_authentication_exemption

{
  "type": "object",
  "title": "IssuingAuthorizationAuthenticationExemption",
  "required": [
    "claimed_by",
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "low_value_transaction",
        "transaction_risk_analysis",
        "unknown"
      ],
      "type": "string",
      "description": "The specific exemption claimed for this authorization.",
      "x-stripeBypassValidation": true
    },
    "claimed_by": {
      "enum": [
        "acquirer",
        "issuer"
      ],
      "type": "string",
      "description": "The entity that requested the exemption, either the acquiring merchant or the Issuing user."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_authorization_fleet_cardholder_prompt_data

{
  "type": "object",
  "title": "IssuingAuthorizationFleetCardholderPromptData",
  "properties": {
    "user_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "User ID."
    },
    "odometer": {
      "type": "integer",
      "nullable": true,
      "description": "Odometer reading."
    },
    "driver_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Driver ID."
    },
    "unspecified_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type."
    },
    "vehicle_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Vehicle number."
    },
    "alphanumeric_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "[Deprecated] An alphanumeric ID, though typical point of sales only support numeric entry. The card program can be configured to prompt for a vehicle ID, driver ID, or generic ID."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_authorization_fleet_data

{
  "type": "object",
  "title": "IssuingAuthorizationFleetData",
  "properties": {
    "service_type": {
      "enum": [
        "full_service",
        "non_fuel_transaction",
        "self_service"
      ],
      "type": "string",
      "nullable": true,
      "description": "The type of fuel service."
    },
    "purchase_type": {
      "enum": [
        "fuel_and_non_fuel_purchase",
        "fuel_purchase",
        "non_fuel_purchase"
      ],
      "type": "string",
      "nullable": true,
      "description": "The type of purchase."
    },
    "reported_breakdown": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_authorization_fleet_reported_breakdown"
        }
      ],
      "nullable": true,
      "description": "More information about the total amount. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. This information is not guaranteed to be accurate as some merchants may provide unreliable data."
    },
    "cardholder_prompt_data": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_authorization_fleet_cardholder_prompt_data"
        }
      ],
      "nullable": true,
      "description": "Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry."
    }
  },
  "description": "",
  "x-expandableFields": [
    "cardholder_prompt_data",
    "reported_breakdown"
  ]
}

object issuing_authorization_fleet_fuel_price_data

{
  "type": "object",
  "title": "IssuingAuthorizationFleetFuelPriceData",
  "properties": {
    "gross_amount_decimal": {
      "type": "string",
      "format": "decimal",
      "nullable": true,
      "description": "Gross fuel amount that should equal Fuel Quantity multiplied by Fuel Unit Cost, inclusive of taxes."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_authorization_fleet_non_fuel_price_data

{
  "type": "object",
  "title": "IssuingAuthorizationFleetNonFuelPriceData",
  "properties": {
    "gross_amount_decimal": {
      "type": "string",
      "format": "decimal",
      "nullable": true,
      "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_authorization_fleet_reported_breakdown

{
  "type": "object",
  "title": "IssuingAuthorizationFleetReportedBreakdown",
  "properties": {
    "tax": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_authorization_fleet_tax_data"
        }
      ],
      "nullable": true,
      "description": "Information about tax included in this transaction."
    },
    "fuel": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_authorization_fleet_fuel_price_data"
        }
      ],
      "nullable": true,
      "description": "Breakdown of fuel portion of the purchase."
    },
    "non_fuel": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_authorization_fleet_non_fuel_price_data"
        }
      ],
      "nullable": true,
      "description": "Breakdown of non-fuel portion of the purchase."
    }
  },
  "description": "",
  "x-expandableFields": [
    "fuel",
    "non_fuel",
    "tax"
  ]
}

object issuing_authorization_fleet_tax_data

{
  "type": "object",
  "title": "IssuingAuthorizationFleetTaxData",
  "properties": {
    "local_amount_decimal": {
      "type": "string",
      "format": "decimal",
      "nullable": true,
      "description": "Amount of state or provincial Sales Tax included in the transaction amount. `null` if not reported by merchant or not subject to tax."
    },
    "national_amount_decimal": {
      "type": "string",
      "format": "decimal",
      "nullable": true,
      "description": "Amount of national Sales Tax or VAT included in the transaction amount. `null` if not reported by merchant or not subject to tax."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_authorization_fraud_challenge

{
  "type": "object",
  "title": "IssuingAuthorizationFraudChallenge",
  "required": [
    "channel",
    "status"
  ],
  "properties": {
    "status": {
      "enum": [
        "expired",
        "pending",
        "rejected",
        "undeliverable",
        "verified"
      ],
      "type": "string",
      "description": "The status of the fraud challenge."
    },
    "channel": {
      "enum": [
        "sms"
      ],
      "type": "string",
      "description": "The method by which the fraud challenge was delivered to the cardholder."
    },
    "undeliverable_reason": {
      "enum": [
        "no_phone_number",
        "unsupported_phone_number"
      ],
      "type": "string",
      "nullable": true,
      "description": "If the challenge is not deliverable, the reason why."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_authorization_fuel_data

{
  "type": "object",
  "title": "IssuingAuthorizationFuelData",
  "properties": {
    "type": {
      "enum": [
        "diesel",
        "other",
        "unleaded_plus",
        "unleaded_regular",
        "unleaded_super"
      ],
      "type": "string",
      "nullable": true,
      "description": "The type of fuel that was purchased."
    },
    "unit": {
      "enum": [
        "charging_minute",
        "imperial_gallon",
        "kilogram",
        "kilowatt_hour",
        "liter",
        "other",
        "pound",
        "us_gallon"
      ],
      "type": "string",
      "nullable": true,
      "description": "The units for `quantity_decimal`."
    },
    "quantity_decimal": {
      "type": "string",
      "format": "decimal",
      "nullable": true,
      "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places."
    },
    "unit_cost_decimal": {
      "type": "string",
      "format": "decimal",
      "nullable": true,
      "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places."
    },
    "industry_product_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_authorization_merchant_data

{
  "type": "object",
  "title": "IssuingAuthorizationMerchantData",
  "required": [
    "category",
    "category_code",
    "network_id"
  ],
  "properties": {
    "url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "URL provided by the merchant on a 3DS request"
    },
    "city": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "City where the seller is located"
    },
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Name of the seller"
    },
    "state": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "State where the seller is located"
    },
    "tax_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The seller's tax identification number. Currently populated for French merchants only."
    },
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Country where the seller is located"
    },
    "category": {
      "type": "string",
      "maxLength": 5000,
      "description": "A categorization of the seller's type of business. See our [merchant categories guide](https://docs.stripe.com/issuing/merchant-categories) for a list of possible values."
    },
    "network_id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant."
    },
    "postal_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Postal code where the seller is located"
    },
    "terminal_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An ID assigned by the seller to the location of the sale."
    },
    "category_code": {
      "type": "string",
      "maxLength": 5000,
      "description": "The merchant category code for the seller’s business"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_authorization_network_data

{
  "type": "object",
  "title": "IssuingAuthorizationNetworkData",
  "properties": {
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions."
    },
    "acquiring_institution_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Identifier assigned to the acquirer by the card network. Sometimes this value is not provided by the network; in this case, the value will be `null`."
    },
    "system_trace_audit_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The System Trace Audit Number (STAN) is a 6-digit identifier assigned by the acquirer. Prefer `network_data.transaction_id` if present, unless you have special requirements."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_authorization_pending_request

{
  "type": "object",
  "title": "IssuingAuthorizationPendingRequest",
  "required": [
    "amount",
    "currency",
    "is_amount_controllable",
    "merchant_amount",
    "merchant_currency"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "The additional amount Stripe will hold if the authorization is approved, in the card's [currency](https://docs.stripe.com/api#issuing_authorization_object-pending-request-currency) and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "amount_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_authorization_amount_details"
        }
      ],
      "nullable": true,
      "description": "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."
    },
    "merchant_amount": {
      "type": "integer",
      "description": "The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."
    },
    "merchant_currency": {
      "type": "string",
      "format": "currency",
      "description": "The local currency the merchant is requesting to authorize."
    },
    "network_risk_score": {
      "type": "integer",
      "nullable": true,
      "description": "The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99."
    },
    "is_amount_controllable": {
      "type": "boolean",
      "description": "If set `true`, you may provide [amount](https://docs.stripe.com/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization."
    }
  },
  "description": "",
  "x-expandableFields": [
    "amount_details"
  ]
}

object issuing_authorization_request

{
  "type": "object",
  "title": "IssuingAuthorizationRequest",
  "required": [
    "amount",
    "approved",
    "created",
    "currency",
    "merchant_amount",
    "merchant_currency",
    "reason"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "The `pending_request.amount` at the time of the request, presented in your card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Stripe held this amount from your account to fund the authorization if the request was approved."
    },
    "reason": {
      "enum": [
        "account_disabled",
        "card_active",
        "card_canceled",
        "card_expired",
        "card_inactive",
        "cardholder_blocked",
        "cardholder_inactive",
        "cardholder_verification_required",
        "insecure_authorization_method",
        "insufficient_funds",
        "network_fallback",
        "not_allowed",
        "pin_blocked",
        "spending_controls",
        "suspected_fraud",
        "verification_failed",
        "webhook_approved",
        "webhook_declined",
        "webhook_error",
        "webhook_timeout"
      ],
      "type": "string",
      "description": "When an authorization is approved or declined by you or by Stripe, this field provides additional detail on the reason for the outcome.",
      "x-stripeBypassValidation": true
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "approved": {
      "type": "boolean",
      "description": "Whether this request was approved."
    },
    "currency": {
      "type": "string",
      "maxLength": 5000,
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "requested_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Time when the card network received an authorization request from the acquirer in UTC. Referred to by networks as transmission time."
    },
    "amount_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_authorization_amount_details"
        }
      ],
      "nullable": true,
      "description": "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."
    },
    "reason_message": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "If the `request_history.reason` is `webhook_error` because the direct webhook response is invalid (for example, parsing errors or missing parameters), we surface a more detailed error message via this field."
    },
    "merchant_amount": {
      "type": "integer",
      "description": "The `pending_request.merchant_amount` at the time of the request, presented in the `merchant_currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."
    },
    "merchant_currency": {
      "type": "string",
      "maxLength": 5000,
      "description": "The currency that was collected by the merchant and presented to the cardholder for the authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "authorization_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter \"S\", followed by a six-digit number. For example, \"S498162\". Please note that the code is not guaranteed to be unique across authorizations."
    },
    "network_risk_score": {
      "type": "integer",
      "nullable": true,
      "description": "The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99."
    }
  },
  "description": "",
  "x-expandableFields": [
    "amount_details"
  ]
}

object issuing_authorization_three_d_secure

{
  "type": "object",
  "title": "IssuingAuthorizationThreeDSecure",
  "required": [
    "result"
  ],
  "properties": {
    "result": {
      "enum": [
        "attempt_acknowledged",
        "authenticated",
        "failed",
        "required"
      ],
      "type": "string",
      "description": "The outcome of the 3D Secure authentication request.",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_authorization_treasury

{
  "type": "object",
  "title": "IssuingAuthorizationTreasury",
  "required": [
    "received_credits",
    "received_debits"
  ],
  "properties": {
    "transaction": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Treasury [Transaction](https://docs.stripe.com/api/treasury/transactions) associated with this authorization"
    },
    "received_debits": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "The array of [ReceivedDebits](https://docs.stripe.com/api/treasury/received_debits) associated with this authorization"
    },
    "received_credits": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "The array of [ReceivedCredits](https://docs.stripe.com/api/treasury/received_credits) associated with this authorization"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_authorization_verification_data

{
  "type": "object",
  "title": "IssuingAuthorizationVerificationData",
  "required": [
    "address_line1_check",
    "address_postal_code_check",
    "cvc_check",
    "expiry_check"
  ],
  "properties": {
    "cvc_check": {
      "enum": [
        "match",
        "mismatch",
        "not_provided"
      ],
      "type": "string",
      "description": "Whether the cardholder provided a CVC and if it matched Stripe’s record."
    },
    "postal_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The postal code submitted as part of the authorization used for postal code verification."
    },
    "expiry_check": {
      "enum": [
        "match",
        "mismatch",
        "not_provided"
      ],
      "type": "string",
      "description": "Whether the cardholder provided an expiry date and if it matched Stripe’s record."
    },
    "three_d_secure": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_authorization_three_d_secure"
        }
      ],
      "nullable": true,
      "description": "3D Secure details."
    },
    "address_line1_check": {
      "enum": [
        "match",
        "mismatch",
        "not_provided"
      ],
      "type": "string",
      "description": "Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`."
    },
    "authentication_exemption": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_authorization_authentication_exemption"
        }
      ],
      "nullable": true,
      "description": "The exemption applied to this authorization."
    },
    "address_postal_code_check": {
      "enum": [
        "match",
        "mismatch",
        "not_provided"
      ],
      "type": "string",
      "description": "Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`."
    }
  },
  "description": "",
  "x-expandableFields": [
    "authentication_exemption",
    "three_d_secure"
  ]
}

object issuing_card_apple_pay

{
  "type": "object",
  "title": "IssuingCardApplePay",
  "required": [
    "eligible"
  ],
  "properties": {
    "eligible": {
      "type": "boolean",
      "description": "Apple Pay Eligibility"
    },
    "ineligible_reason": {
      "enum": [
        "missing_agreement",
        "missing_cardholder_contact",
        "unsupported_region"
      ],
      "type": "string",
      "nullable": true,
      "description": "Reason the card is ineligible for Apple Pay"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_card_authorization_controls

{
  "type": "object",
  "title": "IssuingCardAuthorizationControls",
  "properties": {
    "spending_limits": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/issuing_card_spending_limit"
      },
      "nullable": true,
      "description": "Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain)."
    },
    "allowed_categories": {
      "type": "array",
      "items": {
        "enum": [
          "ac_refrigeration_repair",
          "accounting_bookkeeping_services",
          "advertising_services",
          "agricultural_cooperative",
          "airlines_air_carriers",
          "airports_flying_fields",
          "ambulance_services",
          "amusement_parks_carnivals",
          "antique_reproductions",
          "antique_shops",
          "aquariums",
          "architectural_surveying_services",
          "art_dealers_and_galleries",
          "artists_supply_and_craft_shops",
          "auto_and_home_supply_stores",
          "auto_body_repair_shops",
          "auto_paint_shops",
          "auto_service_shops",
          "automated_cash_disburse",
          "automated_fuel_dispensers",
          "automobile_associations",
          "automotive_parts_and_accessories_stores",
          "automotive_tire_stores",
          "bail_and_bond_payments",
          "bakeries",
          "bands_orchestras",
          "barber_and_beauty_shops",
          "betting_casino_gambling",
          "bicycle_shops",
          "billiard_pool_establishments",
          "boat_dealers",
          "boat_rentals_and_leases",
          "book_stores",
          "books_periodicals_and_newspapers",
          "bowling_alleys",
          "bus_lines",
          "business_secretarial_schools",
          "buying_shopping_services",
          "cable_satellite_and_other_pay_television_and_radio",
          "camera_and_photographic_supply_stores",
          "candy_nut_and_confectionery_stores",
          "car_and_truck_dealers_new_used",
          "car_and_truck_dealers_used_only",
          "car_rental_agencies",
          "car_washes",
          "carpentry_services",
          "carpet_upholstery_cleaning",
          "caterers",
          "charitable_and_social_service_organizations_fundraising",
          "chemicals_and_allied_products",
          "child_care_services",
          "childrens_and_infants_wear_stores",
          "chiropodists_podiatrists",
          "chiropractors",
          "cigar_stores_and_stands",
          "civic_social_fraternal_associations",
          "cleaning_and_maintenance",
          "clothing_rental",
          "colleges_universities",
          "commercial_equipment",
          "commercial_footwear",
          "commercial_photography_art_and_graphics",
          "commuter_transport_and_ferries",
          "computer_network_services",
          "computer_programming",
          "computer_repair",
          "computer_software_stores",
          "computers_peripherals_and_software",
          "concrete_work_services",
          "construction_materials",
          "consulting_public_relations",
          "correspondence_schools",
          "cosmetic_stores",
          "counseling_services",
          "country_clubs",
          "courier_services",
          "court_costs",
          "credit_reporting_agencies",
          "cruise_lines",
          "dairy_products_stores",
          "dance_hall_studios_schools",
          "dating_escort_services",
          "dentists_orthodontists",
          "department_stores",
          "detective_agencies",
          "digital_goods_applications",
          "digital_goods_games",
          "digital_goods_large_volume",
          "digital_goods_media",
          "direct_marketing_catalog_merchant",
          "direct_marketing_combination_catalog_and_retail_merchant",
          "direct_marketing_inbound_telemarketing",
          "direct_marketing_insurance_services",
          "direct_marketing_other",
          "direct_marketing_outbound_telemarketing",
          "direct_marketing_subscription",
          "direct_marketing_travel",
          "discount_stores",
          "doctors",
          "door_to_door_sales",
          "drapery_window_covering_and_upholstery_stores",
          "drinking_places",
          "drug_stores_and_pharmacies",
          "drugs_drug_proprietaries_and_druggist_sundries",
          "dry_cleaners",
          "durable_goods",
          "duty_free_stores",
          "eating_places_restaurants",
          "educational_services",
          "electric_razor_stores",
          "electric_vehicle_charging",
          "electrical_parts_and_equipment",
          "electrical_services",
          "electronics_repair_shops",
          "electronics_stores",
          "elementary_secondary_schools",
          "emergency_services_gcas_visa_use_only",
          "employment_temp_agencies",
          "equipment_rental",
          "exterminating_services",
          "family_clothing_stores",
          "fast_food_restaurants",
          "financial_institutions",
          "fines_government_administrative_entities",
          "fireplace_fireplace_screens_and_accessories_stores",
          "floor_covering_stores",
          "florists",
          "florists_supplies_nursery_stock_and_flowers",
          "freezer_and_locker_meat_provisioners",
          "fuel_dealers_non_automotive",
          "funeral_services_crematories",
          "furniture_home_furnishings_and_equipment_stores_except_appliances",
          "furniture_repair_refinishing",
          "furriers_and_fur_shops",
          "general_services",
          "gift_card_novelty_and_souvenir_shops",
          "glass_paint_and_wallpaper_stores",
          "glassware_crystal_stores",
          "golf_courses_public",
          "government_licensed_horse_dog_racing_us_region_only",
          "government_licensed_online_casions_online_gambling_us_region_only",
          "government_owned_lotteries_non_us_region",
          "government_owned_lotteries_us_region_only",
          "government_services",
          "grocery_stores_supermarkets",
          "hardware_equipment_and_supplies",
          "hardware_stores",
          "health_and_beauty_spas",
          "hearing_aids_sales_and_supplies",
          "heating_plumbing_a_c",
          "hobby_toy_and_game_shops",
          "home_supply_warehouse_stores",
          "hospitals",
          "hotels_motels_and_resorts",
          "household_appliance_stores",
          "industrial_supplies",
          "information_retrieval_services",
          "insurance_default",
          "insurance_underwriting_premiums",
          "intra_company_purchases",
          "jewelry_stores_watches_clocks_and_silverware_stores",
          "landscaping_services",
          "laundries",
          "laundry_cleaning_services",
          "legal_services_attorneys",
          "luggage_and_leather_goods_stores",
          "lumber_building_materials_stores",
          "manual_cash_disburse",
          "marinas_service_and_supplies",
          "marketplaces",
          "masonry_stonework_and_plaster",
          "massage_parlors",
          "medical_and_dental_labs",
          "medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
          "medical_services",
          "membership_organizations",
          "mens_and_boys_clothing_and_accessories_stores",
          "mens_womens_clothing_stores",
          "metal_service_centers",
          "miscellaneous",
          "miscellaneous_apparel_and_accessory_shops",
          "miscellaneous_auto_dealers",
          "miscellaneous_business_services",
          "miscellaneous_food_stores",
          "miscellaneous_general_merchandise",
          "miscellaneous_general_services",
          "miscellaneous_home_furnishing_specialty_stores",
          "miscellaneous_publishing_and_printing",
          "miscellaneous_recreation_services",
          "miscellaneous_repair_shops",
          "miscellaneous_specialty_retail",
          "mobile_home_dealers",
          "motion_picture_theaters",
          "motor_freight_carriers_and_trucking",
          "motor_homes_dealers",
          "motor_vehicle_supplies_and_new_parts",
          "motorcycle_shops_and_dealers",
          "motorcycle_shops_dealers",
          "music_stores_musical_instruments_pianos_and_sheet_music",
          "news_dealers_and_newsstands",
          "non_fi_money_orders",
          "non_fi_stored_value_card_purchase_load",
          "nondurable_goods",
          "nurseries_lawn_and_garden_supply_stores",
          "nursing_personal_care",
          "office_and_commercial_furniture",
          "opticians_eyeglasses",
          "optometrists_ophthalmologist",
          "orthopedic_goods_prosthetic_devices",
          "osteopaths",
          "package_stores_beer_wine_and_liquor",
          "paints_varnishes_and_supplies",
          "parking_lots_garages",
          "passenger_railways",
          "pawn_shops",
          "pet_shops_pet_food_and_supplies",
          "petroleum_and_petroleum_products",
          "photo_developing",
          "photographic_photocopy_microfilm_equipment_and_supplies",
          "photographic_studios",
          "picture_video_production",
          "piece_goods_notions_and_other_dry_goods",
          "plumbing_heating_equipment_and_supplies",
          "political_organizations",
          "postal_services_government_only",
          "precious_stones_and_metals_watches_and_jewelry",
          "professional_services",
          "public_warehousing_and_storage",
          "quick_copy_repro_and_blueprint",
          "railroads",
          "real_estate_agents_and_managers_rentals",
          "record_stores",
          "recreational_vehicle_rentals",
          "religious_goods_stores",
          "religious_organizations",
          "roofing_siding_sheet_metal",
          "secretarial_support_services",
          "security_brokers_dealers",
          "service_stations",
          "sewing_needlework_fabric_and_piece_goods_stores",
          "shoe_repair_hat_cleaning",
          "shoe_stores",
          "small_appliance_repair",
          "snowmobile_dealers",
          "special_trade_services",
          "specialty_cleaning",
          "sporting_goods_stores",
          "sporting_recreation_camps",
          "sports_and_riding_apparel_stores",
          "sports_clubs_fields",
          "stamp_and_coin_stores",
          "stationary_office_supplies_printing_and_writing_paper",
          "stationery_stores_office_and_school_supply_stores",
          "swimming_pools_sales",
          "t_ui_travel_germany",
          "tailors_alterations",
          "tax_payments_government_agencies",
          "tax_preparation_services",
          "taxicabs_limousines",
          "telecommunication_equipment_and_telephone_sales",
          "telecommunication_services",
          "telegraph_services",
          "tent_and_awning_shops",
          "testing_laboratories",
          "theatrical_ticket_agencies",
          "timeshares",
          "tire_retreading_and_repair",
          "tolls_bridge_fees",
          "tourist_attractions_and_exhibits",
          "towing_services",
          "trailer_parks_campgrounds",
          "transportation_services",
          "travel_agencies_tour_operators",
          "truck_stop_iteration",
          "truck_utility_trailer_rentals",
          "typesetting_plate_making_and_related_services",
          "typewriter_stores",
          "u_s_federal_government_agencies_or_departments",
          "uniforms_commercial_clothing",
          "used_merchandise_and_secondhand_stores",
          "utilities",
          "variety_stores",
          "veterinary_services",
          "video_amusement_game_supplies",
          "video_game_arcades",
          "video_tape_rental_stores",
          "vocational_trade_schools",
          "watch_jewelry_repair",
          "welding_repair",
          "wholesale_clubs",
          "wig_and_toupee_stores",
          "wires_money_orders",
          "womens_accessory_and_specialty_shops",
          "womens_ready_to_wear_stores",
          "wrecking_and_salvage_yards"
        ],
        "type": "string"
      },
      "nullable": true,
      "description": "Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`."
    },
    "blocked_categories": {
      "type": "array",
      "items": {
        "enum": [
          "ac_refrigeration_repair",
          "accounting_bookkeeping_services",
          "advertising_services",
          "agricultural_cooperative",
          "airlines_air_carriers",
          "airports_flying_fields",
          "ambulance_services",
          "amusement_parks_carnivals",
          "antique_reproductions",
          "antique_shops",
          "aquariums",
          "architectural_surveying_services",
          "art_dealers_and_galleries",
          "artists_supply_and_craft_shops",
          "auto_and_home_supply_stores",
          "auto_body_repair_shops",
          "auto_paint_shops",
          "auto_service_shops",
          "automated_cash_disburse",
          "automated_fuel_dispensers",
          "automobile_associations",
          "automotive_parts_and_accessories_stores",
          "automotive_tire_stores",
          "bail_and_bond_payments",
          "bakeries",
          "bands_orchestras",
          "barber_and_beauty_shops",
          "betting_casino_gambling",
          "bicycle_shops",
          "billiard_pool_establishments",
          "boat_dealers",
          "boat_rentals_and_leases",
          "book_stores",
          "books_periodicals_and_newspapers",
          "bowling_alleys",
          "bus_lines",
          "business_secretarial_schools",
          "buying_shopping_services",
          "cable_satellite_and_other_pay_television_and_radio",
          "camera_and_photographic_supply_stores",
          "candy_nut_and_confectionery_stores",
          "car_and_truck_dealers_new_used",
          "car_and_truck_dealers_used_only",
          "car_rental_agencies",
          "car_washes",
          "carpentry_services",
          "carpet_upholstery_cleaning",
          "caterers",
          "charitable_and_social_service_organizations_fundraising",
          "chemicals_and_allied_products",
          "child_care_services",
          "childrens_and_infants_wear_stores",
          "chiropodists_podiatrists",
          "chiropractors",
          "cigar_stores_and_stands",
          "civic_social_fraternal_associations",
          "cleaning_and_maintenance",
          "clothing_rental",
          "colleges_universities",
          "commercial_equipment",
          "commercial_footwear",
          "commercial_photography_art_and_graphics",
          "commuter_transport_and_ferries",
          "computer_network_services",
          "computer_programming",
          "computer_repair",
          "computer_software_stores",
          "computers_peripherals_and_software",
          "concrete_work_services",
          "construction_materials",
          "consulting_public_relations",
          "correspondence_schools",
          "cosmetic_stores",
          "counseling_services",
          "country_clubs",
          "courier_services",
          "court_costs",
          "credit_reporting_agencies",
          "cruise_lines",
          "dairy_products_stores",
          "dance_hall_studios_schools",
          "dating_escort_services",
          "dentists_orthodontists",
          "department_stores",
          "detective_agencies",
          "digital_goods_applications",
          "digital_goods_games",
          "digital_goods_large_volume",
          "digital_goods_media",
          "direct_marketing_catalog_merchant",
          "direct_marketing_combination_catalog_and_retail_merchant",
          "direct_marketing_inbound_telemarketing",
          "direct_marketing_insurance_services",
          "direct_marketing_other",
          "direct_marketing_outbound_telemarketing",
          "direct_marketing_subscription",
          "direct_marketing_travel",
          "discount_stores",
          "doctors",
          "door_to_door_sales",
          "drapery_window_covering_and_upholstery_stores",
          "drinking_places",
          "drug_stores_and_pharmacies",
          "drugs_drug_proprietaries_and_druggist_sundries",
          "dry_cleaners",
          "durable_goods",
          "duty_free_stores",
          "eating_places_restaurants",
          "educational_services",
          "electric_razor_stores",
          "electric_vehicle_charging",
          "electrical_parts_and_equipment",
          "electrical_services",
          "electronics_repair_shops",
          "electronics_stores",
          "elementary_secondary_schools",
          "emergency_services_gcas_visa_use_only",
          "employment_temp_agencies",
          "equipment_rental",
          "exterminating_services",
          "family_clothing_stores",
          "fast_food_restaurants",
          "financial_institutions",
          "fines_government_administrative_entities",
          "fireplace_fireplace_screens_and_accessories_stores",
          "floor_covering_stores",
          "florists",
          "florists_supplies_nursery_stock_and_flowers",
          "freezer_and_locker_meat_provisioners",
          "fuel_dealers_non_automotive",
          "funeral_services_crematories",
          "furniture_home_furnishings_and_equipment_stores_except_appliances",
          "furniture_repair_refinishing",
          "furriers_and_fur_shops",
          "general_services",
          "gift_card_novelty_and_souvenir_shops",
          "glass_paint_and_wallpaper_stores",
          "glassware_crystal_stores",
          "golf_courses_public",
          "government_licensed_horse_dog_racing_us_region_only",
          "government_licensed_online_casions_online_gambling_us_region_only",
          "government_owned_lotteries_non_us_region",
          "government_owned_lotteries_us_region_only",
          "government_services",
          "grocery_stores_supermarkets",
          "hardware_equipment_and_supplies",
          "hardware_stores",
          "health_and_beauty_spas",
          "hearing_aids_sales_and_supplies",
          "heating_plumbing_a_c",
          "hobby_toy_and_game_shops",
          "home_supply_warehouse_stores",
          "hospitals",
          "hotels_motels_and_resorts",
          "household_appliance_stores",
          "industrial_supplies",
          "information_retrieval_services",
          "insurance_default",
          "insurance_underwriting_premiums",
          "intra_company_purchases",
          "jewelry_stores_watches_clocks_and_silverware_stores",
          "landscaping_services",
          "laundries",
          "laundry_cleaning_services",
          "legal_services_attorneys",
          "luggage_and_leather_goods_stores",
          "lumber_building_materials_stores",
          "manual_cash_disburse",
          "marinas_service_and_supplies",
          "marketplaces",
          "masonry_stonework_and_plaster",
          "massage_parlors",
          "medical_and_dental_labs",
          "medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
          "medical_services",
          "membership_organizations",
          "mens_and_boys_clothing_and_accessories_stores",
          "mens_womens_clothing_stores",
          "metal_service_centers",
          "miscellaneous",
          "miscellaneous_apparel_and_accessory_shops",
          "miscellaneous_auto_dealers",
          "miscellaneous_business_services",
          "miscellaneous_food_stores",
          "miscellaneous_general_merchandise",
          "miscellaneous_general_services",
          "miscellaneous_home_furnishing_specialty_stores",
          "miscellaneous_publishing_and_printing",
          "miscellaneous_recreation_services",
          "miscellaneous_repair_shops",
          "miscellaneous_specialty_retail",
          "mobile_home_dealers",
          "motion_picture_theaters",
          "motor_freight_carriers_and_trucking",
          "motor_homes_dealers",
          "motor_vehicle_supplies_and_new_parts",
          "motorcycle_shops_and_dealers",
          "motorcycle_shops_dealers",
          "music_stores_musical_instruments_pianos_and_sheet_music",
          "news_dealers_and_newsstands",
          "non_fi_money_orders",
          "non_fi_stored_value_card_purchase_load",
          "nondurable_goods",
          "nurseries_lawn_and_garden_supply_stores",
          "nursing_personal_care",
          "office_and_commercial_furniture",
          "opticians_eyeglasses",
          "optometrists_ophthalmologist",
          "orthopedic_goods_prosthetic_devices",
          "osteopaths",
          "package_stores_beer_wine_and_liquor",
          "paints_varnishes_and_supplies",
          "parking_lots_garages",
          "passenger_railways",
          "pawn_shops",
          "pet_shops_pet_food_and_supplies",
          "petroleum_and_petroleum_products",
          "photo_developing",
          "photographic_photocopy_microfilm_equipment_and_supplies",
          "photographic_studios",
          "picture_video_production",
          "piece_goods_notions_and_other_dry_goods",
          "plumbing_heating_equipment_and_supplies",
          "political_organizations",
          "postal_services_government_only",
          "precious_stones_and_metals_watches_and_jewelry",
          "professional_services",
          "public_warehousing_and_storage",
          "quick_copy_repro_and_blueprint",
          "railroads",
          "real_estate_agents_and_managers_rentals",
          "record_stores",
          "recreational_vehicle_rentals",
          "religious_goods_stores",
          "religious_organizations",
          "roofing_siding_sheet_metal",
          "secretarial_support_services",
          "security_brokers_dealers",
          "service_stations",
          "sewing_needlework_fabric_and_piece_goods_stores",
          "shoe_repair_hat_cleaning",
          "shoe_stores",
          "small_appliance_repair",
          "snowmobile_dealers",
          "special_trade_services",
          "specialty_cleaning",
          "sporting_goods_stores",
          "sporting_recreation_camps",
          "sports_and_riding_apparel_stores",
          "sports_clubs_fields",
          "stamp_and_coin_stores",
          "stationary_office_supplies_printing_and_writing_paper",
          "stationery_stores_office_and_school_supply_stores",
          "swimming_pools_sales",
          "t_ui_travel_germany",
          "tailors_alterations",
          "tax_payments_government_agencies",
          "tax_preparation_services",
          "taxicabs_limousines",
          "telecommunication_equipment_and_telephone_sales",
          "telecommunication_services",
          "telegraph_services",
          "tent_and_awning_shops",
          "testing_laboratories",
          "theatrical_ticket_agencies",
          "timeshares",
          "tire_retreading_and_repair",
          "tolls_bridge_fees",
          "tourist_attractions_and_exhibits",
          "towing_services",
          "trailer_parks_campgrounds",
          "transportation_services",
          "travel_agencies_tour_operators",
          "truck_stop_iteration",
          "truck_utility_trailer_rentals",
          "typesetting_plate_making_and_related_services",
          "typewriter_stores",
          "u_s_federal_government_agencies_or_departments",
          "uniforms_commercial_clothing",
          "used_merchandise_and_secondhand_stores",
          "utilities",
          "variety_stores",
          "veterinary_services",
          "video_amusement_game_supplies",
          "video_game_arcades",
          "video_tape_rental_stores",
          "vocational_trade_schools",
          "watch_jewelry_repair",
          "welding_repair",
          "wholesale_clubs",
          "wig_and_toupee_stores",
          "wires_money_orders",
          "womens_accessory_and_specialty_shops",
          "womens_ready_to_wear_stores",
          "wrecking_and_salvage_yards"
        ],
        "type": "string"
      },
      "nullable": true,
      "description": "Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`."
    },
    "spending_limits_currency": {
      "type": "string",
      "format": "currency",
      "nullable": true,
      "description": "Currency of the amounts within `spending_limits`. Always the same as the currency of the card."
    },
    "allowed_merchant_countries": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control."
    },
    "blocked_merchant_countries": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control."
    }
  },
  "description": "",
  "x-expandableFields": [
    "spending_limits"
  ]
}

object issuing_card_fraud_warning

{
  "type": "object",
  "title": "IssuingCardFraudWarning",
  "properties": {
    "type": {
      "enum": [
        "card_testing_exposure",
        "fraud_dispute_filed",
        "third_party_reported",
        "user_indicated_fraud"
      ],
      "type": "string",
      "nullable": true,
      "description": "The type of fraud warning that most recently took place on this card. This field updates with every new fraud warning, so the value changes over time. If populated, cancel and reissue the card."
    },
    "started_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Timestamp of the most recent fraud warning."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_card_google_pay

{
  "type": "object",
  "title": "IssuingCardGooglePay",
  "required": [
    "eligible"
  ],
  "properties": {
    "eligible": {
      "type": "boolean",
      "description": "Google Pay Eligibility"
    },
    "ineligible_reason": {
      "enum": [
        "missing_agreement",
        "missing_cardholder_contact",
        "unsupported_region"
      ],
      "type": "string",
      "nullable": true,
      "description": "Reason the card is ineligible for Google Pay"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_card_lifecycle_conditions

{
  "type": "object",
  "title": "IssuingCardLifecycleConditions",
  "required": [
    "payment_count"
  ],
  "properties": {
    "payment_count": {
      "type": "integer",
      "description": "The card is automatically cancelled when it makes this number of non-zero payment authorizations and transactions. The count includes penny authorizations, but doesn't include non-payment actions, such as authorization advice."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_card_lifecycle_controls

{
  "type": "object",
  "title": "IssuingCardLifecycleControls",
  "required": [
    "cancel_after"
  ],
  "properties": {
    "cancel_after": {
      "$ref": "#/components/schemas/issuing_card_lifecycle_conditions"
    }
  },
  "description": "",
  "x-expandableFields": [
    "cancel_after"
  ]
}

object issuing_card_shipping

{
  "type": "object",
  "title": "IssuingCardShipping",
  "required": [
    "address",
    "name",
    "service",
    "type"
  ],
  "properties": {
    "eta": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "A unix timestamp representing a best estimate of when the card will be delivered."
    },
    "name": {
      "type": "string",
      "maxLength": 5000,
      "description": "Recipient name."
    },
    "type": {
      "enum": [
        "bulk",
        "individual"
      ],
      "type": "string",
      "description": "Packaging options."
    },
    "status": {
      "enum": [
        "canceled",
        "delivered",
        "failure",
        "pending",
        "returned",
        "shipped",
        "submitted"
      ],
      "type": "string",
      "nullable": true,
      "description": "The delivery status of the card."
    },
    "address": {
      "$ref": "#/components/schemas/address"
    },
    "carrier": {
      "enum": [
        "dhl",
        "fedex",
        "royal_mail",
        "usps"
      ],
      "type": "string",
      "nullable": true,
      "description": "The delivery company that shipped a card."
    },
    "customs": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_card_shipping_customs"
        }
      ],
      "nullable": true,
      "description": "Additional information that may be required for clearing customs."
    },
    "service": {
      "enum": [
        "express",
        "priority",
        "standard"
      ],
      "type": "string",
      "description": "Shipment service, such as `standard` or `express`.",
      "x-stripeBypassValidation": true
    },
    "phone_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The phone number of the receiver of the shipment. Our courier partners will use this number to contact you in the event of card delivery issues. For individual shipments to the EU/UK, if this field is empty, we will provide them with the phone number provided when the cardholder was initially created."
    },
    "tracking_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A link to the shipping carrier's site where you can view detailed information about a card shipment."
    },
    "tracking_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A tracking number for a card shipment."
    },
    "require_signature": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether a signature is required for card delivery. This feature is only supported for US users. Standard shipping service does not support signature on delivery. The default value for standard shipping service is false and for express and priority services is true."
    },
    "address_validation": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_card_shipping_address_validation"
        }
      ],
      "nullable": true,
      "description": "Address validation details for the shipment."
    }
  },
  "description": "",
  "x-expandableFields": [
    "address",
    "address_validation",
    "customs"
  ]
}

object issuing_card_shipping_address_validation

{
  "type": "object",
  "title": "IssuingCardShippingAddressValidation",
  "required": [
    "mode"
  ],
  "properties": {
    "mode": {
      "enum": [
        "disabled",
        "normalization_only",
        "validation_and_normalization"
      ],
      "type": "string",
      "description": "The address validation capabilities to use."
    },
    "result": {
      "enum": [
        "indeterminate",
        "likely_deliverable",
        "likely_undeliverable"
      ],
      "type": "string",
      "nullable": true,
      "description": "The validation result for the shipping address."
    },
    "normalized_address": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/address"
        }
      ],
      "nullable": true,
      "description": "The normalized shipping address."
    }
  },
  "description": "",
  "x-expandableFields": [
    "normalized_address"
  ]
}

object issuing_card_shipping_customs

{
  "type": "object",
  "title": "IssuingCardShippingCustoms",
  "properties": {
    "eori_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A registration number used for customs in Europe. See [https://www.gov.uk/eori](https://www.gov.uk/eori) for the UK and [https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en](https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en) for the EU."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_card_spending_limit

{
  "type": "object",
  "title": "IssuingCardSpendingLimit",
  "required": [
    "amount",
    "interval"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."
    },
    "interval": {
      "enum": [
        "all_time",
        "daily",
        "monthly",
        "per_authorization",
        "weekly",
        "yearly"
      ],
      "type": "string",
      "description": "Interval (or event) to which the amount applies."
    },
    "categories": {
      "type": "array",
      "items": {
        "enum": [
          "ac_refrigeration_repair",
          "accounting_bookkeeping_services",
          "advertising_services",
          "agricultural_cooperative",
          "airlines_air_carriers",
          "airports_flying_fields",
          "ambulance_services",
          "amusement_parks_carnivals",
          "antique_reproductions",
          "antique_shops",
          "aquariums",
          "architectural_surveying_services",
          "art_dealers_and_galleries",
          "artists_supply_and_craft_shops",
          "auto_and_home_supply_stores",
          "auto_body_repair_shops",
          "auto_paint_shops",
          "auto_service_shops",
          "automated_cash_disburse",
          "automated_fuel_dispensers",
          "automobile_associations",
          "automotive_parts_and_accessories_stores",
          "automotive_tire_stores",
          "bail_and_bond_payments",
          "bakeries",
          "bands_orchestras",
          "barber_and_beauty_shops",
          "betting_casino_gambling",
          "bicycle_shops",
          "billiard_pool_establishments",
          "boat_dealers",
          "boat_rentals_and_leases",
          "book_stores",
          "books_periodicals_and_newspapers",
          "bowling_alleys",
          "bus_lines",
          "business_secretarial_schools",
          "buying_shopping_services",
          "cable_satellite_and_other_pay_television_and_radio",
          "camera_and_photographic_supply_stores",
          "candy_nut_and_confectionery_stores",
          "car_and_truck_dealers_new_used",
          "car_and_truck_dealers_used_only",
          "car_rental_agencies",
          "car_washes",
          "carpentry_services",
          "carpet_upholstery_cleaning",
          "caterers",
          "charitable_and_social_service_organizations_fundraising",
          "chemicals_and_allied_products",
          "child_care_services",
          "childrens_and_infants_wear_stores",
          "chiropodists_podiatrists",
          "chiropractors",
          "cigar_stores_and_stands",
          "civic_social_fraternal_associations",
          "cleaning_and_maintenance",
          "clothing_rental",
          "colleges_universities",
          "commercial_equipment",
          "commercial_footwear",
          "commercial_photography_art_and_graphics",
          "commuter_transport_and_ferries",
          "computer_network_services",
          "computer_programming",
          "computer_repair",
          "computer_software_stores",
          "computers_peripherals_and_software",
          "concrete_work_services",
          "construction_materials",
          "consulting_public_relations",
          "correspondence_schools",
          "cosmetic_stores",
          "counseling_services",
          "country_clubs",
          "courier_services",
          "court_costs",
          "credit_reporting_agencies",
          "cruise_lines",
          "dairy_products_stores",
          "dance_hall_studios_schools",
          "dating_escort_services",
          "dentists_orthodontists",
          "department_stores",
          "detective_agencies",
          "digital_goods_applications",
          "digital_goods_games",
          "digital_goods_large_volume",
          "digital_goods_media",
          "direct_marketing_catalog_merchant",
          "direct_marketing_combination_catalog_and_retail_merchant",
          "direct_marketing_inbound_telemarketing",
          "direct_marketing_insurance_services",
          "direct_marketing_other",
          "direct_marketing_outbound_telemarketing",
          "direct_marketing_subscription",
          "direct_marketing_travel",
          "discount_stores",
          "doctors",
          "door_to_door_sales",
          "drapery_window_covering_and_upholstery_stores",
          "drinking_places",
          "drug_stores_and_pharmacies",
          "drugs_drug_proprietaries_and_druggist_sundries",
          "dry_cleaners",
          "durable_goods",
          "duty_free_stores",
          "eating_places_restaurants",
          "educational_services",
          "electric_razor_stores",
          "electric_vehicle_charging",
          "electrical_parts_and_equipment",
          "electrical_services",
          "electronics_repair_shops",
          "electronics_stores",
          "elementary_secondary_schools",
          "emergency_services_gcas_visa_use_only",
          "employment_temp_agencies",
          "equipment_rental",
          "exterminating_services",
          "family_clothing_stores",
          "fast_food_restaurants",
          "financial_institutions",
          "fines_government_administrative_entities",
          "fireplace_fireplace_screens_and_accessories_stores",
          "floor_covering_stores",
          "florists",
          "florists_supplies_nursery_stock_and_flowers",
          "freezer_and_locker_meat_provisioners",
          "fuel_dealers_non_automotive",
          "funeral_services_crematories",
          "furniture_home_furnishings_and_equipment_stores_except_appliances",
          "furniture_repair_refinishing",
          "furriers_and_fur_shops",
          "general_services",
          "gift_card_novelty_and_souvenir_shops",
          "glass_paint_and_wallpaper_stores",
          "glassware_crystal_stores",
          "golf_courses_public",
          "government_licensed_horse_dog_racing_us_region_only",
          "government_licensed_online_casions_online_gambling_us_region_only",
          "government_owned_lotteries_non_us_region",
          "government_owned_lotteries_us_region_only",
          "government_services",
          "grocery_stores_supermarkets",
          "hardware_equipment_and_supplies",
          "hardware_stores",
          "health_and_beauty_spas",
          "hearing_aids_sales_and_supplies",
          "heating_plumbing_a_c",
          "hobby_toy_and_game_shops",
          "home_supply_warehouse_stores",
          "hospitals",
          "hotels_motels_and_resorts",
          "household_appliance_stores",
          "industrial_supplies",
          "information_retrieval_services",
          "insurance_default",
          "insurance_underwriting_premiums",
          "intra_company_purchases",
          "jewelry_stores_watches_clocks_and_silverware_stores",
          "landscaping_services",
          "laundries",
          "laundry_cleaning_services",
          "legal_services_attorneys",
          "luggage_and_leather_goods_stores",
          "lumber_building_materials_stores",
          "manual_cash_disburse",
          "marinas_service_and_supplies",
          "marketplaces",
          "masonry_stonework_and_plaster",
          "massage_parlors",
          "medical_and_dental_labs",
          "medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
          "medical_services",
          "membership_organizations",
          "mens_and_boys_clothing_and_accessories_stores",
          "mens_womens_clothing_stores",
          "metal_service_centers",
          "miscellaneous",
          "miscellaneous_apparel_and_accessory_shops",
          "miscellaneous_auto_dealers",
          "miscellaneous_business_services",
          "miscellaneous_food_stores",
          "miscellaneous_general_merchandise",
          "miscellaneous_general_services",
          "miscellaneous_home_furnishing_specialty_stores",
          "miscellaneous_publishing_and_printing",
          "miscellaneous_recreation_services",
          "miscellaneous_repair_shops",
          "miscellaneous_specialty_retail",
          "mobile_home_dealers",
          "motion_picture_theaters",
          "motor_freight_carriers_and_trucking",
          "motor_homes_dealers",
          "motor_vehicle_supplies_and_new_parts",
          "motorcycle_shops_and_dealers",
          "motorcycle_shops_dealers",
          "music_stores_musical_instruments_pianos_and_sheet_music",
          "news_dealers_and_newsstands",
          "non_fi_money_orders",
          "non_fi_stored_value_card_purchase_load",
          "nondurable_goods",
          "nurseries_lawn_and_garden_supply_stores",
          "nursing_personal_care",
          "office_and_commercial_furniture",
          "opticians_eyeglasses",
          "optometrists_ophthalmologist",
          "orthopedic_goods_prosthetic_devices",
          "osteopaths",
          "package_stores_beer_wine_and_liquor",
          "paints_varnishes_and_supplies",
          "parking_lots_garages",
          "passenger_railways",
          "pawn_shops",
          "pet_shops_pet_food_and_supplies",
          "petroleum_and_petroleum_products",
          "photo_developing",
          "photographic_photocopy_microfilm_equipment_and_supplies",
          "photographic_studios",
          "picture_video_production",
          "piece_goods_notions_and_other_dry_goods",
          "plumbing_heating_equipment_and_supplies",
          "political_organizations",
          "postal_services_government_only",
          "precious_stones_and_metals_watches_and_jewelry",
          "professional_services",
          "public_warehousing_and_storage",
          "quick_copy_repro_and_blueprint",
          "railroads",
          "real_estate_agents_and_managers_rentals",
          "record_stores",
          "recreational_vehicle_rentals",
          "religious_goods_stores",
          "religious_organizations",
          "roofing_siding_sheet_metal",
          "secretarial_support_services",
          "security_brokers_dealers",
          "service_stations",
          "sewing_needlework_fabric_and_piece_goods_stores",
          "shoe_repair_hat_cleaning",
          "shoe_stores",
          "small_appliance_repair",
          "snowmobile_dealers",
          "special_trade_services",
          "specialty_cleaning",
          "sporting_goods_stores",
          "sporting_recreation_camps",
          "sports_and_riding_apparel_stores",
          "sports_clubs_fields",
          "stamp_and_coin_stores",
          "stationary_office_supplies_printing_and_writing_paper",
          "stationery_stores_office_and_school_supply_stores",
          "swimming_pools_sales",
          "t_ui_travel_germany",
          "tailors_alterations",
          "tax_payments_government_agencies",
          "tax_preparation_services",
          "taxicabs_limousines",
          "telecommunication_equipment_and_telephone_sales",
          "telecommunication_services",
          "telegraph_services",
          "tent_and_awning_shops",
          "testing_laboratories",
          "theatrical_ticket_agencies",
          "timeshares",
          "tire_retreading_and_repair",
          "tolls_bridge_fees",
          "tourist_attractions_and_exhibits",
          "towing_services",
          "trailer_parks_campgrounds",
          "transportation_services",
          "travel_agencies_tour_operators",
          "truck_stop_iteration",
          "truck_utility_trailer_rentals",
          "typesetting_plate_making_and_related_services",
          "typewriter_stores",
          "u_s_federal_government_agencies_or_departments",
          "uniforms_commercial_clothing",
          "used_merchandise_and_secondhand_stores",
          "utilities",
          "variety_stores",
          "veterinary_services",
          "video_amusement_game_supplies",
          "video_game_arcades",
          "video_tape_rental_stores",
          "vocational_trade_schools",
          "watch_jewelry_repair",
          "welding_repair",
          "wholesale_clubs",
          "wig_and_toupee_stores",
          "wires_money_orders",
          "womens_accessory_and_specialty_shops",
          "womens_ready_to_wear_stores",
          "wrecking_and_salvage_yards"
        ],
        "type": "string"
      },
      "nullable": true,
      "description": "Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_card_wallets

{
  "type": "object",
  "title": "IssuingCardWallets",
  "required": [
    "apple_pay",
    "google_pay"
  ],
  "properties": {
    "apple_pay": {
      "$ref": "#/components/schemas/issuing_card_apple_pay"
    },
    "google_pay": {
      "$ref": "#/components/schemas/issuing_card_google_pay"
    },
    "primary_account_identifier": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Unique identifier for a card used with digital wallets"
    }
  },
  "description": "",
  "x-expandableFields": [
    "apple_pay",
    "google_pay"
  ]
}

object issuing_cardholder_address

{
  "type": "object",
  "title": "IssuingCardholderAddress",
  "required": [
    "address"
  ],
  "properties": {
    "address": {
      "$ref": "#/components/schemas/address"
    }
  },
  "description": "",
  "x-expandableFields": [
    "address"
  ]
}

object issuing_cardholder_authorization_controls

{
  "type": "object",
  "title": "IssuingCardholderAuthorizationControls",
  "properties": {
    "spending_limits": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/issuing_cardholder_spending_limit"
      },
      "nullable": true,
      "description": "Limit spending with amount-based rules that apply across this cardholder's cards."
    },
    "allowed_categories": {
      "type": "array",
      "items": {
        "enum": [
          "ac_refrigeration_repair",
          "accounting_bookkeeping_services",
          "advertising_services",
          "agricultural_cooperative",
          "airlines_air_carriers",
          "airports_flying_fields",
          "ambulance_services",
          "amusement_parks_carnivals",
          "antique_reproductions",
          "antique_shops",
          "aquariums",
          "architectural_surveying_services",
          "art_dealers_and_galleries",
          "artists_supply_and_craft_shops",
          "auto_and_home_supply_stores",
          "auto_body_repair_shops",
          "auto_paint_shops",
          "auto_service_shops",
          "automated_cash_disburse",
          "automated_fuel_dispensers",
          "automobile_associations",
          "automotive_parts_and_accessories_stores",
          "automotive_tire_stores",
          "bail_and_bond_payments",
          "bakeries",
          "bands_orchestras",
          "barber_and_beauty_shops",
          "betting_casino_gambling",
          "bicycle_shops",
          "billiard_pool_establishments",
          "boat_dealers",
          "boat_rentals_and_leases",
          "book_stores",
          "books_periodicals_and_newspapers",
          "bowling_alleys",
          "bus_lines",
          "business_secretarial_schools",
          "buying_shopping_services",
          "cable_satellite_and_other_pay_television_and_radio",
          "camera_and_photographic_supply_stores",
          "candy_nut_and_confectionery_stores",
          "car_and_truck_dealers_new_used",
          "car_and_truck_dealers_used_only",
          "car_rental_agencies",
          "car_washes",
          "carpentry_services",
          "carpet_upholstery_cleaning",
          "caterers",
          "charitable_and_social_service_organizations_fundraising",
          "chemicals_and_allied_products",
          "child_care_services",
          "childrens_and_infants_wear_stores",
          "chiropodists_podiatrists",
          "chiropractors",
          "cigar_stores_and_stands",
          "civic_social_fraternal_associations",
          "cleaning_and_maintenance",
          "clothing_rental",
          "colleges_universities",
          "commercial_equipment",
          "commercial_footwear",
          "commercial_photography_art_and_graphics",
          "commuter_transport_and_ferries",
          "computer_network_services",
          "computer_programming",
          "computer_repair",
          "computer_software_stores",
          "computers_peripherals_and_software",
          "concrete_work_services",
          "construction_materials",
          "consulting_public_relations",
          "correspondence_schools",
          "cosmetic_stores",
          "counseling_services",
          "country_clubs",
          "courier_services",
          "court_costs",
          "credit_reporting_agencies",
          "cruise_lines",
          "dairy_products_stores",
          "dance_hall_studios_schools",
          "dating_escort_services",
          "dentists_orthodontists",
          "department_stores",
          "detective_agencies",
          "digital_goods_applications",
          "digital_goods_games",
          "digital_goods_large_volume",
          "digital_goods_media",
          "direct_marketing_catalog_merchant",
          "direct_marketing_combination_catalog_and_retail_merchant",
          "direct_marketing_inbound_telemarketing",
          "direct_marketing_insurance_services",
          "direct_marketing_other",
          "direct_marketing_outbound_telemarketing",
          "direct_marketing_subscription",
          "direct_marketing_travel",
          "discount_stores",
          "doctors",
          "door_to_door_sales",
          "drapery_window_covering_and_upholstery_stores",
          "drinking_places",
          "drug_stores_and_pharmacies",
          "drugs_drug_proprietaries_and_druggist_sundries",
          "dry_cleaners",
          "durable_goods",
          "duty_free_stores",
          "eating_places_restaurants",
          "educational_services",
          "electric_razor_stores",
          "electric_vehicle_charging",
          "electrical_parts_and_equipment",
          "electrical_services",
          "electronics_repair_shops",
          "electronics_stores",
          "elementary_secondary_schools",
          "emergency_services_gcas_visa_use_only",
          "employment_temp_agencies",
          "equipment_rental",
          "exterminating_services",
          "family_clothing_stores",
          "fast_food_restaurants",
          "financial_institutions",
          "fines_government_administrative_entities",
          "fireplace_fireplace_screens_and_accessories_stores",
          "floor_covering_stores",
          "florists",
          "florists_supplies_nursery_stock_and_flowers",
          "freezer_and_locker_meat_provisioners",
          "fuel_dealers_non_automotive",
          "funeral_services_crematories",
          "furniture_home_furnishings_and_equipment_stores_except_appliances",
          "furniture_repair_refinishing",
          "furriers_and_fur_shops",
          "general_services",
          "gift_card_novelty_and_souvenir_shops",
          "glass_paint_and_wallpaper_stores",
          "glassware_crystal_stores",
          "golf_courses_public",
          "government_licensed_horse_dog_racing_us_region_only",
          "government_licensed_online_casions_online_gambling_us_region_only",
          "government_owned_lotteries_non_us_region",
          "government_owned_lotteries_us_region_only",
          "government_services",
          "grocery_stores_supermarkets",
          "hardware_equipment_and_supplies",
          "hardware_stores",
          "health_and_beauty_spas",
          "hearing_aids_sales_and_supplies",
          "heating_plumbing_a_c",
          "hobby_toy_and_game_shops",
          "home_supply_warehouse_stores",
          "hospitals",
          "hotels_motels_and_resorts",
          "household_appliance_stores",
          "industrial_supplies",
          "information_retrieval_services",
          "insurance_default",
          "insurance_underwriting_premiums",
          "intra_company_purchases",
          "jewelry_stores_watches_clocks_and_silverware_stores",
          "landscaping_services",
          "laundries",
          "laundry_cleaning_services",
          "legal_services_attorneys",
          "luggage_and_leather_goods_stores",
          "lumber_building_materials_stores",
          "manual_cash_disburse",
          "marinas_service_and_supplies",
          "marketplaces",
          "masonry_stonework_and_plaster",
          "massage_parlors",
          "medical_and_dental_labs",
          "medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
          "medical_services",
          "membership_organizations",
          "mens_and_boys_clothing_and_accessories_stores",
          "mens_womens_clothing_stores",
          "metal_service_centers",
          "miscellaneous",
          "miscellaneous_apparel_and_accessory_shops",
          "miscellaneous_auto_dealers",
          "miscellaneous_business_services",
          "miscellaneous_food_stores",
          "miscellaneous_general_merchandise",
          "miscellaneous_general_services",
          "miscellaneous_home_furnishing_specialty_stores",
          "miscellaneous_publishing_and_printing",
          "miscellaneous_recreation_services",
          "miscellaneous_repair_shops",
          "miscellaneous_specialty_retail",
          "mobile_home_dealers",
          "motion_picture_theaters",
          "motor_freight_carriers_and_trucking",
          "motor_homes_dealers",
          "motor_vehicle_supplies_and_new_parts",
          "motorcycle_shops_and_dealers",
          "motorcycle_shops_dealers",
          "music_stores_musical_instruments_pianos_and_sheet_music",
          "news_dealers_and_newsstands",
          "non_fi_money_orders",
          "non_fi_stored_value_card_purchase_load",
          "nondurable_goods",
          "nurseries_lawn_and_garden_supply_stores",
          "nursing_personal_care",
          "office_and_commercial_furniture",
          "opticians_eyeglasses",
          "optometrists_ophthalmologist",
          "orthopedic_goods_prosthetic_devices",
          "osteopaths",
          "package_stores_beer_wine_and_liquor",
          "paints_varnishes_and_supplies",
          "parking_lots_garages",
          "passenger_railways",
          "pawn_shops",
          "pet_shops_pet_food_and_supplies",
          "petroleum_and_petroleum_products",
          "photo_developing",
          "photographic_photocopy_microfilm_equipment_and_supplies",
          "photographic_studios",
          "picture_video_production",
          "piece_goods_notions_and_other_dry_goods",
          "plumbing_heating_equipment_and_supplies",
          "political_organizations",
          "postal_services_government_only",
          "precious_stones_and_metals_watches_and_jewelry",
          "professional_services",
          "public_warehousing_and_storage",
          "quick_copy_repro_and_blueprint",
          "railroads",
          "real_estate_agents_and_managers_rentals",
          "record_stores",
          "recreational_vehicle_rentals",
          "religious_goods_stores",
          "religious_organizations",
          "roofing_siding_sheet_metal",
          "secretarial_support_services",
          "security_brokers_dealers",
          "service_stations",
          "sewing_needlework_fabric_and_piece_goods_stores",
          "shoe_repair_hat_cleaning",
          "shoe_stores",
          "small_appliance_repair",
          "snowmobile_dealers",
          "special_trade_services",
          "specialty_cleaning",
          "sporting_goods_stores",
          "sporting_recreation_camps",
          "sports_and_riding_apparel_stores",
          "sports_clubs_fields",
          "stamp_and_coin_stores",
          "stationary_office_supplies_printing_and_writing_paper",
          "stationery_stores_office_and_school_supply_stores",
          "swimming_pools_sales",
          "t_ui_travel_germany",
          "tailors_alterations",
          "tax_payments_government_agencies",
          "tax_preparation_services",
          "taxicabs_limousines",
          "telecommunication_equipment_and_telephone_sales",
          "telecommunication_services",
          "telegraph_services",
          "tent_and_awning_shops",
          "testing_laboratories",
          "theatrical_ticket_agencies",
          "timeshares",
          "tire_retreading_and_repair",
          "tolls_bridge_fees",
          "tourist_attractions_and_exhibits",
          "towing_services",
          "trailer_parks_campgrounds",
          "transportation_services",
          "travel_agencies_tour_operators",
          "truck_stop_iteration",
          "truck_utility_trailer_rentals",
          "typesetting_plate_making_and_related_services",
          "typewriter_stores",
          "u_s_federal_government_agencies_or_departments",
          "uniforms_commercial_clothing",
          "used_merchandise_and_secondhand_stores",
          "utilities",
          "variety_stores",
          "veterinary_services",
          "video_amusement_game_supplies",
          "video_game_arcades",
          "video_tape_rental_stores",
          "vocational_trade_schools",
          "watch_jewelry_repair",
          "welding_repair",
          "wholesale_clubs",
          "wig_and_toupee_stores",
          "wires_money_orders",
          "womens_accessory_and_specialty_shops",
          "womens_ready_to_wear_stores",
          "wrecking_and_salvage_yards"
        ],
        "type": "string"
      },
      "nullable": true,
      "description": "Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`."
    },
    "blocked_categories": {
      "type": "array",
      "items": {
        "enum": [
          "ac_refrigeration_repair",
          "accounting_bookkeeping_services",
          "advertising_services",
          "agricultural_cooperative",
          "airlines_air_carriers",
          "airports_flying_fields",
          "ambulance_services",
          "amusement_parks_carnivals",
          "antique_reproductions",
          "antique_shops",
          "aquariums",
          "architectural_surveying_services",
          "art_dealers_and_galleries",
          "artists_supply_and_craft_shops",
          "auto_and_home_supply_stores",
          "auto_body_repair_shops",
          "auto_paint_shops",
          "auto_service_shops",
          "automated_cash_disburse",
          "automated_fuel_dispensers",
          "automobile_associations",
          "automotive_parts_and_accessories_stores",
          "automotive_tire_stores",
          "bail_and_bond_payments",
          "bakeries",
          "bands_orchestras",
          "barber_and_beauty_shops",
          "betting_casino_gambling",
          "bicycle_shops",
          "billiard_pool_establishments",
          "boat_dealers",
          "boat_rentals_and_leases",
          "book_stores",
          "books_periodicals_and_newspapers",
          "bowling_alleys",
          "bus_lines",
          "business_secretarial_schools",
          "buying_shopping_services",
          "cable_satellite_and_other_pay_television_and_radio",
          "camera_and_photographic_supply_stores",
          "candy_nut_and_confectionery_stores",
          "car_and_truck_dealers_new_used",
          "car_and_truck_dealers_used_only",
          "car_rental_agencies",
          "car_washes",
          "carpentry_services",
          "carpet_upholstery_cleaning",
          "caterers",
          "charitable_and_social_service_organizations_fundraising",
          "chemicals_and_allied_products",
          "child_care_services",
          "childrens_and_infants_wear_stores",
          "chiropodists_podiatrists",
          "chiropractors",
          "cigar_stores_and_stands",
          "civic_social_fraternal_associations",
          "cleaning_and_maintenance",
          "clothing_rental",
          "colleges_universities",
          "commercial_equipment",
          "commercial_footwear",
          "commercial_photography_art_and_graphics",
          "commuter_transport_and_ferries",
          "computer_network_services",
          "computer_programming",
          "computer_repair",
          "computer_software_stores",
          "computers_peripherals_and_software",
          "concrete_work_services",
          "construction_materials",
          "consulting_public_relations",
          "correspondence_schools",
          "cosmetic_stores",
          "counseling_services",
          "country_clubs",
          "courier_services",
          "court_costs",
          "credit_reporting_agencies",
          "cruise_lines",
          "dairy_products_stores",
          "dance_hall_studios_schools",
          "dating_escort_services",
          "dentists_orthodontists",
          "department_stores",
          "detective_agencies",
          "digital_goods_applications",
          "digital_goods_games",
          "digital_goods_large_volume",
          "digital_goods_media",
          "direct_marketing_catalog_merchant",
          "direct_marketing_combination_catalog_and_retail_merchant",
          "direct_marketing_inbound_telemarketing",
          "direct_marketing_insurance_services",
          "direct_marketing_other",
          "direct_marketing_outbound_telemarketing",
          "direct_marketing_subscription",
          "direct_marketing_travel",
          "discount_stores",
          "doctors",
          "door_to_door_sales",
          "drapery_window_covering_and_upholstery_stores",
          "drinking_places",
          "drug_stores_and_pharmacies",
          "drugs_drug_proprietaries_and_druggist_sundries",
          "dry_cleaners",
          "durable_goods",
          "duty_free_stores",
          "eating_places_restaurants",
          "educational_services",
          "electric_razor_stores",
          "electric_vehicle_charging",
          "electrical_parts_and_equipment",
          "electrical_services",
          "electronics_repair_shops",
          "electronics_stores",
          "elementary_secondary_schools",
          "emergency_services_gcas_visa_use_only",
          "employment_temp_agencies",
          "equipment_rental",
          "exterminating_services",
          "family_clothing_stores",
          "fast_food_restaurants",
          "financial_institutions",
          "fines_government_administrative_entities",
          "fireplace_fireplace_screens_and_accessories_stores",
          "floor_covering_stores",
          "florists",
          "florists_supplies_nursery_stock_and_flowers",
          "freezer_and_locker_meat_provisioners",
          "fuel_dealers_non_automotive",
          "funeral_services_crematories",
          "furniture_home_furnishings_and_equipment_stores_except_appliances",
          "furniture_repair_refinishing",
          "furriers_and_fur_shops",
          "general_services",
          "gift_card_novelty_and_souvenir_shops",
          "glass_paint_and_wallpaper_stores",
          "glassware_crystal_stores",
          "golf_courses_public",
          "government_licensed_horse_dog_racing_us_region_only",
          "government_licensed_online_casions_online_gambling_us_region_only",
          "government_owned_lotteries_non_us_region",
          "government_owned_lotteries_us_region_only",
          "government_services",
          "grocery_stores_supermarkets",
          "hardware_equipment_and_supplies",
          "hardware_stores",
          "health_and_beauty_spas",
          "hearing_aids_sales_and_supplies",
          "heating_plumbing_a_c",
          "hobby_toy_and_game_shops",
          "home_supply_warehouse_stores",
          "hospitals",
          "hotels_motels_and_resorts",
          "household_appliance_stores",
          "industrial_supplies",
          "information_retrieval_services",
          "insurance_default",
          "insurance_underwriting_premiums",
          "intra_company_purchases",
          "jewelry_stores_watches_clocks_and_silverware_stores",
          "landscaping_services",
          "laundries",
          "laundry_cleaning_services",
          "legal_services_attorneys",
          "luggage_and_leather_goods_stores",
          "lumber_building_materials_stores",
          "manual_cash_disburse",
          "marinas_service_and_supplies",
          "marketplaces",
          "masonry_stonework_and_plaster",
          "massage_parlors",
          "medical_and_dental_labs",
          "medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
          "medical_services",
          "membership_organizations",
          "mens_and_boys_clothing_and_accessories_stores",
          "mens_womens_clothing_stores",
          "metal_service_centers",
          "miscellaneous",
          "miscellaneous_apparel_and_accessory_shops",
          "miscellaneous_auto_dealers",
          "miscellaneous_business_services",
          "miscellaneous_food_stores",
          "miscellaneous_general_merchandise",
          "miscellaneous_general_services",
          "miscellaneous_home_furnishing_specialty_stores",
          "miscellaneous_publishing_and_printing",
          "miscellaneous_recreation_services",
          "miscellaneous_repair_shops",
          "miscellaneous_specialty_retail",
          "mobile_home_dealers",
          "motion_picture_theaters",
          "motor_freight_carriers_and_trucking",
          "motor_homes_dealers",
          "motor_vehicle_supplies_and_new_parts",
          "motorcycle_shops_and_dealers",
          "motorcycle_shops_dealers",
          "music_stores_musical_instruments_pianos_and_sheet_music",
          "news_dealers_and_newsstands",
          "non_fi_money_orders",
          "non_fi_stored_value_card_purchase_load",
          "nondurable_goods",
          "nurseries_lawn_and_garden_supply_stores",
          "nursing_personal_care",
          "office_and_commercial_furniture",
          "opticians_eyeglasses",
          "optometrists_ophthalmologist",
          "orthopedic_goods_prosthetic_devices",
          "osteopaths",
          "package_stores_beer_wine_and_liquor",
          "paints_varnishes_and_supplies",
          "parking_lots_garages",
          "passenger_railways",
          "pawn_shops",
          "pet_shops_pet_food_and_supplies",
          "petroleum_and_petroleum_products",
          "photo_developing",
          "photographic_photocopy_microfilm_equipment_and_supplies",
          "photographic_studios",
          "picture_video_production",
          "piece_goods_notions_and_other_dry_goods",
          "plumbing_heating_equipment_and_supplies",
          "political_organizations",
          "postal_services_government_only",
          "precious_stones_and_metals_watches_and_jewelry",
          "professional_services",
          "public_warehousing_and_storage",
          "quick_copy_repro_and_blueprint",
          "railroads",
          "real_estate_agents_and_managers_rentals",
          "record_stores",
          "recreational_vehicle_rentals",
          "religious_goods_stores",
          "religious_organizations",
          "roofing_siding_sheet_metal",
          "secretarial_support_services",
          "security_brokers_dealers",
          "service_stations",
          "sewing_needlework_fabric_and_piece_goods_stores",
          "shoe_repair_hat_cleaning",
          "shoe_stores",
          "small_appliance_repair",
          "snowmobile_dealers",
          "special_trade_services",
          "specialty_cleaning",
          "sporting_goods_stores",
          "sporting_recreation_camps",
          "sports_and_riding_apparel_stores",
          "sports_clubs_fields",
          "stamp_and_coin_stores",
          "stationary_office_supplies_printing_and_writing_paper",
          "stationery_stores_office_and_school_supply_stores",
          "swimming_pools_sales",
          "t_ui_travel_germany",
          "tailors_alterations",
          "tax_payments_government_agencies",
          "tax_preparation_services",
          "taxicabs_limousines",
          "telecommunication_equipment_and_telephone_sales",
          "telecommunication_services",
          "telegraph_services",
          "tent_and_awning_shops",
          "testing_laboratories",
          "theatrical_ticket_agencies",
          "timeshares",
          "tire_retreading_and_repair",
          "tolls_bridge_fees",
          "tourist_attractions_and_exhibits",
          "towing_services",
          "trailer_parks_campgrounds",
          "transportation_services",
          "travel_agencies_tour_operators",
          "truck_stop_iteration",
          "truck_utility_trailer_rentals",
          "typesetting_plate_making_and_related_services",
          "typewriter_stores",
          "u_s_federal_government_agencies_or_departments",
          "uniforms_commercial_clothing",
          "used_merchandise_and_secondhand_stores",
          "utilities",
          "variety_stores",
          "veterinary_services",
          "video_amusement_game_supplies",
          "video_game_arcades",
          "video_tape_rental_stores",
          "vocational_trade_schools",
          "watch_jewelry_repair",
          "welding_repair",
          "wholesale_clubs",
          "wig_and_toupee_stores",
          "wires_money_orders",
          "womens_accessory_and_specialty_shops",
          "womens_ready_to_wear_stores",
          "wrecking_and_salvage_yards"
        ],
        "type": "string"
      },
      "nullable": true,
      "description": "Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`."
    },
    "spending_limits_currency": {
      "type": "string",
      "format": "currency",
      "nullable": true,
      "description": "Currency of the amounts within `spending_limits`."
    },
    "allowed_merchant_countries": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control."
    },
    "blocked_merchant_countries": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control."
    }
  },
  "description": "",
  "x-expandableFields": [
    "spending_limits"
  ]
}

object issuing_cardholder_card_issuing

{
  "type": "object",
  "title": "IssuingCardholderCardIssuing",
  "properties": {
    "user_terms_acceptance": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_cardholder_user_terms_acceptance"
        }
      ],
      "nullable": true,
      "description": "Information about cardholder acceptance of Celtic [Authorized User Terms](https://stripe.com/docs/issuing/cards#accept-authorized-user-terms). Required for cards backed by a Celtic program."
    }
  },
  "description": "",
  "x-expandableFields": [
    "user_terms_acceptance"
  ]
}

object issuing_cardholder_company

{
  "type": "object",
  "title": "IssuingCardholderCompany",
  "required": [
    "tax_id_provided"
  ],
  "properties": {
    "tax_id_provided": {
      "type": "boolean",
      "description": "Whether the company's business ID number was provided."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_cardholder_id_document

{
  "type": "object",
  "title": "IssuingCardholderIdDocument",
  "properties": {
    "back": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "The back of a document returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    },
    "front": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "The front of a document returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "back",
    "front"
  ]
}

object issuing_cardholder_individual

{
  "type": "object",
  "title": "IssuingCardholderIndividual",
  "properties": {
    "dob": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_cardholder_individual_dob"
        }
      ],
      "nullable": true,
      "description": "The date of birth of this cardholder."
    },
    "last_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters."
    },
    "first_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters."
    },
    "card_issuing": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_cardholder_card_issuing"
        }
      ],
      "nullable": true,
      "description": "Information related to the card_issuing program for this cardholder."
    },
    "verification": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_cardholder_verification"
        }
      ],
      "nullable": true,
      "description": "Government-issued ID document for this cardholder."
    }
  },
  "description": "",
  "x-expandableFields": [
    "card_issuing",
    "dob",
    "verification"
  ]
}

object issuing_cardholder_individual_dob

{
  "type": "object",
  "title": "IssuingCardholderIndividualDOB",
  "properties": {
    "day": {
      "type": "integer",
      "nullable": true,
      "description": "The day of birth, between 1 and 31."
    },
    "year": {
      "type": "integer",
      "nullable": true,
      "description": "The four-digit year of birth."
    },
    "month": {
      "type": "integer",
      "nullable": true,
      "description": "The month of birth, between 1 and 12."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_cardholder_requirements

{
  "type": "object",
  "title": "IssuingCardholderRequirements",
  "properties": {
    "past_due": {
      "type": "array",
      "items": {
        "enum": [
          "company.tax_id",
          "individual.card_issuing.user_terms_acceptance.date",
          "individual.card_issuing.user_terms_acceptance.ip",
          "individual.dob.day",
          "individual.dob.month",
          "individual.dob.year",
          "individual.first_name",
          "individual.last_name",
          "individual.verification.document"
        ],
        "type": "string",
        "x-stripeBypassValidation": true
      },
      "nullable": true,
      "description": "Array of fields that need to be collected in order to verify and re-enable the cardholder."
    },
    "disabled_reason": {
      "enum": [
        "listed",
        "rejected.listed",
        "requirements.past_due",
        "under_review"
      ],
      "type": "string",
      "nullable": true,
      "description": "If `disabled_reason` is present, all cards will decline authorizations with `cardholder_verification_required` reason."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_cardholder_spending_limit

{
  "type": "object",
  "title": "IssuingCardholderSpendingLimit",
  "required": [
    "amount",
    "interval"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."
    },
    "interval": {
      "enum": [
        "all_time",
        "daily",
        "monthly",
        "per_authorization",
        "weekly",
        "yearly"
      ],
      "type": "string",
      "description": "Interval (or event) to which the amount applies."
    },
    "categories": {
      "type": "array",
      "items": {
        "enum": [
          "ac_refrigeration_repair",
          "accounting_bookkeeping_services",
          "advertising_services",
          "agricultural_cooperative",
          "airlines_air_carriers",
          "airports_flying_fields",
          "ambulance_services",
          "amusement_parks_carnivals",
          "antique_reproductions",
          "antique_shops",
          "aquariums",
          "architectural_surveying_services",
          "art_dealers_and_galleries",
          "artists_supply_and_craft_shops",
          "auto_and_home_supply_stores",
          "auto_body_repair_shops",
          "auto_paint_shops",
          "auto_service_shops",
          "automated_cash_disburse",
          "automated_fuel_dispensers",
          "automobile_associations",
          "automotive_parts_and_accessories_stores",
          "automotive_tire_stores",
          "bail_and_bond_payments",
          "bakeries",
          "bands_orchestras",
          "barber_and_beauty_shops",
          "betting_casino_gambling",
          "bicycle_shops",
          "billiard_pool_establishments",
          "boat_dealers",
          "boat_rentals_and_leases",
          "book_stores",
          "books_periodicals_and_newspapers",
          "bowling_alleys",
          "bus_lines",
          "business_secretarial_schools",
          "buying_shopping_services",
          "cable_satellite_and_other_pay_television_and_radio",
          "camera_and_photographic_supply_stores",
          "candy_nut_and_confectionery_stores",
          "car_and_truck_dealers_new_used",
          "car_and_truck_dealers_used_only",
          "car_rental_agencies",
          "car_washes",
          "carpentry_services",
          "carpet_upholstery_cleaning",
          "caterers",
          "charitable_and_social_service_organizations_fundraising",
          "chemicals_and_allied_products",
          "child_care_services",
          "childrens_and_infants_wear_stores",
          "chiropodists_podiatrists",
          "chiropractors",
          "cigar_stores_and_stands",
          "civic_social_fraternal_associations",
          "cleaning_and_maintenance",
          "clothing_rental",
          "colleges_universities",
          "commercial_equipment",
          "commercial_footwear",
          "commercial_photography_art_and_graphics",
          "commuter_transport_and_ferries",
          "computer_network_services",
          "computer_programming",
          "computer_repair",
          "computer_software_stores",
          "computers_peripherals_and_software",
          "concrete_work_services",
          "construction_materials",
          "consulting_public_relations",
          "correspondence_schools",
          "cosmetic_stores",
          "counseling_services",
          "country_clubs",
          "courier_services",
          "court_costs",
          "credit_reporting_agencies",
          "cruise_lines",
          "dairy_products_stores",
          "dance_hall_studios_schools",
          "dating_escort_services",
          "dentists_orthodontists",
          "department_stores",
          "detective_agencies",
          "digital_goods_applications",
          "digital_goods_games",
          "digital_goods_large_volume",
          "digital_goods_media",
          "direct_marketing_catalog_merchant",
          "direct_marketing_combination_catalog_and_retail_merchant",
          "direct_marketing_inbound_telemarketing",
          "direct_marketing_insurance_services",
          "direct_marketing_other",
          "direct_marketing_outbound_telemarketing",
          "direct_marketing_subscription",
          "direct_marketing_travel",
          "discount_stores",
          "doctors",
          "door_to_door_sales",
          "drapery_window_covering_and_upholstery_stores",
          "drinking_places",
          "drug_stores_and_pharmacies",
          "drugs_drug_proprietaries_and_druggist_sundries",
          "dry_cleaners",
          "durable_goods",
          "duty_free_stores",
          "eating_places_restaurants",
          "educational_services",
          "electric_razor_stores",
          "electric_vehicle_charging",
          "electrical_parts_and_equipment",
          "electrical_services",
          "electronics_repair_shops",
          "electronics_stores",
          "elementary_secondary_schools",
          "emergency_services_gcas_visa_use_only",
          "employment_temp_agencies",
          "equipment_rental",
          "exterminating_services",
          "family_clothing_stores",
          "fast_food_restaurants",
          "financial_institutions",
          "fines_government_administrative_entities",
          "fireplace_fireplace_screens_and_accessories_stores",
          "floor_covering_stores",
          "florists",
          "florists_supplies_nursery_stock_and_flowers",
          "freezer_and_locker_meat_provisioners",
          "fuel_dealers_non_automotive",
          "funeral_services_crematories",
          "furniture_home_furnishings_and_equipment_stores_except_appliances",
          "furniture_repair_refinishing",
          "furriers_and_fur_shops",
          "general_services",
          "gift_card_novelty_and_souvenir_shops",
          "glass_paint_and_wallpaper_stores",
          "glassware_crystal_stores",
          "golf_courses_public",
          "government_licensed_horse_dog_racing_us_region_only",
          "government_licensed_online_casions_online_gambling_us_region_only",
          "government_owned_lotteries_non_us_region",
          "government_owned_lotteries_us_region_only",
          "government_services",
          "grocery_stores_supermarkets",
          "hardware_equipment_and_supplies",
          "hardware_stores",
          "health_and_beauty_spas",
          "hearing_aids_sales_and_supplies",
          "heating_plumbing_a_c",
          "hobby_toy_and_game_shops",
          "home_supply_warehouse_stores",
          "hospitals",
          "hotels_motels_and_resorts",
          "household_appliance_stores",
          "industrial_supplies",
          "information_retrieval_services",
          "insurance_default",
          "insurance_underwriting_premiums",
          "intra_company_purchases",
          "jewelry_stores_watches_clocks_and_silverware_stores",
          "landscaping_services",
          "laundries",
          "laundry_cleaning_services",
          "legal_services_attorneys",
          "luggage_and_leather_goods_stores",
          "lumber_building_materials_stores",
          "manual_cash_disburse",
          "marinas_service_and_supplies",
          "marketplaces",
          "masonry_stonework_and_plaster",
          "massage_parlors",
          "medical_and_dental_labs",
          "medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
          "medical_services",
          "membership_organizations",
          "mens_and_boys_clothing_and_accessories_stores",
          "mens_womens_clothing_stores",
          "metal_service_centers",
          "miscellaneous",
          "miscellaneous_apparel_and_accessory_shops",
          "miscellaneous_auto_dealers",
          "miscellaneous_business_services",
          "miscellaneous_food_stores",
          "miscellaneous_general_merchandise",
          "miscellaneous_general_services",
          "miscellaneous_home_furnishing_specialty_stores",
          "miscellaneous_publishing_and_printing",
          "miscellaneous_recreation_services",
          "miscellaneous_repair_shops",
          "miscellaneous_specialty_retail",
          "mobile_home_dealers",
          "motion_picture_theaters",
          "motor_freight_carriers_and_trucking",
          "motor_homes_dealers",
          "motor_vehicle_supplies_and_new_parts",
          "motorcycle_shops_and_dealers",
          "motorcycle_shops_dealers",
          "music_stores_musical_instruments_pianos_and_sheet_music",
          "news_dealers_and_newsstands",
          "non_fi_money_orders",
          "non_fi_stored_value_card_purchase_load",
          "nondurable_goods",
          "nurseries_lawn_and_garden_supply_stores",
          "nursing_personal_care",
          "office_and_commercial_furniture",
          "opticians_eyeglasses",
          "optometrists_ophthalmologist",
          "orthopedic_goods_prosthetic_devices",
          "osteopaths",
          "package_stores_beer_wine_and_liquor",
          "paints_varnishes_and_supplies",
          "parking_lots_garages",
          "passenger_railways",
          "pawn_shops",
          "pet_shops_pet_food_and_supplies",
          "petroleum_and_petroleum_products",
          "photo_developing",
          "photographic_photocopy_microfilm_equipment_and_supplies",
          "photographic_studios",
          "picture_video_production",
          "piece_goods_notions_and_other_dry_goods",
          "plumbing_heating_equipment_and_supplies",
          "political_organizations",
          "postal_services_government_only",
          "precious_stones_and_metals_watches_and_jewelry",
          "professional_services",
          "public_warehousing_and_storage",
          "quick_copy_repro_and_blueprint",
          "railroads",
          "real_estate_agents_and_managers_rentals",
          "record_stores",
          "recreational_vehicle_rentals",
          "religious_goods_stores",
          "religious_organizations",
          "roofing_siding_sheet_metal",
          "secretarial_support_services",
          "security_brokers_dealers",
          "service_stations",
          "sewing_needlework_fabric_and_piece_goods_stores",
          "shoe_repair_hat_cleaning",
          "shoe_stores",
          "small_appliance_repair",
          "snowmobile_dealers",
          "special_trade_services",
          "specialty_cleaning",
          "sporting_goods_stores",
          "sporting_recreation_camps",
          "sports_and_riding_apparel_stores",
          "sports_clubs_fields",
          "stamp_and_coin_stores",
          "stationary_office_supplies_printing_and_writing_paper",
          "stationery_stores_office_and_school_supply_stores",
          "swimming_pools_sales",
          "t_ui_travel_germany",
          "tailors_alterations",
          "tax_payments_government_agencies",
          "tax_preparation_services",
          "taxicabs_limousines",
          "telecommunication_equipment_and_telephone_sales",
          "telecommunication_services",
          "telegraph_services",
          "tent_and_awning_shops",
          "testing_laboratories",
          "theatrical_ticket_agencies",
          "timeshares",
          "tire_retreading_and_repair",
          "tolls_bridge_fees",
          "tourist_attractions_and_exhibits",
          "towing_services",
          "trailer_parks_campgrounds",
          "transportation_services",
          "travel_agencies_tour_operators",
          "truck_stop_iteration",
          "truck_utility_trailer_rentals",
          "typesetting_plate_making_and_related_services",
          "typewriter_stores",
          "u_s_federal_government_agencies_or_departments",
          "uniforms_commercial_clothing",
          "used_merchandise_and_secondhand_stores",
          "utilities",
          "variety_stores",
          "veterinary_services",
          "video_amusement_game_supplies",
          "video_game_arcades",
          "video_tape_rental_stores",
          "vocational_trade_schools",
          "watch_jewelry_repair",
          "welding_repair",
          "wholesale_clubs",
          "wig_and_toupee_stores",
          "wires_money_orders",
          "womens_accessory_and_specialty_shops",
          "womens_ready_to_wear_stores",
          "wrecking_and_salvage_yards"
        ],
        "type": "string"
      },
      "nullable": true,
      "description": "Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_cardholder_user_terms_acceptance

{
  "type": "object",
  "title": "IssuingCardholderUserTermsAcceptance",
  "properties": {
    "ip": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The IP address from which the cardholder accepted the Authorized User Terms."
    },
    "date": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The Unix timestamp marking when the cardholder accepted the Authorized User Terms."
    },
    "user_agent": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The user agent of the browser from which the cardholder accepted the Authorized User Terms."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_cardholder_verification

{
  "type": "object",
  "title": "IssuingCardholderVerification",
  "properties": {
    "document": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_cardholder_id_document"
        }
      ],
      "nullable": true,
      "description": "An identifying document, either a passport or local ID card."
    }
  },
  "description": "",
  "x-expandableFields": [
    "document"
  ]
}

object issuing_dispute_canceled_evidence

{
  "type": "object",
  "title": "IssuingDisputeCanceledEvidence",
  "properties": {
    "canceled_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Date when order was canceled."
    },
    "expected_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Date when the cardholder expected to receive the product."
    },
    "explanation": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Explanation of why the cardholder is disputing this transaction."
    },
    "returned_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Date when the product was returned or attempted to be returned."
    },
    "product_type": {
      "enum": [
        "merchandise",
        "service"
      ],
      "type": "string",
      "nullable": true,
      "description": "Whether the product was a merchandise or service."
    },
    "return_status": {
      "enum": [
        "merchant_rejected",
        "successful"
      ],
      "type": "string",
      "nullable": true,
      "description": "Result of cardholder's attempt to return the product."
    },
    "cancellation_reason": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Reason for canceling the order."
    },
    "product_description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Description of the merchandise or service that was purchased."
    },
    "additional_documentation": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    },
    "cancellation_policy_provided": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether the cardholder was provided with a cancellation policy."
    }
  },
  "description": "",
  "x-expandableFields": [
    "additional_documentation"
  ]
}

object issuing_dispute_duplicate_evidence

{
  "type": "object",
  "title": "IssuingDisputeDuplicateEvidence",
  "properties": {
    "check_image": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    },
    "explanation": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Explanation of why the cardholder is disputing this transaction."
    },
    "cash_receipt": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    },
    "card_statement": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    },
    "original_transaction": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one."
    },
    "additional_documentation": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "additional_documentation",
    "card_statement",
    "cash_receipt",
    "check_image"
  ]
}

object issuing_dispute_evidence

{
  "type": "object",
  "title": "IssuingDisputeEvidence",
  "required": [
    "reason"
  ],
  "properties": {
    "other": {
      "$ref": "#/components/schemas/issuing_dispute_other_evidence"
    },
    "reason": {
      "enum": [
        "canceled",
        "duplicate",
        "fraudulent",
        "merchandise_not_as_described",
        "no_valid_authorization",
        "not_received",
        "other",
        "service_not_as_described"
      ],
      "type": "string",
      "description": "The reason for filing the dispute. Its value will match the field containing the evidence.",
      "x-stripeBypassValidation": true
    },
    "canceled": {
      "$ref": "#/components/schemas/issuing_dispute_canceled_evidence"
    },
    "duplicate": {
      "$ref": "#/components/schemas/issuing_dispute_duplicate_evidence"
    },
    "fraudulent": {
      "$ref": "#/components/schemas/issuing_dispute_fraudulent_evidence"
    },
    "not_received": {
      "$ref": "#/components/schemas/issuing_dispute_not_received_evidence"
    },
    "no_valid_authorization": {
      "$ref": "#/components/schemas/issuing_dispute_no_valid_authorization_evidence"
    },
    "service_not_as_described": {
      "$ref": "#/components/schemas/issuing_dispute_service_not_as_described_evidence"
    },
    "merchandise_not_as_described": {
      "$ref": "#/components/schemas/issuing_dispute_merchandise_not_as_described_evidence"
    }
  },
  "description": "",
  "x-expandableFields": [
    "canceled",
    "duplicate",
    "fraudulent",
    "merchandise_not_as_described",
    "no_valid_authorization",
    "not_received",
    "other",
    "service_not_as_described"
  ]
}

object issuing_dispute_fraudulent_evidence

{
  "type": "object",
  "title": "IssuingDisputeFraudulentEvidence",
  "properties": {
    "explanation": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Explanation of why the cardholder is disputing this transaction."
    },
    "additional_documentation": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "additional_documentation"
  ]
}

object issuing_dispute_merchandise_not_as_described_evidence

{
  "type": "object",
  "title": "IssuingDisputeMerchandiseNotAsDescribedEvidence",
  "properties": {
    "explanation": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Explanation of why the cardholder is disputing this transaction."
    },
    "received_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Date when the product was received."
    },
    "returned_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Date when the product was returned or attempted to be returned."
    },
    "return_status": {
      "enum": [
        "merchant_rejected",
        "successful"
      ],
      "type": "string",
      "nullable": true,
      "description": "Result of cardholder's attempt to return the product."
    },
    "return_description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Description of the cardholder's attempt to return the product."
    },
    "additional_documentation": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "additional_documentation"
  ]
}

object issuing_dispute_no_valid_authorization_evidence

{
  "type": "object",
  "title": "IssuingDisputeNoValidAuthorizationEvidence",
  "properties": {
    "explanation": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Explanation of why the cardholder is disputing this transaction."
    },
    "additional_documentation": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "additional_documentation"
  ]
}

object issuing_dispute_not_received_evidence

{
  "type": "object",
  "title": "IssuingDisputeNotReceivedEvidence",
  "properties": {
    "expected_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Date when the cardholder expected to receive the product."
    },
    "explanation": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Explanation of why the cardholder is disputing this transaction."
    },
    "product_type": {
      "enum": [
        "merchandise",
        "service"
      ],
      "type": "string",
      "nullable": true,
      "description": "Whether the product was a merchandise or service."
    },
    "product_description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Description of the merchandise or service that was purchased."
    },
    "additional_documentation": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "additional_documentation"
  ]
}

object issuing_dispute_other_evidence

{
  "type": "object",
  "title": "IssuingDisputeOtherEvidence",
  "properties": {
    "explanation": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Explanation of why the cardholder is disputing this transaction."
    },
    "product_type": {
      "enum": [
        "merchandise",
        "service"
      ],
      "type": "string",
      "nullable": true,
      "description": "Whether the product was a merchandise or service."
    },
    "product_description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Description of the merchandise or service that was purchased."
    },
    "additional_documentation": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "additional_documentation"
  ]
}

object issuing_dispute_service_not_as_described_evidence

{
  "type": "object",
  "title": "IssuingDisputeServiceNotAsDescribedEvidence",
  "properties": {
    "canceled_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Date when order was canceled."
    },
    "explanation": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Explanation of why the cardholder is disputing this transaction."
    },
    "received_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Date when the product was received."
    },
    "cancellation_reason": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Reason for canceling the order."
    },
    "additional_documentation": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "additional_documentation"
  ]
}

object issuing_dispute_treasury

{
  "type": "object",
  "title": "IssuingDisputeTreasury",
  "required": [
    "received_debit"
  ],
  "properties": {
    "debit_reversal": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Treasury [DebitReversal](https://docs.stripe.com/api/treasury/debit_reversals) representing this Issuing dispute"
    },
    "received_debit": {
      "type": "string",
      "maxLength": 5000,
      "description": "The Treasury [ReceivedDebit](https://docs.stripe.com/api/treasury/received_debits) that is being disputed."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_network_token_address

{
  "type": "object",
  "title": "IssuingNetworkTokenAddress",
  "required": [
    "line1",
    "postal_code"
  ],
  "properties": {
    "line1": {
      "type": "string",
      "maxLength": 5000,
      "description": "The street address of the cardholder tokenizing the card."
    },
    "postal_code": {
      "type": "string",
      "maxLength": 5000,
      "description": "The postal code of the cardholder tokenizing the card."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_network_token_device

{
  "type": "object",
  "title": "IssuingNetworkTokenDevice",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The name of the device used for tokenization."
    },
    "type": {
      "enum": [
        "other",
        "phone",
        "watch"
      ],
      "type": "string",
      "description": "The type of device used for tokenization."
    },
    "location": {
      "type": "string",
      "maxLength": 5000,
      "description": "The geographic latitude/longitude coordinates of the device at provisioning time. The format is [+-]decimal/[+-]decimal."
    },
    "ip_address": {
      "type": "string",
      "maxLength": 5000,
      "description": "The IP address of the device at provisioning time."
    },
    "phone_number": {
      "type": "string",
      "maxLength": 5000,
      "description": "The phone number of the device used for tokenization."
    },
    "device_fingerprint": {
      "type": "string",
      "maxLength": 5000,
      "description": "An obfuscated ID derived from the device ID."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_network_token_mastercard

{
  "type": "object",
  "title": "IssuingNetworkTokenMastercard",
  "required": [
    "token_reference_id",
    "token_requestor_id"
  ],
  "properties": {
    "card_reference_id": {
      "type": "string",
      "maxLength": 5000,
      "description": "A unique reference ID from MasterCard to represent the card account number."
    },
    "token_reference_id": {
      "type": "string",
      "maxLength": 5000,
      "description": "The network-unique identifier for the token."
    },
    "token_requestor_id": {
      "type": "string",
      "maxLength": 5000,
      "description": "The ID of the entity requesting tokenization, specific to MasterCard."
    },
    "token_requestor_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The name of the entity requesting tokenization, if known. This is directly provided from MasterCard."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_network_token_network_data

{
  "type": "object",
  "title": "IssuingNetworkTokenNetworkData",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "mastercard",
        "visa"
      ],
      "type": "string",
      "description": "The network that the token is associated with. An additional hash is included with a name matching this value, containing tokenization data specific to the card network."
    },
    "visa": {
      "$ref": "#/components/schemas/issuing_network_token_visa"
    },
    "device": {
      "$ref": "#/components/schemas/issuing_network_token_device"
    },
    "mastercard": {
      "$ref": "#/components/schemas/issuing_network_token_mastercard"
    },
    "wallet_provider": {
      "$ref": "#/components/schemas/issuing_network_token_wallet_provider"
    }
  },
  "description": "",
  "x-expandableFields": [
    "device",
    "mastercard",
    "visa",
    "wallet_provider"
  ]
}

object issuing_network_token_visa

{
  "type": "object",
  "title": "IssuingNetworkTokenVisa",
  "required": [
    "token_reference_id",
    "token_requestor_id"
  ],
  "properties": {
    "token_risk_score": {
      "type": "string",
      "maxLength": 5000,
      "description": "Degree of risk associated with the token between `01` and `99`, with higher number indicating higher risk. A `00` value indicates the token was not scored by Visa."
    },
    "card_reference_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A unique reference ID from Visa to represent the card account number."
    },
    "token_reference_id": {
      "type": "string",
      "maxLength": 5000,
      "description": "The network-unique identifier for the token."
    },
    "token_requestor_id": {
      "type": "string",
      "maxLength": 5000,
      "description": "The ID of the entity requesting tokenization, specific to Visa."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_network_token_wallet_provider

{
  "type": "object",
  "title": "IssuingNetworkTokenWalletProvider",
  "properties": {
    "account_id": {
      "type": "string",
      "maxLength": 5000,
      "description": "The wallet provider-given account ID of the digital wallet the token belongs to."
    },
    "reason_codes": {
      "type": "array",
      "items": {
        "enum": [
          "account_card_too_new",
          "account_recently_changed",
          "account_too_new",
          "account_too_new_since_launch",
          "additional_device",
          "data_expired",
          "defer_id_v_decision",
          "device_recently_lost",
          "good_activity_history",
          "has_suspended_tokens",
          "high_risk",
          "inactive_account",
          "long_account_tenure",
          "low_account_score",
          "low_device_score",
          "low_phone_number_score",
          "network_service_error",
          "outside_home_territory",
          "provisioning_cardholder_mismatch",
          "provisioning_device_and_cardholder_mismatch",
          "provisioning_device_mismatch",
          "same_device_no_prior_authentication",
          "same_device_successful_prior_authentication",
          "software_update",
          "suspicious_activity",
          "too_many_different_cardholders",
          "too_many_recent_attempts",
          "too_many_recent_tokens"
        ],
        "type": "string"
      },
      "description": "The reasons for suggested tokenization given by the card network."
    },
    "cardholder_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The name of the cardholder tokenizing the card."
    },
    "card_number_source": {
      "enum": [
        "app",
        "manual",
        "on_file",
        "other"
      ],
      "type": "string",
      "description": "The method used for tokenizing a card."
    },
    "cardholder_address": {
      "$ref": "#/components/schemas/issuing_network_token_address"
    },
    "device_trust_score": {
      "type": "integer",
      "description": "An evaluation on the trustworthiness of the device. A higher score indicates more trustworthy."
    },
    "suggested_decision": {
      "enum": [
        "approve",
        "decline",
        "require_auth"
      ],
      "type": "string",
      "description": "The recommendation on responding to the tokenization request."
    },
    "account_trust_score": {
      "type": "integer",
      "description": "An evaluation on the trustworthiness of the wallet account between 1 and 5. A higher score indicates more trustworthy."
    },
    "suggested_decision_version": {
      "type": "string",
      "maxLength": 5000,
      "description": "The version of the standard for mapping reason codes followed by the wallet provider."
    },
    "hashed_account_email_address": {
      "type": "string",
      "maxLength": 5000,
      "description": "The hashed email address of the cardholder's account with the wallet provider."
    }
  },
  "description": "",
  "x-expandableFields": [
    "cardholder_address"
  ]
}

object issuing_personalization_design_carrier_text

{
  "type": "object",
  "title": "IssuingPersonalizationDesignCarrierText",
  "properties": {
    "footer_body": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The footer body text of the carrier letter."
    },
    "header_body": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The header body text of the carrier letter."
    },
    "footer_title": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The footer title text of the carrier letter."
    },
    "header_title": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The header title text of the carrier letter."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_personalization_design_preferences

{
  "type": "object",
  "title": "IssuingPersonalizationDesignPreferences",
  "required": [
    "is_default"
  ],
  "properties": {
    "is_default": {
      "type": "boolean",
      "description": "Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design."
    },
    "is_platform_default": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether this personalization design is used to create cards when one is not specified and a default for this connected account does not exist."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_personalization_design_rejection_reasons

{
  "type": "object",
  "title": "IssuingPersonalizationDesignRejectionReasons",
  "properties": {
    "card_logo": {
      "type": "array",
      "items": {
        "enum": [
          "geographic_location",
          "inappropriate",
          "network_name",
          "non_binary_image",
          "non_fiat_currency",
          "other",
          "other_entity",
          "promotional_material"
        ],
        "type": "string"
      },
      "nullable": true,
      "description": "The reason(s) the card logo was rejected."
    },
    "carrier_text": {
      "type": "array",
      "items": {
        "enum": [
          "geographic_location",
          "inappropriate",
          "network_name",
          "non_fiat_currency",
          "other",
          "other_entity",
          "promotional_material"
        ],
        "type": "string"
      },
      "nullable": true,
      "description": "The reason(s) the carrier text was rejected."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_physical_bundle_features

{
  "type": "object",
  "title": "IssuingPhysicalBundleFeatures",
  "required": [
    "card_logo",
    "carrier_text",
    "second_line"
  ],
  "properties": {
    "card_logo": {
      "enum": [
        "optional",
        "required",
        "unsupported"
      ],
      "type": "string",
      "description": "The policy for how to use card logo images in a card design with this physical bundle."
    },
    "second_line": {
      "enum": [
        "optional",
        "required",
        "unsupported"
      ],
      "type": "string",
      "description": "The policy for how to use a second line on a card with this physical bundle."
    },
    "carrier_text": {
      "enum": [
        "optional",
        "required",
        "unsupported"
      ],
      "type": "string",
      "description": "The policy for how to use carrier letter text in a card design with this physical bundle."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_transaction_amount_details

{
  "type": "object",
  "title": "IssuingTransactionAmountDetails",
  "properties": {
    "atm_fee": {
      "type": "integer",
      "nullable": true,
      "description": "The fee charged by the ATM for the cash withdrawal."
    },
    "cashback_amount": {
      "type": "integer",
      "nullable": true,
      "description": "The amount of cash requested by the cardholder."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_transaction_fleet_cardholder_prompt_data

{
  "type": "object",
  "title": "IssuingTransactionFleetCardholderPromptData",
  "properties": {
    "user_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "User ID."
    },
    "odometer": {
      "type": "integer",
      "nullable": true,
      "description": "Odometer reading."
    },
    "driver_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Driver ID."
    },
    "unspecified_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type."
    },
    "vehicle_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Vehicle number."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_transaction_fleet_data

{
  "type": "object",
  "title": "IssuingTransactionFleetData",
  "properties": {
    "service_type": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`."
    },
    "purchase_type": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`."
    },
    "reported_breakdown": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_transaction_fleet_reported_breakdown"
        }
      ],
      "nullable": true,
      "description": "More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data."
    },
    "cardholder_prompt_data": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_transaction_fleet_cardholder_prompt_data"
        }
      ],
      "nullable": true,
      "description": "Answers to prompts presented to cardholder at point of sale."
    }
  },
  "description": "",
  "x-expandableFields": [
    "cardholder_prompt_data",
    "reported_breakdown"
  ]
}

object issuing_transaction_fleet_fuel_price_data

{
  "type": "object",
  "title": "IssuingTransactionFleetFuelPriceData",
  "properties": {
    "gross_amount_decimal": {
      "type": "string",
      "format": "decimal",
      "nullable": true,
      "description": "Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_transaction_fleet_non_fuel_price_data

{
  "type": "object",
  "title": "IssuingTransactionFleetNonFuelPriceData",
  "properties": {
    "gross_amount_decimal": {
      "type": "string",
      "format": "decimal",
      "nullable": true,
      "description": "Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_transaction_fleet_reported_breakdown

{
  "type": "object",
  "title": "IssuingTransactionFleetReportedBreakdown",
  "properties": {
    "tax": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_transaction_fleet_tax_data"
        }
      ],
      "nullable": true,
      "description": "Information about tax included in this transaction."
    },
    "fuel": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_transaction_fleet_fuel_price_data"
        }
      ],
      "nullable": true,
      "description": "Breakdown of fuel portion of the purchase."
    },
    "non_fuel": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_transaction_fleet_non_fuel_price_data"
        }
      ],
      "nullable": true,
      "description": "Breakdown of non-fuel portion of the purchase."
    }
  },
  "description": "",
  "x-expandableFields": [
    "fuel",
    "non_fuel",
    "tax"
  ]
}

object issuing_transaction_fleet_tax_data

{
  "type": "object",
  "title": "IssuingTransactionFleetTaxData",
  "properties": {
    "local_amount_decimal": {
      "type": "string",
      "format": "decimal",
      "nullable": true,
      "description": "Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax."
    },
    "national_amount_decimal": {
      "type": "string",
      "format": "decimal",
      "nullable": true,
      "description": "Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_transaction_flight_data

{
  "type": "object",
  "title": "IssuingTransactionFlightData",
  "properties": {
    "segments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/issuing_transaction_flight_data_leg"
      },
      "nullable": true,
      "description": "The legs of the trip."
    },
    "refundable": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether the ticket is refundable."
    },
    "departure_at": {
      "type": "integer",
      "nullable": true,
      "description": "The time that the flight departed."
    },
    "travel_agency": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The travel agency that issued the ticket."
    },
    "passenger_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The name of the passenger."
    }
  },
  "description": "",
  "x-expandableFields": [
    "segments"
  ]
}

object issuing_transaction_flight_data_leg

{
  "type": "object",
  "title": "IssuingTransactionFlightDataLeg",
  "properties": {
    "carrier": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The airline carrier code."
    },
    "flight_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The flight number."
    },
    "service_class": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The flight's service class."
    },
    "stopover_allowed": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether a stopover is allowed on this flight."
    },
    "arrival_airport_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The three-letter IATA airport code of the flight's destination."
    },
    "departure_airport_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The three-letter IATA airport code that the flight departed from."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_transaction_fuel_data

{
  "type": "object",
  "title": "IssuingTransactionFuelData",
  "required": [
    "type",
    "unit",
    "unit_cost_decimal"
  ],
  "properties": {
    "type": {
      "type": "string",
      "maxLength": 5000,
      "description": "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`."
    },
    "unit": {
      "type": "string",
      "maxLength": 5000,
      "description": "The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`."
    },
    "quantity_decimal": {
      "type": "string",
      "format": "decimal",
      "nullable": true,
      "description": "The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places."
    },
    "unit_cost_decimal": {
      "type": "string",
      "format": "decimal",
      "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places."
    },
    "industry_product_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_transaction_lodging_data

{
  "type": "object",
  "title": "IssuingTransactionLodgingData",
  "properties": {
    "nights": {
      "type": "integer",
      "nullable": true,
      "description": "The number of nights stayed at the lodging."
    },
    "check_in_at": {
      "type": "integer",
      "nullable": true,
      "description": "The time of checking into the lodging."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_transaction_network_data

{
  "type": "object",
  "title": "IssuingTransactionNetworkData",
  "properties": {
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions."
    },
    "processing_date": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network."
    },
    "authorization_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter \"S\", followed by a six-digit number. For example, \"S498162\". Please note that the code is not guaranteed to be unique across authorizations."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_transaction_purchase_details

{
  "type": "object",
  "title": "IssuingTransactionPurchaseDetails",
  "properties": {
    "fuel": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_transaction_fuel_data"
        }
      ],
      "nullable": true,
      "description": "Information about fuel that was purchased with this transaction."
    },
    "fleet": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_transaction_fleet_data"
        }
      ],
      "nullable": true,
      "description": "Fleet-specific information for transactions using Fleet cards."
    },
    "flight": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_transaction_flight_data"
        }
      ],
      "nullable": true,
      "description": "Information about the flight that was purchased with this transaction."
    },
    "lodging": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/issuing_transaction_lodging_data"
        }
      ],
      "nullable": true,
      "description": "Information about lodging that was purchased with this transaction."
    },
    "receipt": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/issuing_transaction_receipt_data"
      },
      "nullable": true,
      "description": "The line items in the purchase."
    },
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A merchant-specific order number."
    }
  },
  "description": "",
  "x-expandableFields": [
    "fleet",
    "flight",
    "fuel",
    "lodging",
    "receipt"
  ]
}

object issuing_transaction_receipt_data

{
  "type": "object",
  "title": "IssuingTransactionReceiptData",
  "properties": {
    "total": {
      "type": "integer",
      "nullable": true,
      "description": "The total for this line item in cents."
    },
    "quantity": {
      "type": "number",
      "nullable": true,
      "description": "The quantity of the item."
    },
    "unit_cost": {
      "type": "integer",
      "nullable": true,
      "description": "The unit cost of the item in cents."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The description of the item. The maximum length of this field is 26 characters."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object issuing_transaction_treasury

{
  "type": "object",
  "title": "IssuingTransactionTreasury",
  "properties": {
    "received_debit": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Treasury [ReceivedDebit](https://docs.stripe.com/api/treasury/received_debits) representing this Issuing transaction if it is a capture"
    },
    "received_credit": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Treasury [ReceivedCredit](https://docs.stripe.com/api/treasury/received_credits) representing this Issuing transaction if it is a refund"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object item

{
  "type": "object",
  "title": "LineItem",
  "required": [
    "amount_discount",
    "amount_subtotal",
    "amount_tax",
    "amount_total",
    "currency",
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "price": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/price"
        }
      ],
      "nullable": true,
      "description": "The price used to generate the line item."
    },
    "taxes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/line_items_tax_amount"
      },
      "description": "The taxes applied to the line item."
    },
    "object": {
      "enum": [
        "item"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "quantity": {
      "type": "integer",
      "nullable": true,
      "description": "The quantity of products being purchased."
    },
    "discounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/line_items_discount_amount"
      },
      "description": "The discounts applied to the line item."
    },
    "amount_tax": {
      "type": "integer",
      "description": "Total tax amount applied. If no tax was applied, defaults to 0."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name."
    },
    "amount_total": {
      "type": "integer",
      "description": "Total after discounts and taxes."
    },
    "amount_discount": {
      "type": "integer",
      "description": "Total discount amount applied. If no discounts were applied, defaults to 0."
    },
    "amount_subtotal": {
      "type": "integer",
      "description": "Total before any discounts or taxes are applied."
    },
    "adjustable_quantity": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/line_items_adjustable_quantity"
        }
      ],
      "nullable": true
    }
  },
  "description": "A line item.",
  "x-resourceId": "item",
  "x-expandableFields": [
    "adjustable_quantity",
    "discounts",
    "price",
    "taxes"
  ]
}

object klarna_address

{
  "type": "object",
  "title": "klarna_address",
  "properties": {
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The payer address country"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object klarna_payer_details

{
  "type": "object",
  "title": "klarna_payer_details",
  "properties": {
    "address": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/klarna_address"
        }
      ],
      "nullable": true,
      "description": "The payer's address"
    }
  },
  "description": "",
  "x-expandableFields": [
    "address"
  ]
}

object legal_entity_company

{
  "type": "object",
  "title": "LegalEntityCompany",
  "properties": {
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The company's legal name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`."
    },
    "phone": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The company's phone number (used for verification)."
    },
    "address": {
      "$ref": "#/components/schemas/address"
    },
    "name_kana": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Kana variation of the company's legal name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`."
    },
    "structure": {
      "enum": [
        "free_zone_establishment",
        "free_zone_llc",
        "government_instrumentality",
        "governmental_unit",
        "incorporated_non_profit",
        "incorporated_partnership",
        "limited_liability_partnership",
        "llc",
        "multi_member_llc",
        "private_company",
        "private_corporation",
        "private_partnership",
        "public_company",
        "public_corporation",
        "public_partnership",
        "registered_charity",
        "single_member_llc",
        "sole_establishment",
        "sole_proprietorship",
        "tax_exempt_government_instrumentality",
        "unincorporated_association",
        "unincorporated_non_profit",
        "unincorporated_partnership"
      ],
      "type": "string",
      "description": "The category identifying the legal structure of the company or legal entity. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. See [Business structure](https://docs.stripe.com/connect/identity-verification#business-structure) for more details.",
      "x-stripeBypassValidation": true
    },
    "name_kanji": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Kanji variation of the company's legal name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`."
    },
    "address_kana": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/legal_entity_japan_address"
        }
      ],
      "nullable": true,
      "description": "The Kana variation of the company's primary address (Japan only)."
    },
    "verification": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/legal_entity_company_verification"
        }
      ],
      "nullable": true,
      "description": "Information on the verification state of the company."
    },
    "address_kanji": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/legal_entity_japan_address"
        }
      ],
      "nullable": true,
      "description": "The Kanji variation of the company's primary address (Japan only)."
    },
    "owners_provided": {
      "type": "boolean",
      "description": "Whether the company's owners have been provided. This Boolean will be `true` if you've manually indicated that all owners are provided via [the `owners_provided` parameter](https://docs.stripe.com/api/accounts/update#update_account-company-owners_provided), or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the `percent_ownership` of each owner together)."
    },
    "tax_id_provided": {
      "type": "boolean",
      "description": "Whether the company's business ID number was provided."
    },
    "vat_id_provided": {
      "type": "boolean",
      "description": "Whether the company's business VAT number was provided."
    },
    "tax_id_registrar": {
      "type": "string",
      "maxLength": 5000,
      "description": "The jurisdiction in which the `tax_id` is registered (Germany-based companies only)."
    },
    "export_license_id": {
      "type": "string",
      "maxLength": 5000,
      "description": "The export license ID number of the company, also referred as Import Export Code (India only)."
    },
    "registration_date": {
      "$ref": "#/components/schemas/legal_entity_registration_date"
    },
    "directors_provided": {
      "type": "boolean",
      "description": "Whether the company's directors have been provided. This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` parameter](https://docs.stripe.com/api/accounts/update#update_account-company-directors_provided)."
    },
    "executives_provided": {
      "type": "boolean",
      "description": "Whether the company's executives have been provided. This Boolean will be `true` if you've manually indicated that all executives are provided via [the `executives_provided` parameter](https://docs.stripe.com/api/accounts/update#update_account-company-executives_provided), or if Stripe determined that sufficient executives were provided."
    },
    "export_purpose_code": {
      "type": "string",
      "maxLength": 5000,
      "description": "The purpose code to use for export transactions (India only)."
    },
    "ownership_declaration": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/legal_entity_ubo_declaration"
        }
      ],
      "nullable": true,
      "description": "This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct."
    },
    "directorship_declaration": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/legal_entity_directorship_declaration"
        }
      ],
      "nullable": true,
      "description": "This hash is used to attest that the director information provided to Stripe is both current and correct."
    },
    "ownership_exemption_reason": {
      "enum": [
        "qualified_entity_exceeds_ownership_threshold",
        "qualifies_as_financial_institution"
      ],
      "type": "string",
      "description": "This value is used to determine if a business is exempt from providing ultimate beneficial owners. See [this support article](https://support.stripe.com/questions/exemption-from-providing-ownership-details) and [changelog](https://docs.stripe.com/changelog/acacia/2025-01-27/ownership-exemption-reason-accounts-api) for more details."
    },
    "representative_declaration": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/legal_entity_representative_declaration"
        }
      ],
      "nullable": true,
      "description": "This hash is used to attest that the representative is authorized to act as the representative of their legal entity."
    }
  },
  "description": "",
  "x-expandableFields": [
    "address",
    "address_kana",
    "address_kanji",
    "directorship_declaration",
    "ownership_declaration",
    "registration_date",
    "representative_declaration",
    "verification"
  ]
}

object legal_entity_company_verification

{
  "type": "object",
  "title": "LegalEntityCompanyVerification",
  "required": [
    "document"
  ],
  "properties": {
    "document": {
      "$ref": "#/components/schemas/legal_entity_company_verification_document"
    }
  },
  "description": "",
  "x-expandableFields": [
    "document"
  ]
}

object legal_entity_company_verification_document

{
  "type": "object",
  "title": "LegalEntityCompanyVerificationDocument",
  "properties": {
    "back": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "The back of a document returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `additional_verification`. Note that `additional_verification` files are [not downloadable](/file-upload#uploading-a-file).",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    },
    "front": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "The front of a document returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `additional_verification`. Note that `additional_verification` files are [not downloadable](/file-upload#uploading-a-file).",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    },
    "details": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A user-displayable string describing the verification state of this document."
    },
    "details_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "One of `document_corrupt`, `document_expired`, `document_failed_copy`, `document_failed_greyscale`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_not_readable`, `document_not_uploaded`, `document_type_not_supported`, or `document_too_large`. A machine-readable code specifying the verification state for this document."
    }
  },
  "description": "",
  "x-expandableFields": [
    "back",
    "front"
  ]
}

object legal_entity_directorship_declaration

{
  "type": "object",
  "title": "LegalEntityDirectorshipDeclaration",
  "properties": {
    "ip": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The IP address from which the directorship declaration attestation was made."
    },
    "date": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The Unix timestamp marking when the directorship declaration attestation was made."
    },
    "user_agent": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The user-agent string from the browser where the directorship declaration attestation was made."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object legal_entity_dob

{
  "type": "object",
  "title": "LegalEntityDOB",
  "properties": {
    "day": {
      "type": "integer",
      "nullable": true,
      "description": "The day of birth, between 1 and 31."
    },
    "year": {
      "type": "integer",
      "nullable": true,
      "description": "The four-digit year of birth."
    },
    "month": {
      "type": "integer",
      "nullable": true,
      "description": "The month of birth, between 1 and 12."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object legal_entity_japan_address

{
  "type": "object",
  "title": "LegalEntityJapanAddress",
  "properties": {
    "city": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "City/Ward."
    },
    "town": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Town/cho-me."
    },
    "line1": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Block/Building number."
    },
    "line2": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Building details."
    },
    "state": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Prefecture."
    },
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."
    },
    "postal_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ZIP or postal code."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object legal_entity_person_verification

{
  "type": "object",
  "title": "LegalEntityPersonVerification",
  "required": [
    "status"
  ],
  "properties": {
    "status": {
      "type": "string",
      "maxLength": 5000,
      "description": "The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`. Please refer [guide](https://docs.stripe.com/connect/handling-api-verification) to handle verification updates."
    },
    "details": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A user-displayable string describing the verification state for the person. For example, this may say \"Provided identity information could not be verified\"."
    },
    "document": {
      "$ref": "#/components/schemas/legal_entity_person_verification_document"
    },
    "details_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "One of `document_address_mismatch`, `document_dob_mismatch`, `document_duplicate_type`, `document_id_number_mismatch`, `document_name_mismatch`, `document_nationality_mismatch`, `failed_keyed_identity`, or `failed_other`. A machine-readable code specifying the verification state for the person."
    },
    "additional_document": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/legal_entity_person_verification_document"
        }
      ],
      "nullable": true,
      "description": "A document showing address, either a passport, local ID card, or utility bill from a well-known utility company."
    }
  },
  "description": "",
  "x-expandableFields": [
    "additional_document",
    "document"
  ]
}

object legal_entity_person_verification_document

{
  "type": "object",
  "title": "LegalEntityPersonVerificationDocument",
  "properties": {
    "back": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "The back of an ID returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    },
    "front": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "The front of an ID returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    },
    "details": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say \"Identity document is too unclear to read\"."
    },
    "details_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "One of `document_corrupt`, `document_country_not_supported`, `document_expired`, `document_failed_copy`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_failed_greyscale`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_missing_back`, `document_missing_front`, `document_not_readable`, `document_not_uploaded`, `document_photo_mismatch`, `document_too_large`, or `document_type_not_supported`. A machine-readable code specifying the verification state for this document."
    }
  },
  "description": "",
  "x-expandableFields": [
    "back",
    "front"
  ]
}

object legal_entity_registration_date

{
  "type": "object",
  "title": "LegalEntityRegistrationDate",
  "properties": {
    "day": {
      "type": "integer",
      "nullable": true,
      "description": "The day of registration, between 1 and 31."
    },
    "year": {
      "type": "integer",
      "nullable": true,
      "description": "The four-digit year of registration."
    },
    "month": {
      "type": "integer",
      "nullable": true,
      "description": "The month of registration, between 1 and 12."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object legal_entity_representative_declaration

{
  "type": "object",
  "title": "LegalEntityRepresentativeDeclaration",
  "properties": {
    "ip": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The IP address from which the representative declaration attestation was made."
    },
    "date": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The Unix timestamp marking when the representative declaration attestation was made."
    },
    "user_agent": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The user-agent string from the browser where the representative declaration attestation was made."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object legal_entity_ubo_declaration

{
  "type": "object",
  "title": "LegalEntityUBODeclaration",
  "properties": {
    "ip": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The IP address from which the beneficial owner attestation was made."
    },
    "date": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The Unix timestamp marking when the beneficial owner attestation was made."
    },
    "user_agent": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The user-agent string from the browser where the beneficial owner attestation was made."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object line_item

{
  "type": "object",
  "title": "InvoiceLineItem",
  "required": [
    "amount",
    "currency",
    "discountable",
    "discounts",
    "id",
    "livemode",
    "metadata",
    "object",
    "period",
    "subtotal"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "taxes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billing_bill_resource_invoicing_taxes_tax"
      },
      "nullable": true,
      "description": "The tax information of the line item."
    },
    "amount": {
      "type": "integer",
      "description": "The amount, in cents (or local equivalent)."
    },
    "object": {
      "enum": [
        "line_item"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "parent": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_bill_resource_invoicing_lines_parents_invoice_line_item_parent"
        }
      ],
      "nullable": true,
      "description": "The parent that generated this line item."
    },
    "period": {
      "$ref": "#/components/schemas/invoice_line_item_period"
    },
    "invoice": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The ID of the invoice that contains this line item."
    },
    "pricing": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_bill_resource_invoicing_pricing_pricing"
        }
      ],
      "nullable": true,
      "description": "The pricing information of the line item."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "quantity": {
      "type": "integer",
      "nullable": true,
      "description": "Quantity of units for the invoice line item in integer format, with any decimal precision truncated. For the line item's full-precision decimal quantity, use `quantity_decimal`. This field will be deprecated in favor of `quantity_decimal` in a future version. If the line item is a proration or subscription, the quantity of the subscription that the proration was computed for."
    },
    "subtotal": {
      "type": "integer",
      "description": "The subtotal of the line item, in cents (or local equivalent), before any discounts or taxes."
    },
    "discounts": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 5000
          },
          {
            "$ref": "#/components/schemas/discount"
          }
        ],
        "x-expansionResources": {
          "oneOf": [
            {
              "$ref": "#/components/schemas/discount"
            }
          ]
        }
      },
      "description": "The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An arbitrary string attached to the object. Often useful for displaying to users."
    },
    "discountable": {
      "type": "boolean",
      "description": "If true, discounts will apply to this line item. Always false for prorations."
    },
    "subscription": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/subscription"
        }
      ],
      "nullable": true,
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/subscription"
          }
        ]
      }
    },
    "discount_amounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/discounts_resource_discount_amount"
      },
      "nullable": true,
      "description": "The amount of discount calculated per discount for this line item."
    },
    "quantity_decimal": {
      "type": "string",
      "format": "decimal",
      "nullable": true,
      "description": "Non-negative decimal with at most 12 decimal places. The quantity of units for the line item."
    },
    "pretax_credit_amounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/invoices_resource_pretax_credit_amount"
      },
      "nullable": true,
      "description": "Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this line item."
    }
  },
  "description": "Invoice Line Items represent the individual lines within an [invoice](https://docs.stripe.com/api/invoices) and only exist within the context of an invoice.\n\nEach line item is backed by either an [invoice item](https://docs.stripe.com/api/invoiceitems) or a [subscription item](https://docs.stripe.com/api/subscription_items).",
  "x-resourceId": "line_item",
  "x-expandableFields": [
    "discount_amounts",
    "discounts",
    "parent",
    "period",
    "pretax_credit_amounts",
    "pricing",
    "subscription",
    "taxes"
  ]
}

object line_items_adjustable_quantity

{
  "type": "object",
  "title": "LineItemsAdjustableQuantity",
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "maximum": {
      "type": "integer",
      "nullable": true
    },
    "minimum": {
      "type": "integer",
      "nullable": true
    }
  },
  "description": "",
  "x-expandableFields": []
}

object line_items_discount_amount

{
  "type": "object",
  "title": "LineItemsDiscountAmount",
  "required": [
    "amount",
    "discount"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "The amount discounted."
    },
    "discount": {
      "$ref": "#/components/schemas/discount"
    }
  },
  "description": "",
  "x-expandableFields": [
    "discount"
  ]
}

object line_items_tax_amount

{
  "type": "object",
  "title": "LineItemsTaxAmount",
  "required": [
    "amount",
    "rate"
  ],
  "properties": {
    "rate": {
      "$ref": "#/components/schemas/tax_rate"
    },
    "amount": {
      "type": "integer",
      "description": "Amount of tax applied for this rate."
    },
    "taxable_amount": {
      "type": "integer",
      "nullable": true,
      "description": "The amount on which tax is calculated, in cents (or local equivalent)."
    },
    "taxability_reason": {
      "enum": [
        "customer_exempt",
        "not_collecting",
        "not_subject_to_tax",
        "not_supported",
        "portion_product_exempt",
        "portion_reduced_rated",
        "portion_standard_rated",
        "product_exempt",
        "product_exempt_holiday",
        "proportionally_rated",
        "reduced_rated",
        "reverse_charge",
        "standard_rated",
        "taxable_basis_reduced",
        "zero_rated"
      ],
      "type": "string",
      "nullable": true,
      "description": "The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": [
    "rate"
  ]
}

object linked_account_options_common

{
  "type": "object",
  "title": "linked_account_options_common",
  "properties": {
    "filters": {
      "$ref": "#/components/schemas/payment_flows_private_payment_methods_financial_connections_common_linked_account_options_filters"
    },
    "prefetch": {
      "type": "array",
      "items": {
        "enum": [
          "balances",
          "ownership",
          "transactions"
        ],
        "type": "string",
        "x-stripeBypassValidation": true
      },
      "nullable": true,
      "description": "Data features requested to be retrieved upon account creation."
    },
    "return_url": {
      "type": "string",
      "maxLength": 5000,
      "description": "For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app."
    },
    "permissions": {
      "type": "array",
      "items": {
        "enum": [
          "balances",
          "ownership",
          "payment_method",
          "transactions"
        ],
        "type": "string"
      },
      "description": "The list of permissions to request. The `payment_method` permission must be included."
    }
  },
  "description": "",
  "x-expandableFields": [
    "filters"
  ]
}

object login_link

{
  "type": "object",
  "title": "LoginLink",
  "required": [
    "created",
    "object",
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 5000,
      "description": "The URL for the login link."
    },
    "object": {
      "enum": [
        "login_link"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    }
  },
  "description": "Login Links are single-use URLs that takes an Express account to the login page for their Stripe dashboard.\nA Login Link differs from an [Account Link](https://docs.stripe.com/api/account_links) in that it takes the user directly to their [Express dashboard for the specified account](https://docs.stripe.com/connect/integrate-express-dashboard#create-login-link)",
  "x-resourceId": "login_link",
  "x-expandableFields": []
}

object mandate

{
  "type": "object",
  "title": "Mandate",
  "required": [
    "customer_acceptance",
    "id",
    "livemode",
    "object",
    "payment_method",
    "payment_method_details",
    "status",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "type": {
      "enum": [
        "multi_use",
        "single_use"
      ],
      "type": "string",
      "description": "The type of the mandate."
    },
    "object": {
      "enum": [
        "mandate"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The mandate status indicates whether or not you can use it to initiate a payment."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "multi_use": {
      "$ref": "#/components/schemas/mandate_multi_use"
    },
    "single_use": {
      "$ref": "#/components/schemas/mandate_single_use"
    },
    "on_behalf_of": {
      "type": "string",
      "maxLength": 5000,
      "description": "The account (if any) that the mandate is intended for."
    },
    "payment_method": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_method"
        }
      ],
      "description": "ID of the payment method associated with this mandate.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_method"
          }
        ]
      }
    },
    "customer_acceptance": {
      "$ref": "#/components/schemas/customer_acceptance"
    },
    "payment_method_details": {
      "$ref": "#/components/schemas/mandate_payment_method_details"
    }
  },
  "description": "A Mandate is a record of the permission that your customer gives you to debit their payment method.",
  "x-resourceId": "mandate",
  "x-expandableFields": [
    "customer_acceptance",
    "multi_use",
    "payment_method",
    "payment_method_details",
    "single_use"
  ]
}

object mandate_acss_debit

{
  "type": "object",
  "title": "mandate_acss_debit",
  "required": [
    "payment_schedule",
    "transaction_type"
  ],
  "properties": {
    "default_for": {
      "type": "array",
      "items": {
        "enum": [
          "invoice",
          "subscription"
        ],
        "type": "string"
      },
      "description": "List of Stripe products where this mandate can be selected automatically."
    },
    "payment_schedule": {
      "enum": [
        "combined",
        "interval",
        "sporadic"
      ],
      "type": "string",
      "description": "Payment schedule for the mandate."
    },
    "transaction_type": {
      "enum": [
        "business",
        "personal"
      ],
      "type": "string",
      "description": "Transaction type of the mandate."
    },
    "interval_description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object mandate_amazon_pay

{
  "type": "object",
  "title": "mandate_amazon_pay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object mandate_au_becs_debit

{
  "type": "object",
  "title": "mandate_au_becs_debit",
  "required": [
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 5000,
      "description": "The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object mandate_bacs_debit

{
  "type": "object",
  "title": "mandate_bacs_debit",
  "required": [
    "network_status",
    "reference",
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 5000,
      "description": "The URL that will contain the mandate that the customer has signed."
    },
    "reference": {
      "type": "string",
      "maxLength": 5000,
      "description": "The unique reference identifying the mandate on the Bacs network."
    },
    "display_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The display name for the account on this mandate."
    },
    "network_status": {
      "enum": [
        "accepted",
        "pending",
        "refused",
        "revoked"
      ],
      "type": "string",
      "description": "The status of the mandate on the Bacs network. Can be one of `pending`, `revoked`, `refused`, or `accepted`."
    },
    "revocation_reason": {
      "enum": [
        "account_closed",
        "bank_account_restricted",
        "bank_ownership_changed",
        "could_not_process",
        "debit_not_authorized"
      ],
      "type": "string",
      "nullable": true,
      "description": "When the mandate is revoked on the Bacs network this field displays the reason for the revocation."
    },
    "service_user_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The service user number for the account on this mandate."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object mandate_cashapp

{
  "type": "object",
  "title": "mandate_cashapp",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object mandate_kakao_pay

{
  "type": "object",
  "title": "mandate_kakao_pay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object mandate_klarna

{
  "type": "object",
  "title": "mandate_klarna",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object mandate_kr_card

{
  "type": "object",
  "title": "mandate_kr_card",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object mandate_link

{
  "type": "object",
  "title": "mandate_link",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object mandate_multi_use

{
  "type": "object",
  "title": "mandate_multi_use",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object mandate_naver_pay

{
  "type": "object",
  "title": "mandate_naver_pay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object mandate_nz_bank_account

{
  "type": "object",
  "title": "mandate_nz_bank_account",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object mandate_options_payto

{
  "type": "object",
  "title": "mandate_options_payto",
  "properties": {
    "amount": {
      "type": "integer",
      "nullable": true,
      "description": "Amount that will be collected. It is required when `amount_type` is `fixed`."
    },
    "purpose": {
      "enum": [
        "dependant_support",
        "government",
        "loan",
        "mortgage",
        "other",
        "pension",
        "personal",
        "retail",
        "salary",
        "tax",
        "utility"
      ],
      "type": "string",
      "nullable": true,
      "description": "The purpose for which payments are made. Has a default value based on your merchant category code."
    },
    "end_date": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date."
    },
    "start_date": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time."
    },
    "amount_type": {
      "enum": [
        "fixed",
        "maximum"
      ],
      "type": "string",
      "nullable": true,
      "description": "The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. Defaults to `maximum`."
    },
    "payment_schedule": {
      "enum": [
        "adhoc",
        "annual",
        "daily",
        "fortnightly",
        "monthly",
        "quarterly",
        "semi_annual",
        "weekly"
      ],
      "type": "string",
      "nullable": true,
      "description": "The periodicity at which payments will be collected. Defaults to `adhoc`."
    },
    "payments_per_period": {
      "type": "integer",
      "nullable": true,
      "description": "The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object mandate_options_upi

{
  "type": "object",
  "title": "mandate_options_upi",
  "properties": {
    "amount": {
      "type": "integer",
      "nullable": true,
      "description": "Amount to be charged for future payments."
    },
    "end_date": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "End date of the mandate or subscription."
    },
    "amount_type": {
      "enum": [
        "fixed",
        "maximum"
      ],
      "type": "string",
      "nullable": true,
      "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 20,
      "description": "A description of the mandate or subscription that is meant to be displayed to the customer."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object mandate_payment_method_details

{
  "type": "object",
  "title": "mandate_payment_method_details",
  "required": [
    "type"
  ],
  "properties": {
    "upi": {
      "$ref": "#/components/schemas/mandate_upi"
    },
    "card": {
      "$ref": "#/components/schemas/card_mandate_payment_method_details"
    },
    "link": {
      "$ref": "#/components/schemas/mandate_link"
    },
    "type": {
      "type": "string",
      "maxLength": 5000,
      "description": "This mandate corresponds with a specific payment method type. The `payment_method_details` includes an additional hash with the same name and contains mandate information that's specific to that payment method."
    },
    "payto": {
      "$ref": "#/components/schemas/mandate_payto"
    },
    "klarna": {
      "$ref": "#/components/schemas/mandate_klarna"
    },
    "paypal": {
      "$ref": "#/components/schemas/mandate_paypal"
    },
    "cashapp": {
      "$ref": "#/components/schemas/mandate_cashapp"
    },
    "kr_card": {
      "$ref": "#/components/schemas/mandate_kr_card"
    },
    "kakao_pay": {
      "$ref": "#/components/schemas/mandate_kakao_pay"
    },
    "naver_pay": {
      "$ref": "#/components/schemas/mandate_naver_pay"
    },
    "acss_debit": {
      "$ref": "#/components/schemas/mandate_acss_debit"
    },
    "amazon_pay": {
      "$ref": "#/components/schemas/mandate_amazon_pay"
    },
    "bacs_debit": {
      "$ref": "#/components/schemas/mandate_bacs_debit"
    },
    "sepa_debit": {
      "$ref": "#/components/schemas/mandate_sepa_debit"
    },
    "revolut_pay": {
      "$ref": "#/components/schemas/mandate_revolut_pay"
    },
    "au_becs_debit": {
      "$ref": "#/components/schemas/mandate_au_becs_debit"
    },
    "nz_bank_account": {
      "$ref": "#/components/schemas/mandate_nz_bank_account"
    },
    "us_bank_account": {
      "$ref": "#/components/schemas/mandate_us_bank_account"
    }
  },
  "description": "",
  "x-expandableFields": [
    "acss_debit",
    "amazon_pay",
    "au_becs_debit",
    "bacs_debit",
    "card",
    "cashapp",
    "kakao_pay",
    "klarna",
    "kr_card",
    "link",
    "naver_pay",
    "nz_bank_account",
    "paypal",
    "payto",
    "revolut_pay",
    "sepa_debit",
    "upi",
    "us_bank_account"
  ]
}

object mandate_paypal

{
  "type": "object",
  "title": "mandate_paypal",
  "properties": {
    "payer_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "PayPal account PayerID. This identifier uniquely identifies the PayPal customer."
    },
    "billing_agreement_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object mandate_payto

{
  "type": "object",
  "title": "mandate_payto",
  "required": [
    "amount_type",
    "payment_schedule"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "nullable": true,
      "description": "Amount that will be collected. It is required when `amount_type` is `fixed`."
    },
    "purpose": {
      "enum": [
        "dependant_support",
        "government",
        "loan",
        "mortgage",
        "other",
        "pension",
        "personal",
        "retail",
        "salary",
        "tax",
        "utility"
      ],
      "type": "string",
      "nullable": true,
      "description": "The purpose for which payments are made. Has a default value based on your merchant category code."
    },
    "end_date": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date."
    },
    "start_date": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time."
    },
    "amount_type": {
      "enum": [
        "fixed",
        "maximum"
      ],
      "type": "string",
      "description": "The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. Defaults to `maximum`."
    },
    "payment_schedule": {
      "enum": [
        "adhoc",
        "annual",
        "daily",
        "fortnightly",
        "monthly",
        "quarterly",
        "semi_annual",
        "weekly"
      ],
      "type": "string",
      "description": "The periodicity at which payments will be collected. Defaults to `adhoc`."
    },
    "payments_per_period": {
      "type": "integer",
      "nullable": true,
      "description": "The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object mandate_revolut_pay

{
  "type": "object",
  "title": "mandate_revolut_pay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object mandate_sepa_debit

{
  "type": "object",
  "title": "mandate_sepa_debit",
  "required": [
    "reference",
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 5000,
      "description": "The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively."
    },
    "reference": {
      "type": "string",
      "maxLength": 5000,
      "description": "The unique reference of the mandate."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object mandate_single_use

{
  "type": "object",
  "title": "mandate_single_use",
  "required": [
    "amount",
    "currency"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "The amount of the payment on a single use mandate."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "The currency of the payment on a single use mandate."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object mandate_upi

{
  "type": "object",
  "title": "mandate_upi",
  "properties": {
    "amount": {
      "type": "integer",
      "nullable": true,
      "description": "Amount to be charged for future payments."
    },
    "end_date": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "End date of the mandate or subscription."
    },
    "amount_type": {
      "enum": [
        "fixed",
        "maximum"
      ],
      "type": "string",
      "nullable": true,
      "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 20,
      "description": "A description of the mandate or subscription that is meant to be displayed to the customer."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object mandate_us_bank_account

{
  "type": "object",
  "title": "mandate_us_bank_account",
  "properties": {
    "collection_method": {
      "enum": [
        "paper"
      ],
      "type": "string",
      "description": "Mandate collection method",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": []
}

object networks

{
  "type": "object",
  "title": "networks",
  "required": [
    "available"
  ],
  "properties": {
    "available": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "All networks available for selection via [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network)."
    },
    "preferred": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object notification_event_data

{
  "type": "object",
  "title": "NotificationEventData",
  "required": [
    "object"
  ],
  "properties": {
    "object": {
      "type": "object",
      "description": "Object containing the API resource relevant to the event. For example, an `invoice.created` event will have a full [invoice object](https://api.stripe.com#invoice_object) as the value of the object key."
    },
    "previous_attributes": {
      "type": "object",
      "description": "Object containing the names of the updated attributes and their values prior to the event (only included in events of type `*.updated`). If an array attribute has any updated elements, this object contains the entire array. In Stripe API versions 2017-04-06 or earlier, an updated array attribute in this object includes only the updated array elements."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object notification_event_request

{
  "type": "object",
  "title": "NotificationEventRequest",
  "properties": {
    "id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API."
    },
    "idempotency_key": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The idempotency key transmitted during the request, if any. *Note: This property is populated only for events on or after May 23, 2017*."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object offline_acceptance

{
  "type": "object",
  "title": "offline_acceptance",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object online_acceptance

{
  "type": "object",
  "title": "online_acceptance",
  "properties": {
    "ip_address": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The customer accepts the mandate from this IP address."
    },
    "user_agent": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The customer accepts the mandate using the user agent of the browser."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object outbound_payments_payment_method_details

{
  "type": "object",
  "title": "OutboundPaymentsPaymentMethodDetails",
  "required": [
    "billing_details",
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "financial_account",
        "us_bank_account"
      ],
      "type": "string",
      "description": "The type of the payment method used in the OutboundPayment.",
      "x-stripeBypassValidation": true
    },
    "billing_details": {
      "$ref": "#/components/schemas/treasury_shared_resource_billing_details"
    },
    "us_bank_account": {
      "$ref": "#/components/schemas/outbound_payments_payment_method_details_us_bank_account"
    },
    "financial_account": {
      "$ref": "#/components/schemas/outbound_payments_payment_method_details_financial_account"
    }
  },
  "description": "",
  "x-expandableFields": [
    "billing_details",
    "financial_account",
    "us_bank_account"
  ]
}

object outbound_payments_payment_method_details_financial_account

{
  "type": "object",
  "title": "outbound_payments_payment_method_details_financial_account",
  "required": [
    "id",
    "network"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Token of the FinancialAccount."
    },
    "network": {
      "enum": [
        "stripe"
      ],
      "type": "string",
      "description": "The rails used to send funds."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object outbound_payments_payment_method_details_us_bank_account

{
  "type": "object",
  "title": "outbound_payments_payment_method_details_us_bank_account",
  "required": [
    "network"
  ],
  "properties": {
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last four digits of the bank account number."
    },
    "mandate": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/mandate"
        }
      ],
      "description": "ID of the mandate used to make this payment.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/mandate"
          }
        ]
      }
    },
    "network": {
      "enum": [
        "ach",
        "us_domestic_wire"
      ],
      "type": "string",
      "description": "The network rails used. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type."
    },
    "bank_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Name of the bank associated with the bank account."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."
    },
    "account_type": {
      "enum": [
        "checking",
        "savings"
      ],
      "type": "string",
      "nullable": true,
      "description": "Account type: checkings or savings. Defaults to checking if omitted."
    },
    "routing_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Routing number of the bank account."
    },
    "account_holder_type": {
      "enum": [
        "company",
        "individual"
      ],
      "type": "string",
      "nullable": true,
      "description": "Account holder type: individual or company."
    }
  },
  "description": "",
  "x-expandableFields": [
    "mandate"
  ]
}

object outbound_transfers_payment_method_details

{
  "type": "object",
  "title": "OutboundTransfersPaymentMethodDetails",
  "required": [
    "billing_details",
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "financial_account",
        "us_bank_account"
      ],
      "type": "string",
      "description": "The type of the payment method used in the OutboundTransfer."
    },
    "billing_details": {
      "$ref": "#/components/schemas/treasury_shared_resource_billing_details"
    },
    "us_bank_account": {
      "$ref": "#/components/schemas/outbound_transfers_payment_method_details_us_bank_account"
    },
    "financial_account": {
      "$ref": "#/components/schemas/outbound_transfers_payment_method_details_financial_account"
    }
  },
  "description": "",
  "x-expandableFields": [
    "billing_details",
    "financial_account",
    "us_bank_account"
  ]
}

object outbound_transfers_payment_method_details_financial_account

{
  "type": "object",
  "title": "outbound_transfers_payment_method_details_financial_account",
  "required": [
    "id",
    "network"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Token of the FinancialAccount."
    },
    "network": {
      "enum": [
        "stripe"
      ],
      "type": "string",
      "description": "The rails used to send funds."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object outbound_transfers_payment_method_details_us_bank_account

{
  "type": "object",
  "title": "outbound_transfers_payment_method_details_us_bank_account",
  "required": [
    "network"
  ],
  "properties": {
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last four digits of the bank account number."
    },
    "mandate": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/mandate"
        }
      ],
      "description": "ID of the mandate used to make this payment.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/mandate"
          }
        ]
      }
    },
    "network": {
      "enum": [
        "ach",
        "us_domestic_wire"
      ],
      "type": "string",
      "description": "The network rails used. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type."
    },
    "bank_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Name of the bank associated with the bank account."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."
    },
    "account_type": {
      "enum": [
        "checking",
        "savings"
      ],
      "type": "string",
      "nullable": true,
      "description": "Account type: checkings or savings. Defaults to checking if omitted."
    },
    "routing_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Routing number of the bank account."
    },
    "account_holder_type": {
      "enum": [
        "company",
        "individual"
      ],
      "type": "string",
      "nullable": true,
      "description": "Account holder type: individual or company."
    }
  },
  "description": "",
  "x-expandableFields": [
    "mandate"
  ]
}

object package_dimensions

{
  "type": "object",
  "title": "PackageDimensions",
  "required": [
    "height",
    "length",
    "weight",
    "width"
  ],
  "properties": {
    "width": {
      "type": "number",
      "description": "Width, in inches."
    },
    "height": {
      "type": "number",
      "description": "Height, in inches."
    },
    "length": {
      "type": "number",
      "description": "Length, in inches."
    },
    "weight": {
      "type": "number",
      "description": "Weight, in ounces."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_attempt_record

{
  "type": "object",
  "title": "PaymentAttemptRecord",
  "required": [
    "amount",
    "amount_authorized",
    "amount_canceled",
    "amount_failed",
    "amount_guaranteed",
    "amount_refunded",
    "amount_requested",
    "created",
    "id",
    "livemode",
    "metadata",
    "object",
    "processor_details",
    "reported_by"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "amount": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount"
    },
    "object": {
      "enum": [
        "payment_attempt_record"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "application": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the Connect application that created the PaymentAttemptRecord."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An arbitrary string attached to the object. Often useful for displaying to users."
    },
    "reported_by": {
      "enum": [
        "self",
        "stripe"
      ],
      "type": "string",
      "description": "Indicates who reported the payment."
    },
    "amount_failed": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount"
    },
    "payment_record": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the Payment Record this Payment Attempt Record belongs to."
    },
    "amount_canceled": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount"
    },
    "amount_refunded": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount"
    },
    "amount_requested": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount"
    },
    "customer_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payments_primitives_payment_records_resource_customer_details"
        }
      ],
      "nullable": true,
      "description": "Customer information for this payment."
    },
    "shipping_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payments_primitives_payment_records_resource_shipping_details"
        }
      ],
      "nullable": true,
      "description": "Shipping information for this payment."
    },
    "amount_authorized": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount"
    },
    "amount_guaranteed": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount"
    },
    "customer_presence": {
      "enum": [
        "off_session",
        "on_session"
      ],
      "type": "string",
      "nullable": true,
      "description": "Indicates whether the customer was present in your checkout flow during this payment."
    },
    "processor_details": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_processor_details"
    },
    "payment_method_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_details"
        }
      ],
      "nullable": true,
      "description": "Information about the Payment Method debited for this payment."
    }
  },
  "description": "A Payment Attempt Record represents an individual attempt at making a payment, on or off Stripe.\nEach payment attempt tries to collect a fixed amount of money from a fixed customer and payment\nmethod. Payment Attempt Records are attached to Payment Records. Only one attempt per Payment Record\ncan have guaranteed funds.",
  "x-resourceId": "payment_attempt_record",
  "x-expandableFields": [
    "amount",
    "amount_authorized",
    "amount_canceled",
    "amount_failed",
    "amount_guaranteed",
    "amount_refunded",
    "amount_requested",
    "customer_details",
    "payment_method_details",
    "processor_details",
    "shipping_details"
  ]
}

object payment_flows_amount_details

{
  "type": "object",
  "title": "PaymentFlowsAmountDetails",
  "properties": {
    "tax": {
      "$ref": "#/components/schemas/payment_flows_amount_details_resource_tax"
    },
    "tip": {
      "$ref": "#/components/schemas/payment_flows_amount_details_client_resource_tip"
    },
    "error": {
      "$ref": "#/components/schemas/payment_flows_amount_details_resource_error"
    },
    "shipping": {
      "$ref": "#/components/schemas/payment_flows_amount_details_resource_shipping"
    },
    "line_items": {
      "type": "object",
      "title": "PaymentFlowsAmountDetailsResourceLineItemsList",
      "required": [
        "data",
        "has_more",
        "object",
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "maxLength": 5000,
          "description": "The URL where this list can be accessed."
        },
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/payment_intent_amount_details_line_item"
          },
          "description": "Details about each object."
        },
        "object": {
          "enum": [
            "list"
          ],
          "type": "string",
          "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
        },
        "has_more": {
          "type": "boolean",
          "description": "True if this list has another page of items after this one that can be fetched."
        }
      },
      "description": "A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 200 line items.",
      "x-expandableFields": [
        "data"
      ]
    },
    "discount_amount": {
      "type": "integer",
      "description": "The total discount applied on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0.\n\nThis field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field."
    }
  },
  "description": "",
  "x-expandableFields": [
    "error",
    "line_items",
    "shipping",
    "tax",
    "tip"
  ]
}

object payment_flows_amount_details_client

{
  "type": "object",
  "title": "PaymentFlowsAmountDetailsClient",
  "properties": {
    "tip": {
      "$ref": "#/components/schemas/payment_flows_amount_details_client_resource_tip"
    }
  },
  "description": "",
  "x-expandableFields": [
    "tip"
  ]
}

object payment_flows_amount_details_client_resource_tip

{
  "type": "object",
  "title": "PaymentFlowsAmountDetailsClientResourceTip",
  "properties": {
    "amount": {
      "type": "integer",
      "description": "Portion of the amount that corresponds to a tip."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_flows_amount_details_resource_error

{
  "type": "object",
  "title": "PaymentFlowsAmountDetailsResourceError",
  "properties": {
    "code": {
      "enum": [
        "amount_details_amount_mismatch",
        "amount_details_tax_shipping_discount_greater_than_amount"
      ],
      "type": "string",
      "nullable": true,
      "description": "The code of the error that occurred when validating the current amount details."
    },
    "message": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A message providing more details about the error."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_flows_amount_details_resource_line_items_list_resource_line_item_resource_payment_method_options

{
  "type": "object",
  "title": "PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItemResourcePaymentMethodOptions",
  "properties": {
    "card": {
      "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_payment_intent_amount_details_line_item_payment_method_options"
    },
    "klarna": {
      "$ref": "#/components/schemas/payment_flows_private_payment_methods_klarna_payment_intent_amount_details_line_item_payment_method_options"
    },
    "paypal": {
      "$ref": "#/components/schemas/payment_flows_private_payment_methods_paypal_amount_details_line_item_payment_method_options"
    },
    "card_present": {
      "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_present_amount_details_line_item_payment_method_options"
    }
  },
  "description": "",
  "x-expandableFields": [
    "card",
    "card_present",
    "klarna",
    "paypal"
  ]
}

object payment_flows_amount_details_resource_line_items_list_resource_line_item_resource_tax

{
  "type": "object",
  "title": "PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItemResourceTax",
  "required": [
    "total_tax_amount"
  ],
  "properties": {
    "total_tax_amount": {
      "type": "integer",
      "description": "The total amount of tax on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0.\n\nThis field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_flows_amount_details_resource_shipping

{
  "type": "object",
  "title": "PaymentFlowsAmountDetailsResourceShipping",
  "properties": {
    "amount": {
      "type": "integer",
      "nullable": true,
      "description": "If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than or equal to 0."
    },
    "to_postal_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens are allowed."
    },
    "from_postal_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens are allowed."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_flows_amount_details_resource_tax

{
  "type": "object",
  "title": "PaymentFlowsAmountDetailsResourceTax",
  "properties": {
    "total_tax_amount": {
      "type": "integer",
      "nullable": true,
      "description": "The total amount of tax on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0.\n\nThis field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_flows_automatic_payment_methods_payment_intent

{
  "type": "object",
  "title": "PaymentFlowsAutomaticPaymentMethodsPaymentIntent",
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Automatically calculates compatible payment methods"
    },
    "allow_redirects": {
      "enum": [
        "always",
        "never"
      ],
      "type": "string",
      "description": "Controls whether this PaymentIntent will accept redirect-based payment methods.\n\nRedirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://docs.stripe.com/api/payment_intents/confirm) this PaymentIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the payment."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_flows_automatic_payment_methods_setup_intent

{
  "type": "object",
  "title": "PaymentFlowsAutomaticPaymentMethodsSetupIntent",
  "properties": {
    "enabled": {
      "type": "boolean",
      "nullable": true,
      "description": "Automatically calculates compatible payment methods"
    },
    "allow_redirects": {
      "enum": [
        "always",
        "never"
      ],
      "type": "string",
      "description": "Controls whether this SetupIntent will accept redirect-based payment methods.\n\nRedirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://docs.stripe.com/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_flows_installment_options

{
  "type": "object",
  "title": "PaymentFlowsInstallmentOptions",
  "required": [
    "enabled"
  ],
  "properties": {
    "plan": {
      "$ref": "#/components/schemas/payment_method_details_card_installments_plan"
    },
    "enabled": {
      "type": "boolean"
    }
  },
  "description": "",
  "x-expandableFields": [
    "plan"
  ]
}

object payment_flows_payment_details

{
  "type": "object",
  "title": "PaymentFlowsPaymentDetails",
  "properties": {
    "order_reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates.\n\nFor Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app."
    },
    "customer_reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A unique value to identify the customer. This field is available only for card payments.\n\nThis field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_flows_payment_intent_async_workflows

{
  "type": "object",
  "title": "PaymentFlowsPaymentIntentAsyncWorkflows",
  "properties": {
    "inputs": {
      "$ref": "#/components/schemas/payment_flows_payment_intent_async_workflows_resource_inputs"
    }
  },
  "description": "",
  "x-expandableFields": [
    "inputs"
  ]
}

object payment_flows_payment_intent_async_workflows_resource_inputs

{
  "type": "object",
  "title": "PaymentFlowsPaymentIntentAsyncWorkflowsResourceInputs",
  "properties": {
    "tax": {
      "$ref": "#/components/schemas/payment_flows_payment_intent_async_workflows_resource_inputs_resource_tax"
    }
  },
  "description": "",
  "x-expandableFields": [
    "tax"
  ]
}

object payment_flows_payment_intent_async_workflows_resource_inputs_resource_tax

{
  "type": "object",
  "title": "PaymentFlowsPaymentIntentAsyncWorkflowsResourceInputsResourceTax",
  "required": [
    "calculation"
  ],
  "properties": {
    "calculation": {
      "type": "string",
      "maxLength": 5000,
      "description": "The [TaxCalculation](https://docs.stripe.com/api/tax/calculations) id"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_flows_payment_intent_presentment_details

{
  "type": "object",
  "title": "PaymentFlowsPaymentIntentPresentmentDetails",
  "required": [
    "presentment_amount",
    "presentment_currency"
  ],
  "properties": {
    "presentment_amount": {
      "type": "integer",
      "description": "Amount intended to be collected by this payment, denominated in `presentment_currency`."
    },
    "presentment_currency": {
      "type": "string",
      "maxLength": 5000,
      "description": "Currency presented to the customer during payment."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_flows_private_payment_methods_alipay

{
  "type": "object",
  "title": "PaymentFlowsPrivatePaymentMethodsAlipay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_flows_private_payment_methods_alipay_details

{
  "type": "object",
  "title": "PaymentFlowsPrivatePaymentMethodsAlipayDetails",
  "properties": {
    "buyer_id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same."
    },
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Transaction ID of this particular Alipay transaction."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object

payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_extended_authorization_extended_authorization

{
  "type": "object",
  "title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesExtendedAuthorizationExtendedAuthorization",
  "required": [
    "status"
  ],
  "properties": {
    "status": {
      "enum": [
        "disabled",
        "enabled"
      ],
      "type": "string",
      "description": "Indicates whether or not the capture window is extended beyond the standard authorization."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object

payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_incremental_authorization_incremental_authorization

{
  "type": "object",
  "title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesIncrementalAuthorizationIncrementalAuthorization",
  "required": [
    "status"
  ],
  "properties": {
    "status": {
      "enum": [
        "available",
        "unavailable"
      ],
      "type": "string",
      "description": "Indicates whether or not the incremental authorization feature is supported."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_overcapture_overcapture

{
  "type": "object",
  "title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesOvercaptureOvercapture",
  "required": [
    "maximum_amount_capturable",
    "status"
  ],
  "properties": {
    "status": {
      "enum": [
        "available",
        "unavailable"
      ],
      "type": "string",
      "description": "Indicates whether or not the authorized amount can be over-captured."
    },
    "maximum_amount_capturable": {
      "type": "integer",
      "description": "The maximum amount that can be captured."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_flows_private_payment_methods_card_details_api_resource_multicapture

{
  "type": "object",
  "title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceMulticapture",
  "required": [
    "status"
  ],
  "properties": {
    "status": {
      "enum": [
        "available",
        "unavailable"
      ],
      "type": "string",
      "description": "Indicates whether or not multiple captures are supported."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_flows_private_payment_methods_card_payment_intent_amount_details_line_item_payment_method_options

{
  "type": "object",
  "title": "PaymentFlowsPrivatePaymentMethodsCardPaymentIntentAmountDetailsLineItemPaymentMethodOptions",
  "properties": {
    "commodity_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_flows_private_payment_methods_card_present_amount_details_line_item_payment_method_options

{
  "type": "object",
  "title": "PaymentFlowsPrivatePaymentMethodsCardPresentAmountDetailsLineItemPaymentMethodOptions",
  "properties": {
    "commodity_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_flows_private_payment_methods_card_present_common_wallet

{
  "type": "object",
  "title": "PaymentFlowsPrivatePaymentMethodsCardPresentCommonWallet",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "apple_pay",
        "google_pay",
        "samsung_pay",
        "unknown"
      ],
      "type": "string",
      "description": "The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_flows_private_payment_methods_financial_connections_common_linked_account_options_filters

{
  "type": "object",
  "title": "PaymentFlowsPrivatePaymentMethodsFinancialConnectionsCommonLinkedAccountOptionsFilters",
  "properties": {
    "account_subcategories": {
      "type": "array",
      "items": {
        "enum": [
          "checking",
          "savings"
        ],
        "type": "string"
      },
      "description": "The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_flows_private_payment_methods_kakao_pay_payment_method_options

{
  "type": "object",
  "title": "PaymentFlowsPrivatePaymentMethodsKakaoPayPaymentMethodOptions",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_flows_private_payment_methods_klarna_dob

{
  "type": "object",
  "title": "PaymentFlowsPrivatePaymentMethodsKlarnaDOB",
  "properties": {
    "day": {
      "type": "integer",
      "nullable": true,
      "description": "The day of birth, between 1 and 31."
    },
    "year": {
      "type": "integer",
      "nullable": true,
      "description": "The four-digit year of birth."
    },
    "month": {
      "type": "integer",
      "nullable": true,
      "description": "The month of birth, between 1 and 12."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_flows_private_payment_methods_klarna_payment_intent_amount_details_line_item_payment_method_options

{
  "type": "object",
  "title": "PaymentFlowsPrivatePaymentMethodsKlarnaPaymentIntentAmountDetailsLineItemPaymentMethodOptions",
  "properties": {
    "image_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 2048
    },
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 255
    },
    "product_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 2048
    },
    "subscription_reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 2048
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_flows_private_payment_methods_naver_pay_payment_method_options

{
  "type": "object",
  "title": "PaymentFlowsPrivatePaymentMethodsNaverPayPaymentMethodOptions",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_flows_private_payment_methods_payco_payment_method_options

{
  "type": "object",
  "title": "PaymentFlowsPrivatePaymentMethodsPaycoPaymentMethodOptions",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_flows_private_payment_methods_paypal_amount_details_line_item_payment_method_options

{
  "type": "object",
  "title": "PaymentFlowsPrivatePaymentMethodsPaypalAmountDetailsLineItemPaymentMethodOptions",
  "properties": {
    "sold_by": {
      "type": "string",
      "maxLength": 5000,
      "description": "The Stripe account ID of the connected account that sells the item. This is only needed when using [Separate Charges and Transfers](https://docs.stripe.com/connect/separate-charges-and-transfers)."
    },
    "category": {
      "enum": [
        "digital_goods",
        "donation",
        "physical_goods"
      ],
      "type": "string",
      "description": "Type of the line item."
    },
    "description": {
      "type": "string",
      "maxLength": 5000,
      "description": "Description of the line item."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_flows_private_payment_methods_samsung_pay_payment_method_options

{
  "type": "object",
  "title": "PaymentFlowsPrivatePaymentMethodsSamsungPayPaymentMethodOptions",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent

{
  "type": "object",
  "title": "PaymentIntent",
  "required": [
    "created",
    "id",
    "livemode",
    "object",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "hooks": {
      "$ref": "#/components/schemas/payment_flows_payment_intent_async_workflows"
    },
    "amount": {
      "type": "integer",
      "description": "Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99)."
    },
    "object": {
      "enum": [
        "payment_intent"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "review": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/review"
        }
      ],
      "nullable": true,
      "description": "ID of the review associated with this PaymentIntent, if any.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/review"
          }
        ]
      }
    },
    "status": {
      "enum": [
        "canceled",
        "processing",
        "requires_action",
        "requires_capture",
        "requires_confirmation",
        "requires_payment_method",
        "succeeded"
      ],
      "type": "string",
      "description": "Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://docs.stripe.com/payments/intents#intent-statuses).",
      "x-stripeBypassValidation": true
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        },
        {
          "$ref": "#/components/schemas/deleted_customer"
        }
      ],
      "nullable": true,
      "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          },
          {
            "$ref": "#/components/schemas/deleted_customer"
          }
        ]
      }
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Learn more about [storing information in metadata](https://docs.stripe.com/payments/payment-intents/creating-payment-intents#storing-information-in-metadata).",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "shipping": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/shipping"
        }
      ],
      "nullable": true,
      "description": "Shipping information for this PaymentIntent."
    },
    "processing": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_intent_processing"
        }
      ],
      "nullable": true,
      "description": "If present, this property tells you about the processing state of the payment."
    },
    "application": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/application"
        }
      ],
      "nullable": true,
      "description": "ID of the Connect application that created the PaymentIntent.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/application"
          }
        ]
      }
    },
    "canceled_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An arbitrary string attached to the object. Often useful for displaying to users."
    },
    "next_action": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_intent_next_action"
        }
      ],
      "nullable": true,
      "description": "If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source."
    },
    "on_behalf_of": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/account"
        }
      ],
      "nullable": true,
      "description": "You can specify the settlement merchant as the\nconnected account using the `on_behalf_of` attribute on the charge. See the PaymentIntents [use case for connected accounts](/payments/connected-accounts) for details.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/account"
          }
        ]
      }
    },
    "client_secret": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. \n\nThe client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.\n\nRefer to our docs to [accept a payment](https://docs.stripe.com/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled."
    },
    "latest_charge": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/charge"
        }
      ],
      "nullable": true,
      "description": "ID of the latest [Charge object](https://docs.stripe.com/api/charges) created by this PaymentIntent. This property is `null` until PaymentIntent confirmation is attempted.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/charge"
          }
        ]
      }
    },
    "receipt_email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails)."
    },
    "transfer_data": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/transfer_data"
        }
      ],
      "nullable": true,
      "description": "The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts)."
    },
    "amount_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_flows_amount_details"
        },
        {
          "$ref": "#/components/schemas/payment_flows_amount_details_client"
        }
      ]
    },
    "capture_method": {
      "enum": [
        "automatic",
        "automatic_async",
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    },
    "payment_method": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_method"
        }
      ],
      "nullable": true,
      "description": "ID of the payment method used in this PaymentIntent.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_method"
          }
        ]
      }
    },
    "transfer_group": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers)."
    },
    "amount_received": {
      "type": "integer",
      "description": "Amount that this PaymentIntent collects."
    },
    "payment_details": {
      "$ref": "#/components/schemas/payment_flows_payment_details"
    },
    "customer_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the Account representing the customer that this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Accounts cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Account instead."
    },
    "amount_capturable": {
      "type": "integer",
      "description": "Amount that can be captured from this PaymentIntent."
    },
    "last_payment_error": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/api_errors"
        }
      ],
      "nullable": true,
      "description": "The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason."
    },
    "setup_future_usage": {
      "enum": [
        "off_session",
        "on_session"
      ],
      "type": "string",
      "nullable": true,
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    },
    "cancellation_reason": {
      "enum": [
        "abandoned",
        "automatic",
        "duplicate",
        "expired",
        "failed_invoice",
        "fraudulent",
        "requested_by_customer",
        "void_invoice"
      ],
      "type": "string",
      "nullable": true,
      "description": "Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, `automatic`, or `expired`)."
    },
    "confirmation_method": {
      "enum": [
        "automatic",
        "manual"
      ],
      "type": "string",
      "description": "Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment."
    },
    "presentment_details": {
      "$ref": "#/components/schemas/payment_flows_payment_intent_presentment_details"
    },
    "payment_method_types": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. A comprehensive list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type)."
    },
    "statement_descriptor": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead."
    },
    "application_fee_amount": {
      "type": "integer",
      "nullable": true,
      "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts)."
    },
    "payment_method_options": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_intent_payment_method_options"
        }
      ],
      "nullable": true,
      "description": "Payment-method-specific configuration for this PaymentIntent."
    },
    "automatic_payment_methods": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_flows_automatic_payment_methods_payment_intent"
        }
      ],
      "nullable": true,
      "description": "Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods)"
    },
    "statement_descriptor_suffix": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement."
    },
    "excluded_payment_method_types": {
      "type": "array",
      "items": {
        "enum": [
          "acss_debit",
          "affirm",
          "afterpay_clearpay",
          "alipay",
          "alma",
          "amazon_pay",
          "au_becs_debit",
          "bacs_debit",
          "bancontact",
          "billie",
          "blik",
          "boleto",
          "card",
          "cashapp",
          "crypto",
          "customer_balance",
          "eps",
          "fpx",
          "giropay",
          "grabpay",
          "ideal",
          "kakao_pay",
          "klarna",
          "konbini",
          "kr_card",
          "mb_way",
          "mobilepay",
          "multibanco",
          "naver_pay",
          "nz_bank_account",
          "oxxo",
          "p24",
          "pay_by_bank",
          "payco",
          "paynow",
          "paypal",
          "payto",
          "pix",
          "promptpay",
          "revolut_pay",
          "samsung_pay",
          "satispay",
          "sepa_debit",
          "sofort",
          "swish",
          "twint",
          "upi",
          "us_bank_account",
          "wechat_pay",
          "zip"
        ],
        "type": "string",
        "x-stripeBypassValidation": true
      },
      "nullable": true,
      "description": "The list of payment method types to exclude from use with this payment."
    },
    "payment_method_configuration_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_config_biz_payment_method_configuration_details"
        }
      ],
      "nullable": true,
      "description": "Information about the [payment method configuration](https://docs.stripe.com/api/payment_method_configurations) used for this PaymentIntent."
    }
  },
  "description": "A PaymentIntent guides you through the process of collecting a payment from your customer.\nWe recommend that you create exactly one PaymentIntent for each order or\ncustomer session in your system. You can reference the PaymentIntent later to\nsee the history of payment attempts for a particular session.\n\nA PaymentIntent transitions through\n[multiple statuses](/payments/paymentintents/lifecycle)\nthroughout its lifetime as it interfaces with Stripe.js to perform\nauthentication flows and ultimately creates at most one successful charge.\n\nRelated guide: [Payment Intents API](https://docs.stripe.com/payments/payment-intents)",
  "x-resourceId": "payment_intent",
  "x-expandableFields": [
    "amount_details",
    "application",
    "automatic_payment_methods",
    "customer",
    "hooks",
    "last_payment_error",
    "latest_charge",
    "next_action",
    "on_behalf_of",
    "payment_details",
    "payment_method",
    "payment_method_configuration_details",
    "payment_method_options",
    "presentment_details",
    "processing",
    "review",
    "shipping",
    "transfer_data"
  ]
}

object payment_intent_amount_details_line_item

{
  "type": "object",
  "title": "PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItem",
  "required": [
    "id",
    "object",
    "product_name",
    "quantity",
    "unit_cost"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "tax": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_flows_amount_details_resource_line_items_list_resource_line_item_resource_tax"
        }
      ],
      "nullable": true,
      "description": "Contains information about the tax on the item."
    },
    "object": {
      "enum": [
        "payment_intent_amount_details_line_item"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "quantity": {
      "type": "integer",
      "description": "The quantity of items. Required for L3 rates. An integer greater than 0."
    },
    "unit_cost": {
      "type": "integer",
      "description": "The unit cost of the line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0."
    },
    "product_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long."
    },
    "product_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The product name of the line item. Required for L3 rates. At most 1024 characters long.\n\nFor Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For PayPal, this field is truncated to 127 characters."
    },
    "discount_amount": {
      "type": "integer",
      "nullable": true,
      "description": "The discount applied on this line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0.\n\nThis field is mutually exclusive with the `amount_details[discount_amount]` field."
    },
    "unit_of_measure": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A unit of measure for the line item, such as gallons, feet, meters, etc. Required for L3 rates. At most 12 alphanumeric characters long."
    },
    "payment_method_options": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_flows_amount_details_resource_line_items_list_resource_line_item_resource_payment_method_options"
        }
      ],
      "nullable": true,
      "description": "Payment method-specific information for line items."
    }
  },
  "description": "",
  "x-resourceId": "payment_intent_amount_details_line_item",
  "x-expandableFields": [
    "payment_method_options",
    "tax"
  ]
}

object payment_intent_card_processing

{
  "type": "object",
  "title": "PaymentIntentCardProcessing",
  "properties": {
    "customer_notification": {
      "$ref": "#/components/schemas/payment_intent_processing_customer_notification"
    }
  },
  "description": "",
  "x-expandableFields": [
    "customer_notification"
  ]
}

object payment_intent_next_action

{
  "type": "object",
  "title": "PaymentIntentNextAction",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "type": "string",
      "maxLength": 5000,
      "description": "Type of the next action to perform. Refer to the other child attributes under `next_action` for available values. Examples include: `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`."
    },
    "use_stripe_sdk": {
      "type": "object",
      "description": "When confirming a PaymentIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js."
    },
    "redirect_to_url": {
      "$ref": "#/components/schemas/payment_intent_next_action_redirect_to_url"
    },
    "pix_display_qr_code": {
      "$ref": "#/components/schemas/payment_intent_next_action_pix_display_qr_code"
    },
    "oxxo_display_details": {
      "$ref": "#/components/schemas/payment_intent_next_action_display_oxxo_details"
    },
    "alipay_handle_redirect": {
      "$ref": "#/components/schemas/payment_intent_next_action_alipay_handle_redirect"
    },
    "boleto_display_details": {
      "$ref": "#/components/schemas/payment_intent_next_action_boleto"
    },
    "paynow_display_qr_code": {
      "$ref": "#/components/schemas/payment_intent_next_action_paynow_display_qr_code"
    },
    "card_await_notification": {
      "$ref": "#/components/schemas/payment_intent_next_action_card_await_notification"
    },
    "konbini_display_details": {
      "$ref": "#/components/schemas/payment_intent_next_action_konbini"
    },
    "promptpay_display_qr_code": {
      "$ref": "#/components/schemas/payment_intent_next_action_promptpay_display_qr_code"
    },
    "verify_with_microdeposits": {
      "$ref": "#/components/schemas/payment_intent_next_action_verify_with_microdeposits"
    },
    "multibanco_display_details": {
      "$ref": "#/components/schemas/payment_intent_next_action_display_multibanco_details"
    },
    "wechat_pay_display_qr_code": {
      "$ref": "#/components/schemas/payment_intent_next_action_wechat_pay_display_qr_code"
    },
    "wechat_pay_redirect_to_ios_app": {
      "$ref": "#/components/schemas/payment_intent_next_action_wechat_pay_redirect_to_ios_app"
    },
    "display_bank_transfer_instructions": {
      "$ref": "#/components/schemas/payment_intent_next_action_display_bank_transfer_instructions"
    },
    "wechat_pay_redirect_to_android_app": {
      "$ref": "#/components/schemas/payment_intent_next_action_wechat_pay_redirect_to_android_app"
    },
    "upi_handle_redirect_or_display_qr_code": {
      "$ref": "#/components/schemas/payment_intent_next_action_upi_handle_redirect_or_display_qr_code"
    },
    "swish_handle_redirect_or_display_qr_code": {
      "$ref": "#/components/schemas/payment_intent_next_action_swish_handle_redirect_or_display_qr_code"
    },
    "cashapp_handle_redirect_or_display_qr_code": {
      "$ref": "#/components/schemas/payment_intent_next_action_cashapp_handle_redirect_or_display_qr_code"
    }
  },
  "description": "",
  "x-expandableFields": [
    "alipay_handle_redirect",
    "boleto_display_details",
    "card_await_notification",
    "cashapp_handle_redirect_or_display_qr_code",
    "display_bank_transfer_instructions",
    "konbini_display_details",
    "multibanco_display_details",
    "oxxo_display_details",
    "paynow_display_qr_code",
    "pix_display_qr_code",
    "promptpay_display_qr_code",
    "redirect_to_url",
    "swish_handle_redirect_or_display_qr_code",
    "upi_handle_redirect_or_display_qr_code",
    "verify_with_microdeposits",
    "wechat_pay_display_qr_code",
    "wechat_pay_redirect_to_android_app",
    "wechat_pay_redirect_to_ios_app"
  ]
}

object payment_intent_next_action_alipay_handle_redirect

{
  "type": "object",
  "title": "PaymentIntentNextActionAlipayHandleRedirect",
  "properties": {
    "url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The URL you must redirect your customer to in order to authenticate the payment."
    },
    "native_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The native URL you must redirect your customer to in order to authenticate the payment in an iOS App."
    },
    "return_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion."
    },
    "native_data": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The native data to be used with Alipay SDK you must redirect your customer to in order to authenticate the payment in an Android App."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_next_action_boleto

{
  "type": "object",
  "title": "payment_intent_next_action_boleto",
  "properties": {
    "pdf": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The URL to the downloadable boleto voucher PDF."
    },
    "number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The boleto number."
    },
    "expires_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The timestamp after which the boleto expires."
    },
    "hosted_voucher_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_next_action_card_await_notification

{
  "type": "object",
  "title": "PaymentIntentNextActionCardAwaitNotification",
  "properties": {
    "charge_attempt_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The time that payment will be attempted. If customer approval is required, they need to provide approval before this time."
    },
    "customer_approval_required": {
      "type": "boolean",
      "nullable": true,
      "description": "For payments greater than INR 15000, the customer must provide explicit approval of the payment with their bank. For payments of lower amount, no customer action is required."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_next_action_cashapp_handle_redirect_or_display_qr_code

{
  "type": "object",
  "title": "PaymentIntentNextActionCashappHandleRedirectOrDisplayQrCode",
  "required": [
    "hosted_instructions_url",
    "mobile_auth_url",
    "qr_code"
  ],
  "properties": {
    "qr_code": {
      "$ref": "#/components/schemas/payment_intent_next_action_cashapp_qr_code"
    },
    "mobile_auth_url": {
      "type": "string",
      "maxLength": 5000,
      "description": "The url for mobile redirect based auth"
    },
    "hosted_instructions_url": {
      "type": "string",
      "maxLength": 5000,
      "description": "The URL to the hosted Cash App Pay instructions page, which allows customers to view the QR code, and supports QR code refreshing on expiration."
    }
  },
  "description": "",
  "x-expandableFields": [
    "qr_code"
  ]
}

object payment_intent_next_action_cashapp_qr_code

{
  "type": "object",
  "title": "PaymentIntentNextActionCashappQRCode",
  "required": [
    "expires_at",
    "image_url_png",
    "image_url_svg"
  ],
  "properties": {
    "expires_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "The date (unix timestamp) when the QR code expires."
    },
    "image_url_png": {
      "type": "string",
      "maxLength": 5000,
      "description": "The image_url_png string used to render QR code"
    },
    "image_url_svg": {
      "type": "string",
      "maxLength": 5000,
      "description": "The image_url_svg string used to render QR code"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_next_action_display_bank_transfer_instructions

{
  "type": "object",
  "title": "PaymentIntentNextActionDisplayBankTransferInstructions",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "eu_bank_transfer",
        "gb_bank_transfer",
        "jp_bank_transfer",
        "mx_bank_transfer",
        "us_bank_transfer"
      ],
      "type": "string",
      "description": "Type of bank transfer",
      "x-stripeBypassValidation": true
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "nullable": true,
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A string identifying this payment. Instruct your customer to include this code in the reference or memo field of their bank transfer."
    },
    "amount_remaining": {
      "type": "integer",
      "nullable": true,
      "description": "The remaining amount that needs to be transferred to complete the payment."
    },
    "financial_addresses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/funding_instructions_bank_transfer_financial_address"
      },
      "description": "A list of financial addresses that can be used to fund the customer balance"
    },
    "hosted_instructions_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A link to a hosted page that guides your customer through completing the transfer."
    }
  },
  "description": "",
  "x-expandableFields": [
    "financial_addresses"
  ]
}

object payment_intent_next_action_display_multibanco_details

{
  "type": "object",
  "title": "PaymentIntentNextActionDisplayMultibancoDetails",
  "properties": {
    "entity": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Entity number associated with this Multibanco payment."
    },
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Reference number associated with this Multibanco payment."
    },
    "expires_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The timestamp at which the Multibanco voucher expires."
    },
    "hosted_voucher_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The URL for the hosted Multibanco voucher page, which allows customers to view a Multibanco voucher."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_next_action_display_oxxo_details

{
  "type": "object",
  "title": "PaymentIntentNextActionDisplayOxxoDetails",
  "properties": {
    "number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "OXXO reference number."
    },
    "expires_after": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The timestamp after which the OXXO voucher expires."
    },
    "hosted_voucher_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_next_action_konbini

{
  "type": "object",
  "title": "payment_intent_next_action_konbini",
  "required": [
    "expires_at",
    "stores"
  ],
  "properties": {
    "stores": {
      "$ref": "#/components/schemas/payment_intent_next_action_konbini_stores"
    },
    "expires_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "The timestamp at which the pending Konbini payment expires."
    },
    "hosted_voucher_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The URL for the Konbini payment instructions page, which allows customers to view and print a Konbini voucher."
    }
  },
  "description": "",
  "x-expandableFields": [
    "stores"
  ]
}

object payment_intent_next_action_konbini_familymart

{
  "type": "object",
  "title": "payment_intent_next_action_konbini_familymart",
  "required": [
    "payment_code"
  ],
  "properties": {
    "payment_code": {
      "type": "string",
      "maxLength": 5000,
      "description": "The payment code."
    },
    "confirmation_number": {
      "type": "string",
      "maxLength": 5000,
      "description": "The confirmation number."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_next_action_konbini_lawson

{
  "type": "object",
  "title": "payment_intent_next_action_konbini_lawson",
  "required": [
    "payment_code"
  ],
  "properties": {
    "payment_code": {
      "type": "string",
      "maxLength": 5000,
      "description": "The payment code."
    },
    "confirmation_number": {
      "type": "string",
      "maxLength": 5000,
      "description": "The confirmation number."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_next_action_konbini_ministop

{
  "type": "object",
  "title": "payment_intent_next_action_konbini_ministop",
  "required": [
    "payment_code"
  ],
  "properties": {
    "payment_code": {
      "type": "string",
      "maxLength": 5000,
      "description": "The payment code."
    },
    "confirmation_number": {
      "type": "string",
      "maxLength": 5000,
      "description": "The confirmation number."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_next_action_konbini_seicomart

{
  "type": "object",
  "title": "payment_intent_next_action_konbini_seicomart",
  "required": [
    "payment_code"
  ],
  "properties": {
    "payment_code": {
      "type": "string",
      "maxLength": 5000,
      "description": "The payment code."
    },
    "confirmation_number": {
      "type": "string",
      "maxLength": 5000,
      "description": "The confirmation number."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_next_action_konbini_stores

{
  "type": "object",
  "title": "payment_intent_next_action_konbini_stores",
  "properties": {
    "lawson": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_intent_next_action_konbini_lawson"
        }
      ],
      "nullable": true,
      "description": "Lawson instruction details."
    },
    "ministop": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_intent_next_action_konbini_ministop"
        }
      ],
      "nullable": true,
      "description": "Ministop instruction details."
    },
    "seicomart": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_intent_next_action_konbini_seicomart"
        }
      ],
      "nullable": true,
      "description": "Seicomart instruction details."
    },
    "familymart": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_intent_next_action_konbini_familymart"
        }
      ],
      "nullable": true,
      "description": "FamilyMart instruction details."
    }
  },
  "description": "",
  "x-expandableFields": [
    "familymart",
    "lawson",
    "ministop",
    "seicomart"
  ]
}

object payment_intent_next_action_paynow_display_qr_code

{
  "type": "object",
  "title": "PaymentIntentNextActionPaynowDisplayQrCode",
  "required": [
    "data",
    "image_url_png",
    "image_url_svg"
  ],
  "properties": {
    "data": {
      "type": "string",
      "maxLength": 5000,
      "description": "The raw data string used to generate QR code, it should be used together with QR code library."
    },
    "image_url_png": {
      "type": "string",
      "maxLength": 5000,
      "description": "The image_url_png string used to render QR code"
    },
    "image_url_svg": {
      "type": "string",
      "maxLength": 5000,
      "description": "The image_url_svg string used to render QR code"
    },
    "hosted_instructions_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The URL to the hosted PayNow instructions page, which allows customers to view the PayNow QR code."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_next_action_pix_display_qr_code

{
  "type": "object",
  "title": "PaymentIntentNextActionPixDisplayQrCode",
  "properties": {
    "data": {
      "type": "string",
      "maxLength": 5000,
      "description": "The raw data string used to generate QR code, it should be used together with QR code library."
    },
    "expires_at": {
      "type": "integer",
      "description": "The date (unix timestamp) when the PIX expires."
    },
    "image_url_png": {
      "type": "string",
      "maxLength": 5000,
      "description": "The image_url_png string used to render png QR code"
    },
    "image_url_svg": {
      "type": "string",
      "maxLength": 5000,
      "description": "The image_url_svg string used to render svg QR code"
    },
    "hosted_instructions_url": {
      "type": "string",
      "maxLength": 5000,
      "description": "The URL to the hosted pix instructions page, which allows customers to view the pix QR code."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_next_action_promptpay_display_qr_code

{
  "type": "object",
  "title": "PaymentIntentNextActionPromptpayDisplayQrCode",
  "required": [
    "data",
    "hosted_instructions_url",
    "image_url_png",
    "image_url_svg"
  ],
  "properties": {
    "data": {
      "type": "string",
      "maxLength": 5000,
      "description": "The raw data string used to generate QR code, it should be used together with QR code library."
    },
    "image_url_png": {
      "type": "string",
      "maxLength": 5000,
      "description": "The PNG path used to render the QR code, can be used as the source in an HTML img tag"
    },
    "image_url_svg": {
      "type": "string",
      "maxLength": 5000,
      "description": "The SVG path used to render the QR code, can be used as the source in an HTML img tag"
    },
    "hosted_instructions_url": {
      "type": "string",
      "maxLength": 5000,
      "description": "The URL to the hosted PromptPay instructions page, which allows customers to view the PromptPay QR code."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_next_action_redirect_to_url

{
  "type": "object",
  "title": "PaymentIntentNextActionRedirectToUrl",
  "properties": {
    "url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The URL you must redirect your customer to in order to authenticate the payment."
    },
    "return_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_next_action_swish_handle_redirect_or_display_qr_code

{
  "type": "object",
  "title": "PaymentIntentNextActionSwishHandleRedirectOrDisplayQrCode",
  "required": [
    "hosted_instructions_url",
    "qr_code"
  ],
  "properties": {
    "qr_code": {
      "$ref": "#/components/schemas/payment_intent_next_action_swish_qr_code"
    },
    "hosted_instructions_url": {
      "type": "string",
      "maxLength": 5000,
      "description": "The URL to the hosted Swish instructions page, which allows customers to view the QR code."
    }
  },
  "description": "",
  "x-expandableFields": [
    "qr_code"
  ]
}

object payment_intent_next_action_swish_qr_code

{
  "type": "object",
  "title": "PaymentIntentNextActionSwishQRCode",
  "required": [
    "data",
    "image_url_png",
    "image_url_svg"
  ],
  "properties": {
    "data": {
      "type": "string",
      "maxLength": 5000,
      "description": "The raw data string used to generate QR code, it should be used together with QR code library."
    },
    "image_url_png": {
      "type": "string",
      "maxLength": 5000,
      "description": "The image_url_png string used to render QR code"
    },
    "image_url_svg": {
      "type": "string",
      "maxLength": 5000,
      "description": "The image_url_svg string used to render QR code"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_next_action_upi_handle_redirect_or_display_qr_code

{
  "type": "object",
  "title": "PaymentIntentNextActionUpiHandleRedirectOrDisplayQrCode",
  "required": [
    "hosted_instructions_url",
    "qr_code"
  ],
  "properties": {
    "qr_code": {
      "$ref": "#/components/schemas/payment_intent_next_action_upiqr_code"
    },
    "hosted_instructions_url": {
      "type": "string",
      "maxLength": 5000,
      "description": "The URL to the hosted UPI instructions page, which allows customers to view the QR code."
    }
  },
  "description": "",
  "x-expandableFields": [
    "qr_code"
  ]
}

object payment_intent_next_action_upiqr_code

{
  "type": "object",
  "title": "PaymentIntentNextActionUPIQRCode",
  "required": [
    "expires_at",
    "image_url_png",
    "image_url_svg"
  ],
  "properties": {
    "expires_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "The date (unix timestamp) when the QR code expires."
    },
    "image_url_png": {
      "type": "string",
      "maxLength": 5000,
      "description": "The image_url_png string used to render QR code"
    },
    "image_url_svg": {
      "type": "string",
      "maxLength": 5000,
      "description": "The image_url_svg string used to render QR code"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_next_action_verify_with_microdeposits

{
  "type": "object",
  "title": "PaymentIntentNextActionVerifyWithMicrodeposits",
  "required": [
    "arrival_date",
    "hosted_verification_url"
  ],
  "properties": {
    "arrival_date": {
      "type": "integer",
      "format": "unix-time",
      "description": "The timestamp when the microdeposits are expected to land."
    },
    "microdeposit_type": {
      "enum": [
        "amounts",
        "descriptor_code"
      ],
      "type": "string",
      "nullable": true,
      "description": "The type of the microdeposit sent to the customer. Used to distinguish between different verification methods."
    },
    "hosted_verification_url": {
      "type": "string",
      "maxLength": 5000,
      "description": "The URL for the hosted verification page, which allows customers to verify their bank account."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_next_action_wechat_pay_display_qr_code

{
  "type": "object",
  "title": "PaymentIntentNextActionWechatPayDisplayQrCode",
  "required": [
    "data",
    "hosted_instructions_url",
    "image_data_url",
    "image_url_png",
    "image_url_svg"
  ],
  "properties": {
    "data": {
      "type": "string",
      "maxLength": 5000,
      "description": "The data being used to generate QR code"
    },
    "image_url_png": {
      "type": "string",
      "maxLength": 5000,
      "description": "The image_url_png string used to render QR code"
    },
    "image_url_svg": {
      "type": "string",
      "maxLength": 5000,
      "description": "The image_url_svg string used to render QR code"
    },
    "image_data_url": {
      "type": "string",
      "maxLength": 5000,
      "description": "The base64 image data for a pre-generated QR code"
    },
    "hosted_instructions_url": {
      "type": "string",
      "maxLength": 5000,
      "description": "The URL to the hosted WeChat Pay instructions page, which allows customers to view the WeChat Pay QR code."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_next_action_wechat_pay_redirect_to_android_app

{
  "type": "object",
  "title": "PaymentIntentNextActionWechatPayRedirectToAndroidApp",
  "required": [
    "app_id",
    "nonce_str",
    "package",
    "partner_id",
    "prepay_id",
    "sign",
    "timestamp"
  ],
  "properties": {
    "sign": {
      "type": "string",
      "maxLength": 5000,
      "description": "A signature"
    },
    "app_id": {
      "type": "string",
      "maxLength": 5000,
      "description": "app_id is the APP ID registered on WeChat open platform"
    },
    "package": {
      "type": "string",
      "maxLength": 5000,
      "description": "package is static value"
    },
    "nonce_str": {
      "type": "string",
      "maxLength": 5000,
      "description": "nonce_str is a random string"
    },
    "prepay_id": {
      "type": "string",
      "maxLength": 5000,
      "description": "an unique trading ID assigned by WeChat Pay"
    },
    "timestamp": {
      "type": "string",
      "maxLength": 5000,
      "description": "Specifies the current time in epoch format"
    },
    "partner_id": {
      "type": "string",
      "maxLength": 5000,
      "description": "an unique merchant ID assigned by WeChat Pay"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_next_action_wechat_pay_redirect_to_ios_app

{
  "type": "object",
  "title": "PaymentIntentNextActionWechatPayRedirectToIOSApp",
  "required": [
    "native_url"
  ],
  "properties": {
    "native_url": {
      "type": "string",
      "maxLength": 5000,
      "description": "An universal link that redirect to WeChat Pay app"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_payment_method_options

{
  "type": "object",
  "title": "PaymentIntentPaymentMethodOptions",
  "properties": {
    "eps": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_intent_payment_method_options_eps"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "fpx": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_fpx"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "p24": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_p24"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "pix": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_pix"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "upi": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_upi"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "zip": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_zip"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "alma": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_alma"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "blik": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_intent_payment_method_options_blik"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "card": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_intent_payment_method_options_card"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "link": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_intent_payment_method_options_link"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "oxxo": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_oxxo"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "ideal": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_ideal"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "payco": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_flows_private_payment_methods_payco_payment_method_options"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "payto": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_intent_payment_method_options_payto"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "swish": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_intent_payment_method_options_swish"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "twint": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_twint"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "affirm": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_affirm"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "alipay": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_alipay"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "billie": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_billie"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "boleto": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_boleto"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "crypto": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_crypto"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "klarna": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_klarna"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "mb_way": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_mb_way"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "paynow": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_paynow"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "paypal": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_paypal"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "sofort": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_sofort"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "cashapp": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_cashapp"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "giropay": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_giropay"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "grabpay": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_grabpay"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "konbini": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_konbini"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "kr_card": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_kr_card"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "satispay": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_satispay"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "kakao_pay": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_flows_private_payment_methods_kakao_pay_payment_method_options"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "mobilepay": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_intent_payment_method_options_mobilepay"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "naver_pay": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_flows_private_payment_methods_naver_pay_payment_method_options"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "promptpay": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_promptpay"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "acss_debit": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_intent_payment_method_options_acss_debit"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "amazon_pay": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_amazon_pay"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "bacs_debit": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_intent_payment_method_options_bacs_debit"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "bancontact": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_bancontact"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "multibanco": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_multibanco"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "sepa_debit": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_intent_payment_method_options_sepa_debit"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "wechat_pay": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_wechat_pay"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "pay_by_bank": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_pay_by_bank"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "revolut_pay": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_revolut_pay"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "samsung_pay": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_flows_private_payment_methods_samsung_pay_payment_method_options"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "card_present": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_card_present"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "au_becs_debit": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_intent_payment_method_options_au_becs_debit"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "interac_present": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_interac_present"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "nz_bank_account": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_intent_payment_method_options_nz_bank_account"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "us_bank_account": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_intent_payment_method_options_us_bank_account"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "customer_balance": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_customer_balance"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "afterpay_clearpay": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_afterpay_clearpay"
        },
        {
          "$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
        }
      ]
    }
  },
  "description": "",
  "x-expandableFields": [
    "acss_debit",
    "affirm",
    "afterpay_clearpay",
    "alipay",
    "alma",
    "amazon_pay",
    "au_becs_debit",
    "bacs_debit",
    "bancontact",
    "billie",
    "blik",
    "boleto",
    "card",
    "card_present",
    "cashapp",
    "crypto",
    "customer_balance",
    "eps",
    "fpx",
    "giropay",
    "grabpay",
    "ideal",
    "interac_present",
    "kakao_pay",
    "klarna",
    "konbini",
    "kr_card",
    "link",
    "mb_way",
    "mobilepay",
    "multibanco",
    "naver_pay",
    "nz_bank_account",
    "oxxo",
    "p24",
    "pay_by_bank",
    "payco",
    "paynow",
    "paypal",
    "payto",
    "pix",
    "promptpay",
    "revolut_pay",
    "samsung_pay",
    "satispay",
    "sepa_debit",
    "sofort",
    "swish",
    "twint",
    "upi",
    "us_bank_account",
    "wechat_pay",
    "zip"
  ]
}

object payment_intent_payment_method_options_acss_debit

{
  "type": "object",
  "title": "payment_intent_payment_method_options_acss_debit",
  "properties": {
    "target_date": {
      "type": "string",
      "maxLength": 5000,
      "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now."
    },
    "mandate_options": {
      "$ref": "#/components/schemas/payment_intent_payment_method_options_mandate_options_acss_debit"
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session",
        "on_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    },
    "verification_method": {
      "enum": [
        "automatic",
        "instant",
        "microdeposits"
      ],
      "type": "string",
      "description": "Bank account verification method. The default value is `automatic`.",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": [
    "mandate_options"
  ]
}

object payment_intent_payment_method_options_au_becs_debit

{
  "type": "object",
  "title": "payment_intent_payment_method_options_au_becs_debit",
  "properties": {
    "target_date": {
      "type": "string",
      "maxLength": 5000,
      "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now."
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session",
        "on_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_payment_method_options_bacs_debit

{
  "type": "object",
  "title": "payment_intent_payment_method_options_bacs_debit",
  "properties": {
    "target_date": {
      "type": "string",
      "maxLength": 5000,
      "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now."
    },
    "mandate_options": {
      "$ref": "#/components/schemas/payment_intent_payment_method_options_mandate_options_bacs_debit"
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session",
        "on_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": [
    "mandate_options"
  ]
}

object payment_intent_payment_method_options_blik

{
  "type": "object",
  "title": "payment_intent_payment_method_options_blik",
  "properties": {
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_payment_method_options_card

{
  "type": "object",
  "title": "payment_intent_payment_method_options_card",
  "properties": {
    "network": {
      "enum": [
        "amex",
        "cartes_bancaires",
        "diners",
        "discover",
        "eftpos_au",
        "girocard",
        "interac",
        "jcb",
        "link",
        "mastercard",
        "unionpay",
        "unknown",
        "visa"
      ],
      "type": "string",
      "nullable": true,
      "description": "Selected network to process this payment intent on. Depends on the available networks of the card attached to the payment intent. Can be only set confirm-time."
    },
    "installments": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_card_installments"
        }
      ],
      "nullable": true,
      "description": "Installment details for this payment.\n\nFor more information, see the [installments integration guide](https://docs.stripe.com/payments/installments)."
    },
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account.",
      "x-stripeBypassValidation": true
    },
    "mandate_options": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_options_card_mandate_options"
        }
      ],
      "nullable": true,
      "description": "Configuration options for setting up an eMandate for cards issued in India."
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session",
        "on_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    },
    "request_overcapture": {
      "enum": [
        "if_available",
        "never"
      ],
      "type": "string",
      "description": "Request ability to [overcapture](https://docs.stripe.com/payments/overcapture) for this PaymentIntent."
    },
    "request_multicapture": {
      "enum": [
        "if_available",
        "never"
      ],
      "type": "string",
      "description": "Request ability to make [multiple captures](https://docs.stripe.com/payments/multicapture) for this PaymentIntent."
    },
    "request_three_d_secure": {
      "enum": [
        "any",
        "automatic",
        "challenge"
      ],
      "type": "string",
      "nullable": true,
      "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://docs.stripe.com/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
      "x-stripeBypassValidation": true
    },
    "require_cvc_recollection": {
      "type": "boolean",
      "description": "When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter)."
    },
    "request_extended_authorization": {
      "enum": [
        "if_available",
        "never"
      ],
      "type": "string",
      "description": "Request ability to [capture beyond the standard authorization validity window](https://docs.stripe.com/payments/extended-authorization) for this PaymentIntent."
    },
    "statement_descriptor_suffix_kana": {
      "type": "string",
      "maxLength": 5000,
      "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters."
    },
    "request_incremental_authorization": {
      "enum": [
        "if_available",
        "never"
      ],
      "type": "string",
      "description": "Request ability to [increment the authorization](https://docs.stripe.com/payments/incremental-authorization) for this PaymentIntent."
    },
    "statement_descriptor_suffix_kanji": {
      "type": "string",
      "maxLength": 5000,
      "description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters."
    }
  },
  "description": "",
  "x-expandableFields": [
    "installments",
    "mandate_options"
  ]
}

object payment_intent_payment_method_options_eps

{
  "type": "object",
  "title": "payment_intent_payment_method_options_eps",
  "properties": {
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_payment_method_options_link

{
  "type": "object",
  "title": "payment_intent_payment_method_options_link",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_payment_method_options_mandate_options_acss_debit

{
  "type": "object",
  "title": "payment_intent_payment_method_options_mandate_options_acss_debit",
  "properties": {
    "payment_schedule": {
      "enum": [
        "combined",
        "interval",
        "sporadic"
      ],
      "type": "string",
      "nullable": true,
      "description": "Payment schedule for the mandate."
    },
    "transaction_type": {
      "enum": [
        "business",
        "personal"
      ],
      "type": "string",
      "nullable": true,
      "description": "Transaction type of the mandate."
    },
    "custom_mandate_url": {
      "type": "string",
      "maxLength": 5000,
      "description": "A URL for custom mandate text"
    },
    "interval_description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_payment_method_options_mandate_options_bacs_debit

{
  "type": "object",
  "title": "payment_intent_payment_method_options_mandate_options_bacs_debit",
  "properties": {
    "reference_prefix": {
      "type": "string",
      "maxLength": 5000,
      "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_payment_method_options_mandate_options_payto

{
  "type": "object",
  "title": "payment_intent_payment_method_options_mandate_options_payto",
  "properties": {
    "amount": {
      "type": "integer",
      "nullable": true,
      "description": "Amount that will be collected. It is required when `amount_type` is `fixed`."
    },
    "purpose": {
      "enum": [
        "dependant_support",
        "government",
        "loan",
        "mortgage",
        "other",
        "pension",
        "personal",
        "retail",
        "salary",
        "tax",
        "utility"
      ],
      "type": "string",
      "nullable": true,
      "description": "The purpose for which payments are made. Has a default value based on your merchant category code."
    },
    "end_date": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date."
    },
    "amount_type": {
      "enum": [
        "fixed",
        "maximum"
      ],
      "type": "string",
      "nullable": true,
      "description": "The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. Defaults to `maximum`."
    },
    "payment_schedule": {
      "enum": [
        "adhoc",
        "annual",
        "daily",
        "fortnightly",
        "monthly",
        "quarterly",
        "semi_annual",
        "weekly"
      ],
      "type": "string",
      "nullable": true,
      "description": "The periodicity at which payments will be collected. Defaults to `adhoc`."
    },
    "payments_per_period": {
      "type": "integer",
      "nullable": true,
      "description": "The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_payment_method_options_mandate_options_sepa_debit

{
  "type": "object",
  "title": "payment_intent_payment_method_options_mandate_options_sepa_debit",
  "properties": {
    "reference_prefix": {
      "type": "string",
      "maxLength": 5000,
      "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_payment_method_options_mobilepay

{
  "type": "object",
  "title": "payment_intent_payment_method_options_mobilepay",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    },
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_payment_method_options_nz_bank_account

{
  "type": "object",
  "title": "payment_intent_payment_method_options_nz_bank_account",
  "properties": {
    "target_date": {
      "type": "string",
      "maxLength": 5000,
      "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now."
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session",
        "on_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_payment_method_options_payto

{
  "type": "object",
  "title": "payment_intent_payment_method_options_payto",
  "properties": {
    "mandate_options": {
      "$ref": "#/components/schemas/payment_intent_payment_method_options_mandate_options_payto"
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": [
    "mandate_options"
  ]
}

object payment_intent_payment_method_options_sepa_debit

{
  "type": "object",
  "title": "payment_intent_payment_method_options_sepa_debit",
  "properties": {
    "target_date": {
      "type": "string",
      "maxLength": 5000,
      "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now."
    },
    "mandate_options": {
      "$ref": "#/components/schemas/payment_intent_payment_method_options_mandate_options_sepa_debit"
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session",
        "on_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": [
    "mandate_options"
  ]
}

object payment_intent_payment_method_options_swish

{
  "type": "object",
  "title": "payment_intent_payment_method_options_swish",
  "properties": {
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 35,
      "description": "A reference for this payment to be displayed in the Swish app."
    },
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_payment_method_options_us_bank_account

{
  "type": "object",
  "title": "payment_intent_payment_method_options_us_bank_account",
  "properties": {
    "target_date": {
      "type": "string",
      "maxLength": 5000,
      "description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now."
    },
    "mandate_options": {
      "$ref": "#/components/schemas/payment_method_options_us_bank_account_mandate_options"
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session",
        "on_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    },
    "transaction_purpose": {
      "enum": [
        "goods",
        "other",
        "services",
        "unspecified"
      ],
      "type": "string",
      "description": "The purpose of the transaction."
    },
    "verification_method": {
      "enum": [
        "automatic",
        "instant",
        "microdeposits"
      ],
      "type": "string",
      "description": "Bank account verification method. The default value is `automatic`.",
      "x-stripeBypassValidation": true
    },
    "financial_connections": {
      "$ref": "#/components/schemas/linked_account_options_common"
    }
  },
  "description": "",
  "x-expandableFields": [
    "financial_connections",
    "mandate_options"
  ]
}

object payment_intent_processing

{
  "type": "object",
  "title": "PaymentIntentProcessing",
  "required": [
    "type"
  ],
  "properties": {
    "card": {
      "$ref": "#/components/schemas/payment_intent_card_processing"
    },
    "type": {
      "enum": [
        "card"
      ],
      "type": "string",
      "description": "Type of the payment method for which payment is in `processing` state, one of `card`."
    }
  },
  "description": "",
  "x-expandableFields": [
    "card"
  ]
}

object payment_intent_processing_customer_notification

{
  "type": "object",
  "title": "PaymentIntentProcessingCustomerNotification",
  "properties": {
    "completes_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "If customer approval is required, they need to provide approval before this time."
    },
    "approval_requested": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether customer approval has been requested for this payment. For payments greater than INR 15000 or mandate amount, the customer must provide explicit approval of the payment with their bank."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_intent_type_specific_payment_method_options_client

{
  "type": "object",
  "title": "PaymentIntentTypeSpecificPaymentMethodOptionsClient",
  "properties": {
    "routing": {
      "$ref": "#/components/schemas/payment_method_options_card_present_routing"
    },
    "installments": {
      "$ref": "#/components/schemas/payment_flows_installment_options"
    },
    "capture_method": {
      "enum": [
        "manual",
        "manual_preferred"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    },
    "mandate_options": {
      "$ref": "#/components/schemas/payment_intent_payment_method_options_mandate_options_payto"
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session",
        "on_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    },
    "verification_method": {
      "enum": [
        "automatic",
        "instant",
        "microdeposits"
      ],
      "type": "string",
      "description": "Bank account verification method. The default value is `automatic`.",
      "x-stripeBypassValidation": true
    },
    "require_cvc_recollection": {
      "type": "boolean",
      "description": "When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter)."
    },
    "request_incremental_authorization_support": {
      "type": "boolean",
      "description": "Request ability to [increment](https://docs.stripe.com/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://docs.stripe.com/api/payment_intents/confirm) response to verify support."
    }
  },
  "description": "",
  "x-expandableFields": [
    "installments",
    "mandate_options",
    "routing"
  ]
}

object payment_link

{
  "type": "object",
  "title": "PaymentLink",
  "required": [
    "active",
    "after_completion",
    "allow_promotion_codes",
    "automatic_tax",
    "billing_address_collection",
    "currency",
    "custom_fields",
    "custom_text",
    "customer_creation",
    "id",
    "livemode",
    "metadata",
    "object",
    "payment_method_collection",
    "phone_number_collection",
    "shipping_options",
    "submit_type",
    "tax_id_collection",
    "url"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "url": {
      "type": "string",
      "maxLength": 5000,
      "description": "The public URL that can be shared with customers."
    },
    "active": {
      "type": "boolean",
      "description": "Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated."
    },
    "object": {
      "enum": [
        "payment_link"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "line_items": {
      "type": "object",
      "title": "PaymentLinksResourceListLineItems",
      "required": [
        "data",
        "has_more",
        "object",
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "maxLength": 5000,
          "description": "The URL where this list can be accessed."
        },
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/item"
          },
          "description": "Details about each object."
        },
        "object": {
          "enum": [
            "list"
          ],
          "type": "string",
          "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
        },
        "has_more": {
          "type": "boolean",
          "description": "True if this list has another page of items after this one that can be fetched."
        }
      },
      "description": "The line items representing what is being sold.",
      "x-expandableFields": [
        "data"
      ]
    },
    "application": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/application"
        },
        {
          "$ref": "#/components/schemas/deleted_application"
        }
      ],
      "nullable": true,
      "description": "The ID of the Connect application that created the Payment Link.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/application"
          },
          {
            "$ref": "#/components/schemas/deleted_application"
          }
        ]
      }
    },
    "custom_text": {
      "$ref": "#/components/schemas/payment_links_resource_custom_text"
    },
    "submit_type": {
      "enum": [
        "auto",
        "book",
        "donate",
        "pay",
        "subscribe"
      ],
      "type": "string",
      "description": "Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button."
    },
    "on_behalf_of": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/account"
        }
      ],
      "nullable": true,
      "description": "The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/account"
          }
        ]
      }
    },
    "restrictions": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_links_resource_restrictions"
        }
      ],
      "nullable": true,
      "description": "Settings that restrict the usage of a payment link."
    },
    "automatic_tax": {
      "$ref": "#/components/schemas/payment_links_resource_automatic_tax"
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/payment_links_resource_custom_fields"
      },
      "description": "Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if `ui_mode` is `custom`."
    },
    "transfer_data": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_links_resource_transfer_data"
        }
      ],
      "nullable": true,
      "description": "The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to."
    },
    "optional_items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/payment_links_resource_optional_item"
      },
      "nullable": true,
      "description": "The optional items presented to the customer at checkout."
    },
    "name_collection": {
      "$ref": "#/components/schemas/payment_links_resource_name_collection"
    },
    "after_completion": {
      "$ref": "#/components/schemas/payment_links_resource_after_completion"
    },
    "inactive_message": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The custom message to be displayed to a customer when a payment link is no longer active."
    },
    "invoice_creation": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_links_resource_invoice_creation"
        }
      ],
      "nullable": true,
      "description": "Configuration for creating invoice for payment mode payment links."
    },
    "shipping_options": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/payment_links_resource_shipping_option"
      },
      "description": "The shipping rate options applied to the session."
    },
    "customer_creation": {
      "enum": [
        "always",
        "if_required"
      ],
      "type": "string",
      "description": "Configuration for Customer creation during checkout."
    },
    "subscription_data": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_links_resource_subscription_data"
        }
      ],
      "nullable": true,
      "description": "When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`."
    },
    "tax_id_collection": {
      "$ref": "#/components/schemas/payment_links_resource_tax_id_collection"
    },
    "consent_collection": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_links_resource_consent_collection"
        }
      ],
      "nullable": true,
      "description": "When set, provides configuration to gather active consent from customers."
    },
    "payment_intent_data": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_links_resource_payment_intent_data"
        }
      ],
      "nullable": true,
      "description": "Indicates the parameters to be passed to PaymentIntent creation during checkout."
    },
    "payment_method_types": {
      "type": "array",
      "items": {
        "enum": [
          "affirm",
          "afterpay_clearpay",
          "alipay",
          "alma",
          "au_becs_debit",
          "bacs_debit",
          "bancontact",
          "billie",
          "blik",
          "boleto",
          "card",
          "cashapp",
          "eps",
          "fpx",
          "giropay",
          "grabpay",
          "ideal",
          "klarna",
          "konbini",
          "link",
          "mb_way",
          "mobilepay",
          "multibanco",
          "oxxo",
          "p24",
          "pay_by_bank",
          "paynow",
          "paypal",
          "payto",
          "pix",
          "promptpay",
          "satispay",
          "sepa_debit",
          "sofort",
          "swish",
          "twint",
          "upi",
          "us_bank_account",
          "wechat_pay",
          "zip"
        ],
        "type": "string",
        "x-stripeBypassValidation": true
      },
      "nullable": true,
      "description": "The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods)."
    },
    "allow_promotion_codes": {
      "type": "boolean",
      "description": "Whether user redeemable promotion codes are enabled."
    },
    "application_fee_amount": {
      "type": "integer",
      "nullable": true,
      "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account."
    },
    "application_fee_percent": {
      "type": "number",
      "nullable": true,
      "description": "This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account."
    },
    "phone_number_collection": {
      "$ref": "#/components/schemas/payment_links_resource_phone_number_collection"
    },
    "payment_method_collection": {
      "enum": [
        "always",
        "if_required"
      ],
      "type": "string",
      "description": "Configuration for collecting a payment method during checkout. Defaults to `always`."
    },
    "billing_address_collection": {
      "enum": [
        "auto",
        "required"
      ],
      "type": "string",
      "description": "Configuration for collecting the customer's billing address. Defaults to `auto`."
    },
    "shipping_address_collection": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_links_resource_shipping_address_collection"
        }
      ],
      "nullable": true,
      "description": "Configuration for collecting the customer's shipping address."
    }
  },
  "description": "A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times.\n\nWhen a customer opens a payment link it will open a new [checkout session](https://docs.stripe.com/api/checkout/sessions) to render the payment page. You can use [checkout session events](https://docs.stripe.com/api/events/types#event_types-checkout.session.completed) to track payments through payment links.\n\nRelated guide: [Payment Links API](https://docs.stripe.com/payment-links)",
  "x-resourceId": "payment_link",
  "x-expandableFields": [
    "after_completion",
    "application",
    "automatic_tax",
    "consent_collection",
    "custom_fields",
    "custom_text",
    "invoice_creation",
    "line_items",
    "name_collection",
    "on_behalf_of",
    "optional_items",
    "payment_intent_data",
    "phone_number_collection",
    "restrictions",
    "shipping_address_collection",
    "shipping_options",
    "subscription_data",
    "tax_id_collection",
    "transfer_data"
  ]
}

object payment_links_resource_after_completion

{
  "type": "object",
  "title": "PaymentLinksResourceAfterCompletion",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "hosted_confirmation",
        "redirect"
      ],
      "type": "string",
      "description": "The specified behavior after the purchase is complete."
    },
    "redirect": {
      "$ref": "#/components/schemas/payment_links_resource_completion_behavior_redirect"
    },
    "hosted_confirmation": {
      "$ref": "#/components/schemas/payment_links_resource_completion_behavior_confirmation_page"
    }
  },
  "description": "",
  "x-expandableFields": [
    "hosted_confirmation",
    "redirect"
  ]
}

object payment_links_resource_automatic_tax

{
  "type": "object",
  "title": "PaymentLinksResourceAutomaticTax",
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "If `true`, tax will be calculated automatically using the customer's location."
    },
    "liability": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/connect_account_reference"
        }
      ],
      "nullable": true,
      "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account."
    }
  },
  "description": "",
  "x-expandableFields": [
    "liability"
  ]
}

object payment_links_resource_business_name

{
  "type": "object",
  "title": "PaymentLinksResourceBusinessName",
  "required": [
    "enabled",
    "optional"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Indicates whether business name collection is enabled for the payment link."
    },
    "optional": {
      "type": "boolean",
      "description": "Whether the customer is required to complete the field before checking out. Defaults to `false`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_links_resource_completed_sessions

{
  "type": "object",
  "title": "PaymentLinksResourceCompletedSessions",
  "required": [
    "count",
    "limit"
  ],
  "properties": {
    "count": {
      "type": "integer",
      "description": "The current number of checkout sessions that have been completed on the payment link which count towards the `completed_sessions` restriction to be met."
    },
    "limit": {
      "type": "integer",
      "description": "The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_links_resource_completion_behavior_confirmation_page

{
  "type": "object",
  "title": "PaymentLinksResourceCompletionBehaviorConfirmationPage",
  "properties": {
    "custom_message": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The custom message that is displayed to the customer after the purchase is complete."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_links_resource_completion_behavior_redirect

{
  "type": "object",
  "title": "PaymentLinksResourceCompletionBehaviorRedirect",
  "required": [
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 5000,
      "description": "The URL the customer will be redirected to after the purchase is complete."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_links_resource_consent_collection

{
  "type": "object",
  "title": "PaymentLinksResourceConsentCollection",
  "properties": {
    "promotions": {
      "enum": [
        "auto",
        "none"
      ],
      "type": "string",
      "nullable": true,
      "description": "If set to `auto`, enables the collection of customer consent for promotional communications."
    },
    "terms_of_service": {
      "enum": [
        "none",
        "required"
      ],
      "type": "string",
      "nullable": true,
      "description": "If set to `required`, it requires cutomers to accept the terms of service before being able to pay. If set to `none`, customers won't be shown a checkbox to accept the terms of service."
    },
    "payment_method_reuse_agreement": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_links_resource_payment_method_reuse_agreement"
        }
      ],
      "nullable": true,
      "description": "Settings related to the payment method reuse text shown in the Checkout UI."
    }
  },
  "description": "",
  "x-expandableFields": [
    "payment_method_reuse_agreement"
  ]
}

object payment_links_resource_custom_fields

{
  "type": "object",
  "title": "PaymentLinksResourceCustomFields",
  "required": [
    "key",
    "label",
    "optional",
    "type"
  ],
  "properties": {
    "key": {
      "type": "string",
      "maxLength": 5000,
      "description": "String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters."
    },
    "text": {
      "$ref": "#/components/schemas/payment_links_resource_custom_fields_text"
    },
    "type": {
      "enum": [
        "dropdown",
        "numeric",
        "text"
      ],
      "type": "string",
      "description": "The type of the field."
    },
    "label": {
      "$ref": "#/components/schemas/payment_links_resource_custom_fields_label"
    },
    "numeric": {
      "$ref": "#/components/schemas/payment_links_resource_custom_fields_numeric"
    },
    "dropdown": {
      "$ref": "#/components/schemas/payment_links_resource_custom_fields_dropdown"
    },
    "optional": {
      "type": "boolean",
      "description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`."
    }
  },
  "description": "",
  "x-expandableFields": [
    "dropdown",
    "label",
    "numeric",
    "text"
  ]
}

object payment_links_resource_custom_fields_dropdown

{
  "type": "object",
  "title": "PaymentLinksResourceCustomFieldsDropdown",
  "required": [
    "options"
  ],
  "properties": {
    "options": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/payment_links_resource_custom_fields_dropdown_option"
      },
      "description": "The options available for the customer to select. Up to 200 options allowed."
    },
    "default_value": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The value that pre-fills on the payment page."
    }
  },
  "description": "",
  "x-expandableFields": [
    "options"
  ]
}

object payment_links_resource_custom_fields_dropdown_option

{
  "type": "object",
  "title": "PaymentLinksResourceCustomFieldsDropdownOption",
  "required": [
    "label",
    "value"
  ],
  "properties": {
    "label": {
      "type": "string",
      "maxLength": 5000,
      "description": "The label for the option, displayed to the customer. Up to 100 characters."
    },
    "value": {
      "type": "string",
      "maxLength": 5000,
      "description": "The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_links_resource_custom_fields_label

{
  "type": "object",
  "title": "PaymentLinksResourceCustomFieldsLabel",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "custom"
      ],
      "type": "string",
      "description": "The type of the label."
    },
    "custom": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Custom text for the label, displayed to the customer. Up to 50 characters."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_links_resource_custom_fields_numeric

{
  "type": "object",
  "title": "PaymentLinksResourceCustomFieldsNumeric",
  "properties": {
    "default_value": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The value that pre-fills the field on the payment page."
    },
    "maximum_length": {
      "type": "integer",
      "nullable": true,
      "description": "The maximum character length constraint for the customer's input."
    },
    "minimum_length": {
      "type": "integer",
      "nullable": true,
      "description": "The minimum character length requirement for the customer's input."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_links_resource_custom_fields_text

{
  "type": "object",
  "title": "PaymentLinksResourceCustomFieldsText",
  "properties": {
    "default_value": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The value that pre-fills the field on the payment page."
    },
    "maximum_length": {
      "type": "integer",
      "nullable": true,
      "description": "The maximum character length constraint for the customer's input."
    },
    "minimum_length": {
      "type": "integer",
      "nullable": true,
      "description": "The minimum character length requirement for the customer's input."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_links_resource_custom_text

{
  "type": "object",
  "title": "PaymentLinksResourceCustomText",
  "properties": {
    "submit": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_links_resource_custom_text_position"
        }
      ],
      "nullable": true,
      "description": "Custom text that should be displayed alongside the payment confirmation button."
    },
    "after_submit": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_links_resource_custom_text_position"
        }
      ],
      "nullable": true,
      "description": "Custom text that should be displayed after the payment confirmation button."
    },
    "shipping_address": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_links_resource_custom_text_position"
        }
      ],
      "nullable": true,
      "description": "Custom text that should be displayed alongside shipping address collection."
    },
    "terms_of_service_acceptance": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_links_resource_custom_text_position"
        }
      ],
      "nullable": true,
      "description": "Custom text that should be displayed in place of the default terms of service agreement text."
    }
  },
  "description": "",
  "x-expandableFields": [
    "after_submit",
    "shipping_address",
    "submit",
    "terms_of_service_acceptance"
  ]
}

object payment_links_resource_custom_text_position

{
  "type": "object",
  "title": "PaymentLinksResourceCustomTextPosition",
  "required": [
    "message"
  ],
  "properties": {
    "message": {
      "type": "string",
      "maxLength": 1200,
      "description": "Text can be up to 1200 characters in length."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_links_resource_individual_name

{
  "type": "object",
  "title": "PaymentLinksResourceIndividualName",
  "required": [
    "enabled",
    "optional"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Indicates whether individual name collection is enabled for the payment link."
    },
    "optional": {
      "type": "boolean",
      "description": "Whether the customer is required to complete the field before checking out. Defaults to `false`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_links_resource_invoice_creation

{
  "type": "object",
  "title": "PaymentLinksResourceInvoiceCreation",
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Enable creating an invoice on successful payment."
    },
    "invoice_data": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_links_resource_invoice_settings"
        }
      ],
      "nullable": true,
      "description": "Configuration for the invoice. Default invoice values will be used if unspecified."
    }
  },
  "description": "",
  "x-expandableFields": [
    "invoice_data"
  ]
}

object payment_links_resource_invoice_settings

{
  "type": "object",
  "title": "PaymentLinksResourceInvoiceSettings",
  "properties": {
    "footer": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Footer to be displayed on the invoice."
    },
    "issuer": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/connect_account_reference"
        }
      ],
      "nullable": true,
      "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An arbitrary string attached to the object. Often useful for displaying to users."
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/invoice_setting_custom_field"
      },
      "nullable": true,
      "description": "A list of up to 4 custom fields to be displayed on the invoice."
    },
    "account_tax_ids": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 5000
          },
          {
            "$ref": "#/components/schemas/tax_id"
          },
          {
            "$ref": "#/components/schemas/deleted_tax_id"
          }
        ],
        "x-expansionResources": {
          "oneOf": [
            {
              "$ref": "#/components/schemas/tax_id"
            },
            {
              "$ref": "#/components/schemas/deleted_tax_id"
            }
          ]
        }
      },
      "nullable": true,
      "description": "The account tax IDs associated with the invoice."
    },
    "rendering_options": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/invoice_setting_checkout_rendering_options"
        }
      ],
      "nullable": true,
      "description": "Options for invoice PDF rendering."
    }
  },
  "description": "",
  "x-expandableFields": [
    "account_tax_ids",
    "custom_fields",
    "issuer",
    "rendering_options"
  ]
}

object payment_links_resource_name_collection

{
  "type": "object",
  "title": "PaymentLinksResourceNameCollection",
  "properties": {
    "business": {
      "$ref": "#/components/schemas/payment_links_resource_business_name"
    },
    "individual": {
      "$ref": "#/components/schemas/payment_links_resource_individual_name"
    }
  },
  "description": "",
  "x-expandableFields": [
    "business",
    "individual"
  ]
}

object payment_links_resource_optional_item

{
  "type": "object",
  "title": "PaymentLinksResourceOptionalItem",
  "required": [
    "price",
    "quantity"
  ],
  "properties": {
    "price": {
      "type": "string",
      "maxLength": 5000
    },
    "quantity": {
      "type": "integer"
    },
    "adjustable_quantity": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_links_resource_optional_item_adjustable_quantity"
        }
      ],
      "nullable": true
    }
  },
  "description": "",
  "x-expandableFields": [
    "adjustable_quantity"
  ]
}

object payment_links_resource_optional_item_adjustable_quantity

{
  "type": "object",
  "title": "PaymentLinksResourceOptionalItemAdjustableQuantity",
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Set to true if the quantity can be adjusted to any non-negative integer."
    },
    "maximum": {
      "type": "integer",
      "nullable": true,
      "description": "The maximum quantity of this item the customer can purchase. By default this value is 99."
    },
    "minimum": {
      "type": "integer",
      "nullable": true,
      "description": "The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_links_resource_payment_intent_data

{
  "type": "object",
  "title": "PaymentLinksResourcePaymentIntentData",
  "required": [
    "metadata"
  ],
  "properties": {
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on [Payment Intents](https://docs.stripe.com/api/payment_intents) generated from this payment link.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An arbitrary string attached to the object. Often useful for displaying to users."
    },
    "capture_method": {
      "enum": [
        "automatic",
        "automatic_async",
        "manual"
      ],
      "type": "string",
      "nullable": true,
      "description": "Indicates when the funds will be captured from the customer's account."
    },
    "transfer_group": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers) for details."
    },
    "setup_future_usage": {
      "enum": [
        "off_session",
        "on_session"
      ],
      "type": "string",
      "nullable": true,
      "description": "Indicates that you intend to make future payments with the payment method collected during checkout."
    },
    "statement_descriptor": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "For a non-card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge."
    },
    "statement_descriptor_suffix": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "For a card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Concatenated with the account's statement descriptor prefix to form the complete statement descriptor."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_links_resource_payment_method_reuse_agreement

{
  "type": "object",
  "title": "PaymentLinksResourcePaymentMethodReuseAgreement",
  "required": [
    "position"
  ],
  "properties": {
    "position": {
      "enum": [
        "auto",
        "hidden"
      ],
      "type": "string",
      "description": "Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's defaults will be used.\n\nWhen set to `hidden`, the payment method reuse agreement text will always be hidden in the UI."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_links_resource_phone_number_collection

{
  "type": "object",
  "title": "PaymentLinksResourcePhoneNumberCollection",
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "If `true`, a phone number will be collected during checkout."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_links_resource_restrictions

{
  "type": "object",
  "title": "PaymentLinksResourceRestrictions",
  "required": [
    "completed_sessions"
  ],
  "properties": {
    "completed_sessions": {
      "$ref": "#/components/schemas/payment_links_resource_completed_sessions"
    }
  },
  "description": "",
  "x-expandableFields": [
    "completed_sessions"
  ]
}

object payment_links_resource_shipping_address_collection

{
  "type": "object",
  "title": "PaymentLinksResourceShippingAddressCollection",
  "required": [
    "allowed_countries"
  ],
  "properties": {
    "allowed_countries": {
      "type": "array",
      "items": {
        "enum": [
          "AC",
          "AD",
          "AE",
          "AF",
          "AG",
          "AI",
          "AL",
          "AM",
          "AO",
          "AQ",
          "AR",
          "AT",
          "AU",
          "AW",
          "AX",
          "AZ",
          "BA",
          "BB",
          "BD",
          "BE",
          "BF",
          "BG",
          "BH",
          "BI",
          "BJ",
          "BL",
          "BM",
          "BN",
          "BO",
          "BQ",
          "BR",
          "BS",
          "BT",
          "BV",
          "BW",
          "BY",
          "BZ",
          "CA",
          "CD",
          "CF",
          "CG",
          "CH",
          "CI",
          "CK",
          "CL",
          "CM",
          "CN",
          "CO",
          "CR",
          "CV",
          "CW",
          "CY",
          "CZ",
          "DE",
          "DJ",
          "DK",
          "DM",
          "DO",
          "DZ",
          "EC",
          "EE",
          "EG",
          "EH",
          "ER",
          "ES",
          "ET",
          "FI",
          "FJ",
          "FK",
          "FO",
          "FR",
          "GA",
          "GB",
          "GD",
          "GE",
          "GF",
          "GG",
          "GH",
          "GI",
          "GL",
          "GM",
          "GN",
          "GP",
          "GQ",
          "GR",
          "GS",
          "GT",
          "GU",
          "GW",
          "GY",
          "HK",
          "HN",
          "HR",
          "HT",
          "HU",
          "ID",
          "IE",
          "IL",
          "IM",
          "IN",
          "IO",
          "IQ",
          "IS",
          "IT",
          "JE",
          "JM",
          "JO",
          "JP",
          "KE",
          "KG",
          "KH",
          "KI",
          "KM",
          "KN",
          "KR",
          "KW",
          "KY",
          "KZ",
          "LA",
          "LB",
          "LC",
          "LI",
          "LK",
          "LR",
          "LS",
          "LT",
          "LU",
          "LV",
          "LY",
          "MA",
          "MC",
          "MD",
          "ME",
          "MF",
          "MG",
          "MK",
          "ML",
          "MM",
          "MN",
          "MO",
          "MQ",
          "MR",
          "MS",
          "MT",
          "MU",
          "MV",
          "MW",
          "MX",
          "MY",
          "MZ",
          "NA",
          "NC",
          "NE",
          "NG",
          "NI",
          "NL",
          "NO",
          "NP",
          "NR",
          "NU",
          "NZ",
          "OM",
          "PA",
          "PE",
          "PF",
          "PG",
          "PH",
          "PK",
          "PL",
          "PM",
          "PN",
          "PR",
          "PS",
          "PT",
          "PY",
          "QA",
          "RE",
          "RO",
          "RS",
          "RU",
          "RW",
          "SA",
          "SB",
          "SC",
          "SD",
          "SE",
          "SG",
          "SH",
          "SI",
          "SJ",
          "SK",
          "SL",
          "SM",
          "SN",
          "SO",
          "SR",
          "SS",
          "ST",
          "SV",
          "SX",
          "SZ",
          "TA",
          "TC",
          "TD",
          "TF",
          "TG",
          "TH",
          "TJ",
          "TK",
          "TL",
          "TM",
          "TN",
          "TO",
          "TR",
          "TT",
          "TV",
          "TW",
          "TZ",
          "UA",
          "UG",
          "US",
          "UY",
          "UZ",
          "VA",
          "VC",
          "VE",
          "VG",
          "VN",
          "VU",
          "WF",
          "WS",
          "XK",
          "YE",
          "YT",
          "ZA",
          "ZM",
          "ZW",
          "ZZ"
        ],
        "type": "string"
      },
      "description": "An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_links_resource_shipping_option

{
  "type": "object",
  "title": "PaymentLinksResourceShippingOption",
  "required": [
    "shipping_amount",
    "shipping_rate"
  ],
  "properties": {
    "shipping_rate": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/shipping_rate"
        }
      ],
      "description": "The ID of the Shipping Rate to use for this shipping option.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/shipping_rate"
          }
        ]
      }
    },
    "shipping_amount": {
      "type": "integer",
      "description": "A non-negative integer in cents representing how much to charge."
    }
  },
  "description": "",
  "x-expandableFields": [
    "shipping_rate"
  ]
}

object payment_links_resource_subscription_data

{
  "type": "object",
  "title": "PaymentLinksResourceSubscriptionData",
  "required": [
    "invoice_settings",
    "metadata"
  ],
  "properties": {
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on [Subscriptions](https://docs.stripe.com/api/subscriptions) generated from this payment link.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs."
    },
    "trial_settings": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/subscriptions_trials_resource_trial_settings"
        }
      ],
      "nullable": true,
      "description": "Settings related to subscription trials."
    },
    "invoice_settings": {
      "$ref": "#/components/schemas/payment_links_resource_subscription_data_invoice_settings"
    },
    "trial_period_days": {
      "type": "integer",
      "nullable": true,
      "description": "Integer representing the number of trial period days before the customer is charged for the first time."
    }
  },
  "description": "",
  "x-expandableFields": [
    "invoice_settings",
    "trial_settings"
  ]
}

object payment_links_resource_subscription_data_invoice_settings

{
  "type": "object",
  "title": "PaymentLinksResourceSubscriptionDataInvoiceSettings",
  "required": [
    "issuer"
  ],
  "properties": {
    "issuer": {
      "$ref": "#/components/schemas/connect_account_reference"
    }
  },
  "description": "",
  "x-expandableFields": [
    "issuer"
  ]
}

object payment_links_resource_tax_id_collection

{
  "type": "object",
  "title": "PaymentLinksResourceTaxIdCollection",
  "required": [
    "enabled",
    "required"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Indicates whether tax ID collection is enabled for the session."
    },
    "required": {
      "enum": [
        "if_supported",
        "never"
      ],
      "type": "string"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_links_resource_transfer_data

{
  "type": "object",
  "title": "PaymentLinksResourceTransferData",
  "required": [
    "destination"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "nullable": true,
      "description": "The amount in cents (or local equivalent) that will be transferred to the destination account. By default, the entire amount is transferred to the destination."
    },
    "destination": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/account"
        }
      ],
      "description": "The connected account receiving the transfer.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/account"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "destination"
  ]
}

object payment_method

{
  "type": "object",
  "title": "PaymentMethod",
  "required": [
    "billing_details",
    "created",
    "id",
    "livemode",
    "object",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "eps": {
      "$ref": "#/components/schemas/payment_method_eps"
    },
    "fpx": {
      "$ref": "#/components/schemas/payment_method_fpx"
    },
    "p24": {
      "$ref": "#/components/schemas/payment_method_p24"
    },
    "pix": {
      "$ref": "#/components/schemas/payment_method_pix"
    },
    "upi": {
      "$ref": "#/components/schemas/payment_method_upi"
    },
    "zip": {
      "$ref": "#/components/schemas/payment_method_zip"
    },
    "alma": {
      "$ref": "#/components/schemas/payment_method_alma"
    },
    "blik": {
      "$ref": "#/components/schemas/payment_method_blik"
    },
    "card": {
      "$ref": "#/components/schemas/payment_method_card"
    },
    "link": {
      "$ref": "#/components/schemas/payment_method_link"
    },
    "oxxo": {
      "$ref": "#/components/schemas/payment_method_oxxo"
    },
    "type": {
      "enum": [
        "acss_debit",
        "affirm",
        "afterpay_clearpay",
        "alipay",
        "alma",
        "amazon_pay",
        "au_becs_debit",
        "bacs_debit",
        "bancontact",
        "billie",
        "blik",
        "boleto",
        "card",
        "card_present",
        "cashapp",
        "crypto",
        "custom",
        "customer_balance",
        "eps",
        "fpx",
        "giropay",
        "grabpay",
        "ideal",
        "interac_present",
        "kakao_pay",
        "klarna",
        "konbini",
        "kr_card",
        "link",
        "mb_way",
        "mobilepay",
        "multibanco",
        "naver_pay",
        "nz_bank_account",
        "oxxo",
        "p24",
        "pay_by_bank",
        "payco",
        "paynow",
        "paypal",
        "payto",
        "pix",
        "promptpay",
        "revolut_pay",
        "samsung_pay",
        "satispay",
        "sepa_debit",
        "sofort",
        "swish",
        "twint",
        "upi",
        "us_bank_account",
        "wechat_pay",
        "zip"
      ],
      "type": "string",
      "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.",
      "x-stripeBypassValidation": true
    },
    "ideal": {
      "$ref": "#/components/schemas/payment_method_ideal"
    },
    "payco": {
      "$ref": "#/components/schemas/payment_method_payco"
    },
    "payto": {
      "$ref": "#/components/schemas/payment_method_payto"
    },
    "swish": {
      "$ref": "#/components/schemas/payment_method_swish"
    },
    "twint": {
      "$ref": "#/components/schemas/payment_method_twint"
    },
    "affirm": {
      "$ref": "#/components/schemas/payment_method_affirm"
    },
    "alipay": {
      "$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay"
    },
    "billie": {
      "$ref": "#/components/schemas/payment_method_billie"
    },
    "boleto": {
      "$ref": "#/components/schemas/payment_method_boleto"
    },
    "crypto": {
      "$ref": "#/components/schemas/payment_method_crypto"
    },
    "custom": {
      "$ref": "#/components/schemas/payment_method_custom"
    },
    "klarna": {
      "$ref": "#/components/schemas/payment_method_klarna"
    },
    "mb_way": {
      "$ref": "#/components/schemas/payment_method_mb_way"
    },
    "object": {
      "enum": [
        "payment_method"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "paynow": {
      "$ref": "#/components/schemas/payment_method_paynow"
    },
    "paypal": {
      "$ref": "#/components/schemas/payment_method_paypal"
    },
    "sofort": {
      "$ref": "#/components/schemas/payment_method_sofort"
    },
    "cashapp": {
      "$ref": "#/components/schemas/payment_method_cashapp"
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "giropay": {
      "$ref": "#/components/schemas/payment_method_giropay"
    },
    "grabpay": {
      "$ref": "#/components/schemas/payment_method_grabpay"
    },
    "konbini": {
      "$ref": "#/components/schemas/payment_method_konbini"
    },
    "kr_card": {
      "$ref": "#/components/schemas/payment_method_kr_card"
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        }
      ],
      "nullable": true,
      "description": "The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          }
        ]
      }
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "satispay": {
      "$ref": "#/components/schemas/payment_method_satispay"
    },
    "kakao_pay": {
      "$ref": "#/components/schemas/payment_method_kakao_pay"
    },
    "mobilepay": {
      "$ref": "#/components/schemas/payment_method_mobilepay"
    },
    "naver_pay": {
      "$ref": "#/components/schemas/payment_method_naver_pay"
    },
    "promptpay": {
      "$ref": "#/components/schemas/payment_method_promptpay"
    },
    "acss_debit": {
      "$ref": "#/components/schemas/payment_method_acss_debit"
    },
    "amazon_pay": {
      "$ref": "#/components/schemas/payment_method_amazon_pay"
    },
    "bacs_debit": {
      "$ref": "#/components/schemas/payment_method_bacs_debit"
    },
    "bancontact": {
      "$ref": "#/components/schemas/payment_method_bancontact"
    },
    "multibanco": {
      "$ref": "#/components/schemas/payment_method_multibanco"
    },
    "sepa_debit": {
      "$ref": "#/components/schemas/payment_method_sepa_debit"
    },
    "wechat_pay": {
      "$ref": "#/components/schemas/payment_method_wechat_pay"
    },
    "pay_by_bank": {
      "$ref": "#/components/schemas/payment_method_pay_by_bank"
    },
    "revolut_pay": {
      "$ref": "#/components/schemas/payment_method_revolut_pay"
    },
    "samsung_pay": {
      "$ref": "#/components/schemas/payment_method_samsung_pay"
    },
    "card_present": {
      "$ref": "#/components/schemas/payment_method_card_present"
    },
    "au_becs_debit": {
      "$ref": "#/components/schemas/payment_method_au_becs_debit"
    },
    "radar_options": {
      "$ref": "#/components/schemas/radar_radar_options"
    },
    "allow_redisplay": {
      "enum": [
        "always",
        "limited",
        "unspecified"
      ],
      "type": "string",
      "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”."
    },
    "billing_details": {
      "$ref": "#/components/schemas/billing_details"
    },
    "interac_present": {
      "$ref": "#/components/schemas/payment_method_interac_present"
    },
    "nz_bank_account": {
      "$ref": "#/components/schemas/payment_method_nz_bank_account"
    },
    "us_bank_account": {
      "$ref": "#/components/schemas/payment_method_us_bank_account"
    },
    "customer_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000
    },
    "customer_balance": {
      "$ref": "#/components/schemas/payment_method_customer_balance"
    },
    "afterpay_clearpay": {
      "$ref": "#/components/schemas/payment_method_afterpay_clearpay"
    }
  },
  "description": "PaymentMethod objects represent your customer's payment instruments.\nYou can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to\nCustomer objects to store instrument details for future payments.\n\nRelated guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios).",
  "x-resourceId": "payment_method",
  "x-expandableFields": [
    "acss_debit",
    "affirm",
    "afterpay_clearpay",
    "alipay",
    "alma",
    "amazon_pay",
    "au_becs_debit",
    "bacs_debit",
    "bancontact",
    "billie",
    "billing_details",
    "blik",
    "boleto",
    "card",
    "card_present",
    "cashapp",
    "crypto",
    "custom",
    "customer",
    "customer_balance",
    "eps",
    "fpx",
    "giropay",
    "grabpay",
    "ideal",
    "interac_present",
    "kakao_pay",
    "klarna",
    "konbini",
    "kr_card",
    "link",
    "mb_way",
    "mobilepay",
    "multibanco",
    "naver_pay",
    "nz_bank_account",
    "oxxo",
    "p24",
    "pay_by_bank",
    "payco",
    "paynow",
    "paypal",
    "payto",
    "pix",
    "promptpay",
    "radar_options",
    "revolut_pay",
    "samsung_pay",
    "satispay",
    "sepa_debit",
    "sofort",
    "swish",
    "twint",
    "upi",
    "us_bank_account",
    "wechat_pay",
    "zip"
  ]
}

object payment_method_acss_debit

{
  "type": "object",
  "title": "payment_method_acss_debit",
  "properties": {
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last four digits of the bank account number."
    },
    "bank_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Name of the bank associated with the bank account."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."
    },
    "transit_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Transit number of the bank account."
    },
    "institution_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Institution number of the bank account."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_affirm

{
  "type": "object",
  "title": "payment_method_affirm",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_afterpay_clearpay

{
  "type": "object",
  "title": "payment_method_afterpay_clearpay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_alma

{
  "type": "object",
  "title": "payment_method_alma",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_amazon_pay

{
  "type": "object",
  "title": "payment_method_amazon_pay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_au_becs_debit

{
  "type": "object",
  "title": "payment_method_au_becs_debit",
  "properties": {
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last four digits of the bank account number."
    },
    "bsb_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Six-digit number identifying bank and branch associated with this bank account."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_bacs_debit

{
  "type": "object",
  "title": "payment_method_bacs_debit",
  "properties": {
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last four digits of the bank account number."
    },
    "sort_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Sort code of the bank account. (e.g., `10-20-30`)"
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_bancontact

{
  "type": "object",
  "title": "payment_method_bancontact",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_billie

{
  "type": "object",
  "title": "payment_method_billie",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_blik

{
  "type": "object",
  "title": "payment_method_blik",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_boleto

{
  "type": "object",
  "title": "payment_method_boleto",
  "required": [
    "tax_id"
  ],
  "properties": {
    "tax_id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Uniquely identifies the customer tax id (CNPJ or CPF)"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_card

{
  "type": "object",
  "title": "payment_method_card",
  "required": [
    "brand",
    "exp_month",
    "exp_year",
    "funding",
    "last4"
  ],
  "properties": {
    "brand": {
      "type": "string",
      "maxLength": 5000,
      "description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`."
    },
    "last4": {
      "type": "string",
      "maxLength": 5000,
      "description": "The last four digits of the card."
    },
    "checks": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_card_checks"
        }
      ],
      "nullable": true,
      "description": "Checks on Card address and CVC if provided."
    },
    "wallet": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_card_wallet"
        }
      ],
      "nullable": true,
      "description": "If this Card is part of a card wallet, this contains the details of the card wallet."
    },
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected."
    },
    "funding": {
      "type": "string",
      "maxLength": 5000,
      "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`."
    },
    "exp_year": {
      "type": "integer",
      "description": "Four-digit number representing the card's expiration year."
    },
    "networks": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/networks"
        }
      ],
      "nullable": true,
      "description": "Contains information about card networks that can be used to process the payment."
    },
    "exp_month": {
      "type": "integer",
      "description": "Two-digit number representing the card's expiration month."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*"
    },
    "display_brand": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The brand to use when displaying the card, this accounts for customer's brand choice on dual-branded cards. Can be `american_express`, `cartes_bancaires`, `diners_club`, `discover`, `eftpos_australia`, `interac`, `jcb`, `mastercard`, `union_pay`, `visa`, or `other` and may contain more values in the future."
    },
    "generated_from": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_card_generated_card"
        }
      ],
      "nullable": true,
      "description": "Details of the original PaymentMethod that created this object."
    },
    "regulated_status": {
      "enum": [
        "regulated",
        "unregulated"
      ],
      "type": "string",
      "nullable": true,
      "description": "Status of a card based on the card issuer."
    },
    "three_d_secure_usage": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/three_d_secure_usage"
        }
      ],
      "nullable": true,
      "description": "Contains details on how this Card may be used for 3D Secure authentication."
    }
  },
  "description": "",
  "x-expandableFields": [
    "checks",
    "generated_from",
    "networks",
    "three_d_secure_usage",
    "wallet"
  ]
}

object payment_method_card_checks

{
  "type": "object",
  "title": "payment_method_card_checks",
  "properties": {
    "cvc_check": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`."
    },
    "address_line1_check": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`."
    },
    "address_postal_code_check": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_card_generated_card

{
  "type": "object",
  "title": "payment_method_card_generated_card",
  "properties": {
    "charge": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The charge that created this object."
    },
    "setup_attempt": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/setup_attempt"
        }
      ],
      "nullable": true,
      "description": "The ID of the SetupAttempt that generated this PaymentMethod, if any.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/setup_attempt"
          }
        ]
      }
    },
    "payment_method_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/card_generated_from_payment_method_details"
        }
      ],
      "nullable": true,
      "description": "Transaction-specific details of the payment method used in the payment."
    }
  },
  "description": "",
  "x-expandableFields": [
    "payment_method_details",
    "setup_attempt"
  ]
}

object payment_method_card_present

{
  "type": "object",
  "title": "payment_method_card_present",
  "required": [
    "exp_month",
    "exp_year"
  ],
  "properties": {
    "brand": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`."
    },
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The last four digits of the card."
    },
    "issuer": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The name of the card's issuing bank."
    },
    "wallet": {
      "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_present_common_wallet"
    },
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected."
    },
    "funding": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`."
    },
    "offline": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_details_card_present_offline"
        }
      ],
      "nullable": true,
      "description": "Details about payment methods collected offline."
    },
    "exp_year": {
      "type": "integer",
      "description": "Four-digit number representing the card's expiration year."
    },
    "networks": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_card_present_networks"
        }
      ],
      "nullable": true,
      "description": "Contains information about card networks that can be used to process the payment."
    },
    "exp_month": {
      "type": "integer",
      "description": "Two-digit number representing the card's expiration month."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A high-level description of the type of cards issued in this range."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*"
    },
    "read_method": {
      "enum": [
        "contact_emv",
        "contactless_emv",
        "contactless_magstripe_mode",
        "magnetic_stripe_fallback",
        "magnetic_stripe_track2"
      ],
      "type": "string",
      "nullable": true,
      "description": "How card details were read in this transaction."
    },
    "brand_product": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card."
    },
    "cardholder_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay."
    },
    "preferred_locales": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip."
    }
  },
  "description": "",
  "x-expandableFields": [
    "networks",
    "offline",
    "wallet"
  ]
}

object payment_method_card_present_networks

{
  "type": "object",
  "title": "payment_method_card_present_networks",
  "required": [
    "available"
  ],
  "properties": {
    "available": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "All networks available for selection via [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network)."
    },
    "preferred": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The preferred network for the card."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_card_wallet

{
  "type": "object",
  "title": "payment_method_card_wallet",
  "required": [
    "type"
  ],
  "properties": {
    "link": {
      "$ref": "#/components/schemas/payment_method_card_wallet_link"
    },
    "type": {
      "enum": [
        "amex_express_checkout",
        "apple_pay",
        "google_pay",
        "link",
        "masterpass",
        "samsung_pay",
        "visa_checkout"
      ],
      "type": "string",
      "description": "The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, `visa_checkout`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type."
    },
    "apple_pay": {
      "$ref": "#/components/schemas/payment_method_card_wallet_apple_pay"
    },
    "google_pay": {
      "$ref": "#/components/schemas/payment_method_card_wallet_google_pay"
    },
    "masterpass": {
      "$ref": "#/components/schemas/payment_method_card_wallet_masterpass"
    },
    "samsung_pay": {
      "$ref": "#/components/schemas/payment_method_card_wallet_samsung_pay"
    },
    "dynamic_last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "(For tokenized numbers only.) The last four digits of the device account number."
    },
    "visa_checkout": {
      "$ref": "#/components/schemas/payment_method_card_wallet_visa_checkout"
    },
    "amex_express_checkout": {
      "$ref": "#/components/schemas/payment_method_card_wallet_amex_express_checkout"
    }
  },
  "description": "",
  "x-expandableFields": [
    "amex_express_checkout",
    "apple_pay",
    "google_pay",
    "link",
    "masterpass",
    "samsung_pay",
    "visa_checkout"
  ]
}

object payment_method_card_wallet_amex_express_checkout

{
  "type": "object",
  "title": "payment_method_card_wallet_amex_express_checkout",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_card_wallet_apple_pay

{
  "type": "object",
  "title": "payment_method_card_wallet_apple_pay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_card_wallet_google_pay

{
  "type": "object",
  "title": "payment_method_card_wallet_google_pay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_card_wallet_link

{
  "type": "object",
  "title": "payment_method_card_wallet_link",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_card_wallet_masterpass

{
  "type": "object",
  "title": "payment_method_card_wallet_masterpass",
  "properties": {
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."
    },
    "email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."
    },
    "billing_address": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/address"
        }
      ],
      "nullable": true,
      "description": "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."
    },
    "shipping_address": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/address"
        }
      ],
      "nullable": true,
      "description": "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."
    }
  },
  "description": "",
  "x-expandableFields": [
    "billing_address",
    "shipping_address"
  ]
}

object payment_method_card_wallet_samsung_pay

{
  "type": "object",
  "title": "payment_method_card_wallet_samsung_pay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_card_wallet_visa_checkout

{
  "type": "object",
  "title": "payment_method_card_wallet_visa_checkout",
  "properties": {
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."
    },
    "email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."
    },
    "billing_address": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/address"
        }
      ],
      "nullable": true,
      "description": "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."
    },
    "shipping_address": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/address"
        }
      ],
      "nullable": true,
      "description": "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."
    }
  },
  "description": "",
  "x-expandableFields": [
    "billing_address",
    "shipping_address"
  ]
}

object payment_method_cashapp

{
  "type": "object",
  "title": "payment_method_cashapp",
  "properties": {
    "cashtag": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A public identifier for buyers using Cash App."
    },
    "buyer_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A unique and immutable identifier assigned by Cash App to every buyer."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_config_biz_payment_method_configuration_details

{
  "type": "object",
  "title": "PaymentMethodConfigBizPaymentMethodConfigurationDetails",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "ID of the payment method configuration used."
    },
    "parent": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the parent payment method configuration used."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_config_resource_display_preference

{
  "type": "object",
  "title": "PaymentMethodConfigResourceDisplayPreference",
  "required": [
    "preference",
    "value"
  ],
  "properties": {
    "value": {
      "enum": [
        "off",
        "on"
      ],
      "type": "string",
      "description": "The effective display preference value."
    },
    "preference": {
      "enum": [
        "none",
        "off",
        "on"
      ],
      "type": "string",
      "description": "The account's display preference."
    },
    "overridable": {
      "type": "boolean",
      "nullable": true,
      "description": "For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_config_resource_payment_method_properties

{
  "type": "object",
  "title": "PaymentMethodConfigResourcePaymentMethodProperties",
  "required": [
    "available",
    "display_preference"
  ],
  "properties": {
    "available": {
      "type": "boolean",
      "description": "Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active."
    },
    "display_preference": {
      "$ref": "#/components/schemas/payment_method_config_resource_display_preference"
    }
  },
  "description": "",
  "x-expandableFields": [
    "display_preference"
  ]
}

object payment_method_configuration

{
  "type": "object",
  "title": "PaymentMethodConfigResourcePaymentMethodConfiguration",
  "required": [
    "active",
    "id",
    "is_default",
    "livemode",
    "name",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "eps": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "fpx": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "jcb": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "p24": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "pix": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "upi": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "zip": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "alma": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "blik": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "card": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "link": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The configuration's name."
    },
    "oxxo": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "ideal": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "payco": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "payto": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "swish": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "twint": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "active": {
      "type": "boolean",
      "description": "Whether the configuration can be used for new payments."
    },
    "affirm": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "alipay": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "billie": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "boleto": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "crypto": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "klarna": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "mb_way": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "object": {
      "enum": [
        "payment_method_configuration"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "parent": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "For child configs, the configuration's parent configuration."
    },
    "paynow": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "paypal": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "sofort": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "cashapp": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "giropay": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "grabpay": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "konbini": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "kr_card": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "satispay": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "apple_pay": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "kakao_pay": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "mobilepay": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "naver_pay": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "promptpay": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "acss_debit": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "amazon_pay": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "bacs_debit": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "bancontact": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "google_pay": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "is_default": {
      "type": "boolean",
      "description": "The default configuration is used whenever a payment method configuration is not specified."
    },
    "multibanco": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "sepa_debit": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "wechat_pay": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "application": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "For child configs, the Connect application associated with the configuration."
    },
    "pay_by_bank": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "revolut_pay": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "samsung_pay": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "au_becs_debit": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "nz_bank_account": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "us_bank_account": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "cartes_bancaires": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "customer_balance": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    },
    "afterpay_clearpay": {
      "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
    }
  },
  "description": "PaymentMethodConfigurations control which payment methods are displayed to your customers when you don't explicitly specify payment method types. You can have multiple configurations with different sets of payment methods for different scenarios.\n\nThere are two types of PaymentMethodConfigurations. Which is used depends on the [charge type](https://docs.stripe.com/connect/charges):\n\n**Direct** configurations apply to payments created on your account, including Connect destination charges, Connect separate charges and transfers, and payments not involving Connect.\n\n**Child** configurations apply to payments created on your connected accounts using direct charges, and charges with the on_behalf_of parameter.\n\nChild configurations have a `parent` that sets default values and controls which settings connected accounts may override. You can specify a parent ID at payment time, and Stripe will automatically resolve the connected account’s associated child configuration. Parent configurations are [managed in the dashboard](https://dashboard.stripe.com/settings/payment_methods/connected_accounts) and are not available in this API.\n\nRelated guides:\n- [Payment Method Configurations API](https://docs.stripe.com/connect/payment-method-configurations)\n- [Multiple configurations on dynamic payment methods](https://docs.stripe.com/payments/multiple-payment-method-configs)\n- [Multiple configurations for your Connect accounts](https://docs.stripe.com/connect/multiple-payment-method-configurations)",
  "x-resourceId": "payment_method_configuration",
  "x-expandableFields": [
    "acss_debit",
    "affirm",
    "afterpay_clearpay",
    "alipay",
    "alma",
    "amazon_pay",
    "apple_pay",
    "au_becs_debit",
    "bacs_debit",
    "bancontact",
    "billie",
    "blik",
    "boleto",
    "card",
    "cartes_bancaires",
    "cashapp",
    "crypto",
    "customer_balance",
    "eps",
    "fpx",
    "giropay",
    "google_pay",
    "grabpay",
    "ideal",
    "jcb",
    "kakao_pay",
    "klarna",
    "konbini",
    "kr_card",
    "link",
    "mb_way",
    "mobilepay",
    "multibanco",
    "naver_pay",
    "nz_bank_account",
    "oxxo",
    "p24",
    "pay_by_bank",
    "payco",
    "paynow",
    "paypal",
    "payto",
    "pix",
    "promptpay",
    "revolut_pay",
    "samsung_pay",
    "satispay",
    "sepa_debit",
    "sofort",
    "swish",
    "twint",
    "upi",
    "us_bank_account",
    "wechat_pay",
    "zip"
  ]
}

object payment_method_crypto

{
  "type": "object",
  "title": "payment_method_crypto",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_custom

{
  "type": "object",
  "title": "payment_method_custom",
  "required": [
    "type"
  ],
  "properties": {
    "logo": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/custom_logo"
        }
      ],
      "nullable": true,
      "description": "Contains information about the Dashboard-only CustomPaymentMethodType logo."
    },
    "type": {
      "type": "string",
      "maxLength": 5000,
      "description": "ID of the Dashboard-only CustomPaymentMethodType. Not expandable."
    },
    "display_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Display name of the Dashboard-only CustomPaymentMethodType."
    }
  },
  "description": "",
  "x-expandableFields": [
    "logo"
  ]
}

object payment_method_customer_balance

{
  "type": "object",
  "title": "payment_method_customer_balance",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_details

{
  "type": "object",
  "title": "payment_method_details",
  "required": [
    "type"
  ],
  "properties": {
    "eps": {
      "$ref": "#/components/schemas/payment_method_details_eps"
    },
    "fpx": {
      "$ref": "#/components/schemas/payment_method_details_fpx"
    },
    "p24": {
      "$ref": "#/components/schemas/payment_method_details_p24"
    },
    "pix": {
      "$ref": "#/components/schemas/payment_method_details_pix"
    },
    "upi": {
      "$ref": "#/components/schemas/payment_method_details_upi"
    },
    "zip": {
      "$ref": "#/components/schemas/payment_method_details_zip"
    },
    "alma": {
      "$ref": "#/components/schemas/payment_method_details_alma"
    },
    "blik": {
      "$ref": "#/components/schemas/payment_method_details_blik"
    },
    "card": {
      "$ref": "#/components/schemas/payment_method_details_card"
    },
    "link": {
      "$ref": "#/components/schemas/payment_method_details_link"
    },
    "oxxo": {
      "$ref": "#/components/schemas/payment_method_details_oxxo"
    },
    "type": {
      "type": "string",
      "maxLength": 5000,
      "description": "The type of transaction-specific details of the payment method used in the payment. See [PaymentMethod.type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type) for the full list of possible types.\nAn additional hash is included on `payment_method_details` with a name matching this value.\nIt contains information specific to the payment method."
    },
    "ideal": {
      "$ref": "#/components/schemas/payment_method_details_ideal"
    },
    "payco": {
      "$ref": "#/components/schemas/payment_method_details_payco"
    },
    "payto": {
      "$ref": "#/components/schemas/payment_method_details_payto"
    },
    "swish": {
      "$ref": "#/components/schemas/payment_method_details_swish"
    },
    "twint": {
      "$ref": "#/components/schemas/payment_method_details_twint"
    },
    "affirm": {
      "$ref": "#/components/schemas/payment_method_details_affirm"
    },
    "alipay": {
      "$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay_details"
    },
    "billie": {
      "$ref": "#/components/schemas/payment_method_details_billie"
    },
    "boleto": {
      "$ref": "#/components/schemas/payment_method_details_boleto"
    },
    "crypto": {
      "$ref": "#/components/schemas/payment_method_details_crypto"
    },
    "klarna": {
      "$ref": "#/components/schemas/payment_method_details_klarna"
    },
    "mb_way": {
      "$ref": "#/components/schemas/payment_method_details_mb_way"
    },
    "paynow": {
      "$ref": "#/components/schemas/payment_method_details_paynow"
    },
    "paypal": {
      "$ref": "#/components/schemas/payment_method_details_paypal"
    },
    "sofort": {
      "$ref": "#/components/schemas/payment_method_details_sofort"
    },
    "wechat": {
      "$ref": "#/components/schemas/payment_method_details_wechat"
    },
    "cashapp": {
      "$ref": "#/components/schemas/payment_method_details_cashapp"
    },
    "giropay": {
      "$ref": "#/components/schemas/payment_method_details_giropay"
    },
    "grabpay": {
      "$ref": "#/components/schemas/payment_method_details_grabpay"
    },
    "konbini": {
      "$ref": "#/components/schemas/payment_method_details_konbini"
    },
    "kr_card": {
      "$ref": "#/components/schemas/payment_method_details_kr_card"
    },
    "satispay": {
      "$ref": "#/components/schemas/payment_method_details_satispay"
    },
    "ach_debit": {
      "$ref": "#/components/schemas/payment_method_details_ach_debit"
    },
    "kakao_pay": {
      "$ref": "#/components/schemas/payment_method_details_kakao_pay"
    },
    "mobilepay": {
      "$ref": "#/components/schemas/payment_method_details_mobilepay"
    },
    "naver_pay": {
      "$ref": "#/components/schemas/payment_method_details_naver_pay"
    },
    "promptpay": {
      "$ref": "#/components/schemas/payment_method_details_promptpay"
    },
    "acss_debit": {
      "$ref": "#/components/schemas/payment_method_details_acss_debit"
    },
    "amazon_pay": {
      "$ref": "#/components/schemas/payment_method_details_amazon_pay"
    },
    "bacs_debit": {
      "$ref": "#/components/schemas/payment_method_details_bacs_debit"
    },
    "bancontact": {
      "$ref": "#/components/schemas/payment_method_details_bancontact"
    },
    "multibanco": {
      "$ref": "#/components/schemas/payment_method_details_multibanco"
    },
    "sepa_debit": {
      "$ref": "#/components/schemas/payment_method_details_sepa_debit"
    },
    "wechat_pay": {
      "$ref": "#/components/schemas/payment_method_details_wechat_pay"
    },
    "pay_by_bank": {
      "$ref": "#/components/schemas/payment_method_details_pay_by_bank"
    },
    "revolut_pay": {
      "$ref": "#/components/schemas/payment_method_details_revolut_pay"
    },
    "samsung_pay": {
      "$ref": "#/components/schemas/payment_method_details_samsung_pay"
    },
    "card_present": {
      "$ref": "#/components/schemas/payment_method_details_card_present"
    },
    "au_becs_debit": {
      "$ref": "#/components/schemas/payment_method_details_au_becs_debit"
    },
    "stripe_account": {
      "$ref": "#/components/schemas/payment_method_details_stripe_account"
    },
    "interac_present": {
      "$ref": "#/components/schemas/payment_method_details_interac_present"
    },
    "nz_bank_account": {
      "$ref": "#/components/schemas/payment_method_details_nz_bank_account"
    },
    "us_bank_account": {
      "$ref": "#/components/schemas/payment_method_details_us_bank_account"
    },
    "customer_balance": {
      "$ref": "#/components/schemas/payment_method_details_customer_balance"
    },
    "afterpay_clearpay": {
      "$ref": "#/components/schemas/payment_method_details_afterpay_clearpay"
    },
    "ach_credit_transfer": {
      "$ref": "#/components/schemas/payment_method_details_ach_credit_transfer"
    }
  },
  "description": "",
  "x-expandableFields": [
    "ach_credit_transfer",
    "ach_debit",
    "acss_debit",
    "affirm",
    "afterpay_clearpay",
    "alipay",
    "alma",
    "amazon_pay",
    "au_becs_debit",
    "bacs_debit",
    "bancontact",
    "billie",
    "blik",
    "boleto",
    "card",
    "card_present",
    "cashapp",
    "crypto",
    "customer_balance",
    "eps",
    "fpx",
    "giropay",
    "grabpay",
    "ideal",
    "interac_present",
    "kakao_pay",
    "klarna",
    "konbini",
    "kr_card",
    "link",
    "mb_way",
    "mobilepay",
    "multibanco",
    "naver_pay",
    "nz_bank_account",
    "oxxo",
    "p24",
    "pay_by_bank",
    "payco",
    "paynow",
    "paypal",
    "payto",
    "pix",
    "promptpay",
    "revolut_pay",
    "samsung_pay",
    "satispay",
    "sepa_debit",
    "sofort",
    "stripe_account",
    "swish",
    "twint",
    "upi",
    "us_bank_account",
    "wechat",
    "wechat_pay",
    "zip"
  ]
}

object payment_method_details_ach_credit_transfer

{
  "type": "object",
  "title": "payment_method_details_ach_credit_transfer",
  "properties": {
    "bank_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Name of the bank associated with the routing number."
    },
    "swift_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "SWIFT code of the bank associated with the routing number."
    },
    "account_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Account number to transfer funds to."
    },
    "routing_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Routing transit number for the bank account to transfer funds to."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_ach_debit

{
  "type": "object",
  "title": "payment_method_details_ach_debit",
  "properties": {
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last four digits of the bank account number."
    },
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter ISO code representing the country the bank account is located in."
    },
    "bank_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Name of the bank associated with the bank account."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."
    },
    "routing_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Routing transit number of the bank account."
    },
    "account_holder_type": {
      "enum": [
        "company",
        "individual"
      ],
      "type": "string",
      "nullable": true,
      "description": "Type of entity that holds the account. This can be either `individual` or `company`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_acss_debit

{
  "type": "object",
  "title": "payment_method_details_acss_debit",
  "properties": {
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last four digits of the bank account number."
    },
    "mandate": {
      "type": "string",
      "maxLength": 5000,
      "description": "ID of the mandate used to make this payment."
    },
    "bank_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Name of the bank associated with the bank account."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."
    },
    "transit_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Transit number of the bank account."
    },
    "institution_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Institution number of the bank account"
    },
    "expected_debit_date": {
      "type": "string",
      "maxLength": 5000,
      "description": "Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_affirm

{
  "type": "object",
  "title": "payment_method_details_affirm",
  "properties": {
    "reader": {
      "type": "string",
      "maxLength": 5000,
      "description": "ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on."
    },
    "location": {
      "type": "string",
      "maxLength": 5000,
      "description": "ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to."
    },
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Affirm transaction ID associated with this payment."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_afterpay_clearpay

{
  "type": "object",
  "title": "payment_method_details_afterpay_clearpay",
  "properties": {
    "order_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Afterpay order ID associated with this payment intent."
    },
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Order identifier shown to the merchant in Afterpay’s online portal."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_alma

{
  "type": "object",
  "title": "payment_method_details_alma",
  "properties": {
    "installments": {
      "$ref": "#/components/schemas/alma_installments"
    },
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Alma transaction ID associated with this payment."
    }
  },
  "description": "",
  "x-expandableFields": [
    "installments"
  ]
}

object payment_method_details_amazon_pay

{
  "type": "object",
  "title": "payment_method_details_amazon_pay",
  "properties": {
    "funding": {
      "$ref": "#/components/schemas/amazon_pay_underlying_payment_method_funding_details"
    },
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Amazon Pay transaction ID associated with this payment."
    }
  },
  "description": "",
  "x-expandableFields": [
    "funding"
  ]
}

object payment_method_details_au_becs_debit

{
  "type": "object",
  "title": "payment_method_details_au_becs_debit",
  "properties": {
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last four digits of the bank account number."
    },
    "mandate": {
      "type": "string",
      "maxLength": 5000,
      "description": "ID of the mandate used to make this payment."
    },
    "bsb_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Bank-State-Branch number of the bank account."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."
    },
    "expected_debit_date": {
      "type": "string",
      "maxLength": 5000,
      "description": "Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_bacs_debit

{
  "type": "object",
  "title": "payment_method_details_bacs_debit",
  "properties": {
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last four digits of the bank account number."
    },
    "mandate": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the mandate used to make this payment."
    },
    "sort_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Sort code of the bank account. (e.g., `10-20-30`)"
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."
    },
    "expected_debit_date": {
      "type": "string",
      "maxLength": 5000,
      "description": "Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_bancontact

{
  "type": "object",
  "title": "payment_method_details_bancontact",
  "properties": {
    "bic": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Bank Identifier Code of the bank associated with the bank account."
    },
    "bank_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Bank code of bank associated with the bank account."
    },
    "bank_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Name of the bank associated with the bank account."
    },
    "iban_last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last four characters of the IBAN."
    },
    "verified_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Owner's verified full name. Values are verified or provided by Bancontact directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated."
    },
    "preferred_language": {
      "enum": [
        "de",
        "en",
        "fr",
        "nl"
      ],
      "type": "string",
      "nullable": true,
      "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.\nCan be one of `en`, `de`, `fr`, or `nl`"
    },
    "generated_sepa_debit": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_method"
        }
      ],
      "nullable": true,
      "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_method"
          }
        ]
      }
    },
    "generated_sepa_debit_mandate": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/mandate"
        }
      ],
      "nullable": true,
      "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/mandate"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "generated_sepa_debit",
    "generated_sepa_debit_mandate"
  ]
}

object payment_method_details_billie

{
  "type": "object",
  "title": "payment_method_details_billie",
  "properties": {
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Billie transaction ID associated with this payment."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_blik

{
  "type": "object",
  "title": "payment_method_details_blik",
  "properties": {
    "buyer_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A unique and immutable identifier assigned by BLIK to every buyer."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_boleto

{
  "type": "object",
  "title": "payment_method_details_boleto",
  "required": [
    "tax_id"
  ],
  "properties": {
    "tax_id": {
      "type": "string",
      "maxLength": 5000,
      "description": "The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers)"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_card

{
  "type": "object",
  "title": "payment_method_details_card",
  "required": [
    "exp_month",
    "exp_year"
  ],
  "properties": {
    "brand": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`."
    },
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The last four digits of the card."
    },
    "checks": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_details_card_checks"
        }
      ],
      "nullable": true,
      "description": "Check results by Card networks on Card address and CVC at time of payment."
    },
    "wallet": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_details_card_wallet"
        }
      ],
      "nullable": true,
      "description": "If this Card is part of a card wallet, this contains the details of the card wallet."
    },
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected."
    },
    "funding": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`."
    },
    "mandate": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the mandate used to make this payment or created by it."
    },
    "network": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`."
    },
    "exp_year": {
      "type": "integer",
      "description": "Four-digit number representing the card's expiration year."
    },
    "exp_month": {
      "type": "integer",
      "description": "Two-digit number representing the card's expiration month."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*"
    },
    "overcapture": {
      "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_overcapture_overcapture"
    },
    "installments": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_details_card_installments"
        }
      ],
      "nullable": true,
      "description": "Installment details for this payment.\n\nFor more information, see the [installments integration guide](https://docs.stripe.com/payments/installments)."
    },
    "multicapture": {
      "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_multicapture"
    },
    "network_token": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_details_card_network_token"
        }
      ],
      "nullable": true,
      "description": "If this card has network token credentials, this contains the details of the network token credentials."
    },
    "capture_before": {
      "type": "integer",
      "format": "unix-time",
      "description": "When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured."
    },
    "three_d_secure": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/three_d_secure_details_charge"
        }
      ],
      "nullable": true,
      "description": "Populated if this transaction used 3D Secure authentication."
    },
    "regulated_status": {
      "enum": [
        "regulated",
        "unregulated"
      ],
      "type": "string",
      "nullable": true,
      "description": "Status of a card based on the card issuer."
    },
    "amount_authorized": {
      "type": "integer",
      "nullable": true,
      "description": "The authorized amount."
    },
    "authorization_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Authorization code on the charge."
    },
    "extended_authorization": {
      "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_extended_authorization_extended_authorization"
    },
    "network_transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise."
    },
    "incremental_authorization": {
      "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_incremental_authorization_incremental_authorization"
    }
  },
  "description": "",
  "x-expandableFields": [
    "checks",
    "extended_authorization",
    "incremental_authorization",
    "installments",
    "multicapture",
    "network_token",
    "overcapture",
    "three_d_secure",
    "wallet"
  ]
}

object payment_method_details_card_checks

{
  "type": "object",
  "title": "payment_method_details_card_checks",
  "properties": {
    "cvc_check": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`."
    },
    "address_line1_check": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`."
    },
    "address_postal_code_check": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_card_installments

{
  "type": "object",
  "title": "payment_method_details_card_installments",
  "properties": {
    "plan": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_details_card_installments_plan"
        }
      ],
      "nullable": true,
      "description": "Installment plan selected for the payment."
    }
  },
  "description": "",
  "x-expandableFields": [
    "plan"
  ]
}

object payment_method_details_card_installments_plan

{
  "type": "object",
  "title": "payment_method_details_card_installments_plan",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "bonus",
        "fixed_count",
        "revolving"
      ],
      "type": "string",
      "description": "Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`."
    },
    "count": {
      "type": "integer",
      "nullable": true,
      "description": "For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card."
    },
    "interval": {
      "enum": [
        "month"
      ],
      "type": "string",
      "nullable": true,
      "description": "For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_card_network_token

{
  "type": "object",
  "title": "payment_method_details_card_network_token",
  "required": [
    "used"
  ],
  "properties": {
    "used": {
      "type": "boolean",
      "description": "Indicates if Stripe used a network token, either user provided or Stripe managed when processing the transaction."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_card_present

{
  "type": "object",
  "title": "payment_method_details_card_present",
  "required": [
    "exp_month",
    "exp_year",
    "incremental_authorization_supported",
    "overcapture_supported"
  ],
  "properties": {
    "brand": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`."
    },
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The last four digits of the card."
    },
    "issuer": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The name of the card's issuing bank."
    },
    "reader": {
      "type": "string",
      "maxLength": 5000,
      "description": "ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on."
    },
    "wallet": {
      "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_present_common_wallet"
    },
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected."
    },
    "funding": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`."
    },
    "network": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`."
    },
    "offline": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_details_card_present_offline"
        }
      ],
      "nullable": true,
      "description": "Details about payments collected offline."
    },
    "receipt": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_details_card_present_receipt"
        }
      ],
      "nullable": true,
      "description": "A collection of fields required to be displayed on receipts. Only required for EMV transactions."
    },
    "exp_year": {
      "type": "integer",
      "description": "Four-digit number representing the card's expiration year."
    },
    "location": {
      "type": "string",
      "maxLength": 5000,
      "description": "ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to."
    },
    "exp_month": {
      "type": "integer",
      "description": "Two-digit number representing the card's expiration month."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A high-level description of the type of cards issued in this range."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*"
    },
    "read_method": {
      "enum": [
        "contact_emv",
        "contactless_emv",
        "contactless_magstripe_mode",
        "magnetic_stripe_fallback",
        "magnetic_stripe_track2"
      ],
      "type": "string",
      "nullable": true,
      "description": "How card details were read in this transaction."
    },
    "brand_product": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card."
    },
    "emv_auth_data": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Authorization response cryptogram."
    },
    "capture_before": {
      "type": "integer",
      "format": "unix-time",
      "description": "When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured."
    },
    "generated_card": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod."
    },
    "cardholder_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay."
    },
    "amount_authorized": {
      "type": "integer",
      "nullable": true,
      "description": "The authorized amount"
    },
    "preferred_locales": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip."
    },
    "overcapture_supported": {
      "type": "boolean",
      "description": "Defines whether the authorized amount can be over-captured or not"
    },
    "network_transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise."
    },
    "incremental_authorization_supported": {
      "type": "boolean",
      "description": "Whether this [PaymentIntent](https://docs.stripe.com/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support)."
    }
  },
  "description": "",
  "x-expandableFields": [
    "offline",
    "receipt",
    "wallet"
  ]
}

object payment_method_details_card_present_offline

{
  "type": "object",
  "title": "payment_method_details_card_present_offline",
  "properties": {
    "type": {
      "enum": [
        "deferred"
      ],
      "type": "string",
      "nullable": true,
      "description": "The method used to process this payment method offline. Only deferred is allowed."
    },
    "stored_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Time at which the payment was collected while offline"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_card_present_receipt

{
  "type": "object",
  "title": "payment_method_details_card_present_receipt",
  "properties": {
    "account_type": {
      "enum": [
        "checking",
        "credit",
        "prepaid",
        "unknown"
      ],
      "type": "string",
      "description": "The type of account being debited or credited",
      "x-stripeBypassValidation": true
    },
    "authorization_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Identifier for this transaction."
    },
    "dedicated_file_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Similar to the application_preferred_name, identifying the applications (AIDs) available on the card. Referenced from EMV tag 84."
    },
    "application_cryptogram": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Application Cryptogram, a unique value generated by the card to authenticate the transaction with issuers."
    },
    "application_preferred_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Application Identifier (AID) on the card used to determine which networks are eligible to process the transaction. Referenced from EMV tag 9F12, data encoded on the card's chip."
    },
    "authorization_response_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "EMV tag 8A. A code returned by the card issuer."
    },
    "terminal_verification_results": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A 5-byte string that records the checks and validations that occur between the card and the terminal. These checks determine how the terminal processes the transaction and what risk tolerance is acceptable. Referenced from EMV Tag 95."
    },
    "cardholder_verification_method": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`."
    },
    "transaction_status_information": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An indication of which steps were completed during the card read process. Referenced from EMV Tag 9B."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_card_wallet

{
  "type": "object",
  "title": "payment_method_details_card_wallet",
  "required": [
    "type"
  ],
  "properties": {
    "link": {
      "$ref": "#/components/schemas/payment_method_details_card_wallet_link"
    },
    "type": {
      "enum": [
        "amex_express_checkout",
        "apple_pay",
        "google_pay",
        "link",
        "masterpass",
        "samsung_pay",
        "visa_checkout"
      ],
      "type": "string",
      "description": "The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, `visa_checkout`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type."
    },
    "apple_pay": {
      "$ref": "#/components/schemas/payment_method_details_card_wallet_apple_pay"
    },
    "google_pay": {
      "$ref": "#/components/schemas/payment_method_details_card_wallet_google_pay"
    },
    "masterpass": {
      "$ref": "#/components/schemas/payment_method_details_card_wallet_masterpass"
    },
    "samsung_pay": {
      "$ref": "#/components/schemas/payment_method_details_card_wallet_samsung_pay"
    },
    "dynamic_last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "(For tokenized numbers only.) The last four digits of the device account number."
    },
    "visa_checkout": {
      "$ref": "#/components/schemas/payment_method_details_card_wallet_visa_checkout"
    },
    "amex_express_checkout": {
      "$ref": "#/components/schemas/payment_method_details_card_wallet_amex_express_checkout"
    }
  },
  "description": "",
  "x-expandableFields": [
    "amex_express_checkout",
    "apple_pay",
    "google_pay",
    "link",
    "masterpass",
    "samsung_pay",
    "visa_checkout"
  ]
}

object payment_method_details_card_wallet_amex_express_checkout

{
  "type": "object",
  "title": "payment_method_details_card_wallet_amex_express_checkout",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_card_wallet_apple_pay

{
  "type": "object",
  "title": "payment_method_details_card_wallet_apple_pay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_card_wallet_google_pay

{
  "type": "object",
  "title": "payment_method_details_card_wallet_google_pay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_card_wallet_link

{
  "type": "object",
  "title": "payment_method_details_card_wallet_link",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_card_wallet_masterpass

{
  "type": "object",
  "title": "payment_method_details_card_wallet_masterpass",
  "properties": {
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."
    },
    "email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."
    },
    "billing_address": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/address"
        }
      ],
      "nullable": true,
      "description": "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."
    },
    "shipping_address": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/address"
        }
      ],
      "nullable": true,
      "description": "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."
    }
  },
  "description": "",
  "x-expandableFields": [
    "billing_address",
    "shipping_address"
  ]
}

object payment_method_details_card_wallet_samsung_pay

{
  "type": "object",
  "title": "payment_method_details_card_wallet_samsung_pay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_card_wallet_visa_checkout

{
  "type": "object",
  "title": "payment_method_details_card_wallet_visa_checkout",
  "properties": {
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."
    },
    "email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."
    },
    "billing_address": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/address"
        }
      ],
      "nullable": true,
      "description": "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."
    },
    "shipping_address": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/address"
        }
      ],
      "nullable": true,
      "description": "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."
    }
  },
  "description": "",
  "x-expandableFields": [
    "billing_address",
    "shipping_address"
  ]
}

object payment_method_details_cashapp

{
  "type": "object",
  "title": "payment_method_details_cashapp",
  "properties": {
    "cashtag": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A public identifier for buyers using Cash App."
    },
    "buyer_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A unique and immutable identifier assigned by Cash App to every buyer."
    },
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A unique and immutable identifier of payments assigned by Cash App"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_crypto

{
  "type": "object",
  "title": "payment_method_details_crypto",
  "properties": {
    "network": {
      "enum": [
        "base",
        "ethereum",
        "polygon",
        "solana",
        "tempo"
      ],
      "type": "string",
      "description": "The blockchain network that the transaction was sent on."
    },
    "buyer_address": {
      "type": "string",
      "maxLength": 5000,
      "description": "The wallet address of the customer."
    },
    "token_currency": {
      "enum": [
        "usdc",
        "usdg",
        "usdp"
      ],
      "type": "string",
      "description": "The token currency that the transaction was sent with.",
      "x-stripeBypassValidation": true
    },
    "transaction_hash": {
      "type": "string",
      "maxLength": 5000,
      "description": "The blockchain transaction hash of the crypto payment."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_customer_balance

{
  "type": "object",
  "title": "payment_method_details_customer_balance",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_eps

{
  "type": "object",
  "title": "payment_method_details_eps",
  "properties": {
    "bank": {
      "enum": [
        "arzte_und_apotheker_bank",
        "austrian_anadi_bank_ag",
        "bank_austria",
        "bankhaus_carl_spangler",
        "bankhaus_schelhammer_und_schattera_ag",
        "bawag_psk_ag",
        "bks_bank_ag",
        "brull_kallmus_bank_ag",
        "btv_vier_lander_bank",
        "capital_bank_grawe_gruppe_ag",
        "deutsche_bank_ag",
        "dolomitenbank",
        "easybank_ag",
        "erste_bank_und_sparkassen",
        "hypo_alpeadriabank_international_ag",
        "hypo_bank_burgenland_aktiengesellschaft",
        "hypo_noe_lb_fur_niederosterreich_u_wien",
        "hypo_oberosterreich_salzburg_steiermark",
        "hypo_tirol_bank_ag",
        "hypo_vorarlberg_bank_ag",
        "marchfelder_bank",
        "oberbank_ag",
        "raiffeisen_bankengruppe_osterreich",
        "schoellerbank_ag",
        "sparda_bank_wien",
        "volksbank_gruppe",
        "volkskreditbank_ag",
        "vr_bank_braunau"
      ],
      "type": "string",
      "nullable": true,
      "description": "The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`."
    },
    "verified_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Owner's verified full name. Values are verified or provided by EPS directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nEPS rarely provides this information so the attribute is usually empty."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_fpx

{
  "type": "object",
  "title": "payment_method_details_fpx",
  "required": [
    "bank"
  ],
  "properties": {
    "bank": {
      "enum": [
        "affin_bank",
        "agrobank",
        "alliance_bank",
        "ambank",
        "bank_islam",
        "bank_muamalat",
        "bank_of_china",
        "bank_rakyat",
        "bsn",
        "cimb",
        "deutsche_bank",
        "hong_leong_bank",
        "hsbc",
        "kfh",
        "maybank2e",
        "maybank2u",
        "ocbc",
        "pb_enterprise",
        "public_bank",
        "rhb",
        "standard_chartered",
        "uob"
      ],
      "type": "string",
      "description": "The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`."
    },
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Unique transaction id generated by FPX for every request from the merchant"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_giropay

{
  "type": "object",
  "title": "payment_method_details_giropay",
  "properties": {
    "bic": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Bank Identifier Code of the bank associated with the bank account."
    },
    "bank_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Bank code of bank associated with the bank account."
    },
    "bank_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Name of the bank associated with the bank account."
    },
    "verified_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Owner's verified full name. Values are verified or provided by Giropay directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nGiropay rarely provides this information so the attribute is usually empty."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_grabpay

{
  "type": "object",
  "title": "payment_method_details_grabpay",
  "properties": {
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Unique transaction id generated by GrabPay"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_ideal

{
  "type": "object",
  "title": "payment_method_details_ideal",
  "properties": {
    "bic": {
      "enum": [
        "ABNANL2A",
        "ADYBNL2A",
        "ASNBNL21",
        "BITSNL2A",
        "BUNQNL2A",
        "BUUTNL2A",
        "FNOMNL22",
        "FVLBNL22",
        "HANDNL2A",
        "INGBNL2A",
        "KNABNL2H",
        "MLLENL2A",
        "MOYONL21",
        "NNBANL2G",
        "NTSBDEB1",
        "RABONL2U",
        "RBRBNL21",
        "REVOIE23",
        "REVOLT21",
        "SNSBNL2A",
        "TRIONL2U"
      ],
      "type": "string",
      "nullable": true,
      "description": "The Bank Identifier Code of the customer's bank."
    },
    "bank": {
      "enum": [
        "abn_amro",
        "adyen",
        "asn_bank",
        "bunq",
        "buut",
        "finom",
        "handelsbanken",
        "ing",
        "knab",
        "mollie",
        "moneyou",
        "n26",
        "nn",
        "rabobank",
        "regiobank",
        "revolut",
        "sns_bank",
        "triodos_bank",
        "van_lanschot",
        "yoursafe"
      ],
      "type": "string",
      "nullable": true,
      "description": "The customer's bank. Can be one of `abn_amro`, `adyen`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`."
    },
    "iban_last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last four characters of the IBAN."
    },
    "verified_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Owner's verified full name. Values are verified or provided by iDEAL directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated."
    },
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Unique transaction ID generated by iDEAL."
    },
    "generated_sepa_debit": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_method"
        }
      ],
      "nullable": true,
      "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_method"
          }
        ]
      }
    },
    "generated_sepa_debit_mandate": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/mandate"
        }
      ],
      "nullable": true,
      "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/mandate"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "generated_sepa_debit",
    "generated_sepa_debit_mandate"
  ]
}

object payment_method_details_interac_present

{
  "type": "object",
  "title": "payment_method_details_interac_present",
  "required": [
    "exp_month",
    "exp_year"
  ],
  "properties": {
    "brand": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Card brand. Can be `interac`, `mastercard` or `visa`."
    },
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The last four digits of the card."
    },
    "issuer": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The name of the card's issuing bank."
    },
    "reader": {
      "type": "string",
      "maxLength": 5000,
      "description": "ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on."
    },
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected."
    },
    "funding": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`."
    },
    "network": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`."
    },
    "receipt": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_details_interac_present_receipt"
        }
      ],
      "nullable": true,
      "description": "A collection of fields required to be displayed on receipts. Only required for EMV transactions."
    },
    "exp_year": {
      "type": "integer",
      "description": "Four-digit number representing the card's expiration year."
    },
    "location": {
      "type": "string",
      "maxLength": 5000,
      "description": "ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to."
    },
    "exp_month": {
      "type": "integer",
      "description": "Two-digit number representing the card's expiration month."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A high-level description of the type of cards issued in this range."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*"
    },
    "read_method": {
      "enum": [
        "contact_emv",
        "contactless_emv",
        "contactless_magstripe_mode",
        "magnetic_stripe_fallback",
        "magnetic_stripe_track2"
      ],
      "type": "string",
      "nullable": true,
      "description": "How card details were read in this transaction."
    },
    "emv_auth_data": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Authorization response cryptogram."
    },
    "generated_card": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod."
    },
    "cardholder_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay."
    },
    "preferred_locales": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip."
    },
    "network_transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise."
    }
  },
  "description": "",
  "x-expandableFields": [
    "receipt"
  ]
}

object payment_method_details_interac_present_receipt

{
  "type": "object",
  "title": "payment_method_details_interac_present_receipt",
  "properties": {
    "account_type": {
      "enum": [
        "checking",
        "savings",
        "unknown"
      ],
      "type": "string",
      "description": "The type of account being debited or credited",
      "x-stripeBypassValidation": true
    },
    "authorization_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Identifier for this transaction."
    },
    "dedicated_file_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Similar to the application_preferred_name, identifying the applications (AIDs) available on the card. Referenced from EMV tag 84."
    },
    "application_cryptogram": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Application Cryptogram, a unique value generated by the card to authenticate the transaction with issuers."
    },
    "application_preferred_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Application Identifier (AID) on the card used to determine which networks are eligible to process the transaction. Referenced from EMV tag 9F12, data encoded on the card's chip."
    },
    "authorization_response_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "EMV tag 8A. A code returned by the card issuer."
    },
    "terminal_verification_results": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A 5-byte string that records the checks and validations that occur between the card and the terminal. These checks determine how the terminal processes the transaction and what risk tolerance is acceptable. Referenced from EMV Tag 95."
    },
    "cardholder_verification_method": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`."
    },
    "transaction_status_information": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An indication of which steps were completed during the card read process. Referenced from EMV Tag 9B."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_kakao_pay

{
  "type": "object",
  "title": "payment_method_details_kakao_pay",
  "properties": {
    "buyer_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A unique identifier for the buyer as determined by the local payment processor."
    },
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Kakao Pay transaction ID associated with this payment."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_klarna

{
  "type": "object",
  "title": "payment_method_details_klarna",
  "properties": {
    "payer_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/klarna_payer_details"
        }
      ],
      "nullable": true,
      "description": "The payer details for this transaction."
    },
    "preferred_locale": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Preferred language of the Klarna authorization page that the customer is redirected to.\nCan be one of `de-AT`, `en-AT`, `nl-BE`, `fr-BE`, `en-BE`, `de-DE`, `en-DE`, `da-DK`, `en-DK`, `es-ES`, `en-ES`, `fi-FI`, `sv-FI`, `en-FI`, `en-GB`, `en-IE`, `it-IT`, `en-IT`, `nl-NL`, `en-NL`, `nb-NO`, `en-NO`, `sv-SE`, `en-SE`, `en-US`, `es-US`, `fr-FR`, `en-FR`, `cs-CZ`, `en-CZ`, `ro-RO`, `en-RO`, `el-GR`, `en-GR`, `en-AU`, `en-NZ`, `en-CA`, `fr-CA`, `pl-PL`, `en-PL`, `pt-PT`, `en-PT`, `de-CH`, `fr-CH`, `it-CH`, or `en-CH`"
    },
    "payment_method_category": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Klarna payment method used for this transaction.\nCan be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments`"
    }
  },
  "description": "",
  "x-expandableFields": [
    "payer_details"
  ]
}

object payment_method_details_konbini

{
  "type": "object",
  "title": "payment_method_details_konbini",
  "properties": {
    "store": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_details_konbini_store"
        }
      ],
      "nullable": true,
      "description": "If the payment succeeded, this contains the details of the convenience store where the payment was completed."
    }
  },
  "description": "",
  "x-expandableFields": [
    "store"
  ]
}

object payment_method_details_konbini_store

{
  "type": "object",
  "title": "payment_method_details_konbini_store",
  "properties": {
    "chain": {
      "enum": [
        "familymart",
        "lawson",
        "ministop",
        "seicomart"
      ],
      "type": "string",
      "nullable": true,
      "description": "The name of the convenience store chain where the payment was completed.",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_kr_card

{
  "type": "object",
  "title": "payment_method_details_kr_card",
  "properties": {
    "brand": {
      "enum": [
        "bc",
        "citi",
        "hana",
        "hyundai",
        "jeju",
        "jeonbuk",
        "kakaobank",
        "kbank",
        "kdbbank",
        "kookmin",
        "kwangju",
        "lotte",
        "mg",
        "nh",
        "post",
        "samsung",
        "savingsbank",
        "shinhan",
        "shinhyup",
        "suhyup",
        "tossbank",
        "woori"
      ],
      "type": "string",
      "nullable": true,
      "description": "The local credit or debit card brand."
    },
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 4,
      "description": "The last four digits of the card. This may not be present for American Express cards."
    },
    "buyer_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A unique identifier for the buyer as determined by the local payment processor."
    },
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Korean Card transaction ID associated with this payment."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_link

{
  "type": "object",
  "title": "payment_method_details_link",
  "properties": {
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter ISO code representing the funding source country beneath the Link payment.\nYou could use this attribute to get a sense of international fees."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_mb_way

{
  "type": "object",
  "title": "payment_method_details_mb_way",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_mobilepay

{
  "type": "object",
  "title": "payment_method_details_mobilepay",
  "properties": {
    "card": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/internal_card"
        }
      ],
      "nullable": true,
      "description": "Internal card details"
    }
  },
  "description": "",
  "x-expandableFields": [
    "card"
  ]
}

object payment_method_details_multibanco

{
  "type": "object",
  "title": "payment_method_details_multibanco",
  "properties": {
    "entity": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Entity number associated with this Multibanco payment."
    },
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Reference number associated with this Multibanco payment."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_naver_pay

{
  "type": "object",
  "title": "payment_method_details_naver_pay",
  "properties": {
    "buyer_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A unique identifier for the buyer as determined by the local payment processor."
    },
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Naver Pay transaction ID associated with this payment."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_nz_bank_account

{
  "type": "object",
  "title": "payment_method_details_nz_bank_account",
  "required": [
    "bank_code",
    "bank_name",
    "branch_code",
    "last4"
  ],
  "properties": {
    "last4": {
      "type": "string",
      "maxLength": 5000,
      "description": "Last four digits of the bank account number."
    },
    "suffix": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The suffix of the bank account number."
    },
    "bank_code": {
      "type": "string",
      "maxLength": 5000,
      "description": "The numeric code for the bank account's bank."
    },
    "bank_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The name of the bank."
    },
    "branch_code": {
      "type": "string",
      "maxLength": 5000,
      "description": "The numeric code for the bank account's bank branch."
    },
    "account_holder_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details."
    },
    "expected_debit_date": {
      "type": "string",
      "maxLength": 5000,
      "description": "Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_oxxo

{
  "type": "object",
  "title": "payment_method_details_oxxo",
  "properties": {
    "number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "OXXO reference number"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_p24

{
  "type": "object",
  "title": "payment_method_details_p24",
  "properties": {
    "bank": {
      "enum": [
        "alior_bank",
        "bank_millennium",
        "bank_nowy_bfg_sa",
        "bank_pekao_sa",
        "banki_spbdzielcze",
        "blik",
        "bnp_paribas",
        "boz",
        "citi_handlowy",
        "credit_agricole",
        "envelobank",
        "etransfer_pocztowy24",
        "getin_bank",
        "ideabank",
        "ing",
        "inteligo",
        "mbank_mtransfer",
        "nest_przelew",
        "noble_pay",
        "pbac_z_ipko",
        "plus_bank",
        "santander_przelew24",
        "tmobile_usbugi_bankowe",
        "toyota_bank",
        "velobank",
        "volkswagen_bank"
      ],
      "type": "string",
      "nullable": true,
      "description": "The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `velobank`, `blik`, `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`."
    },
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Unique reference for this Przelewy24 payment."
    },
    "verified_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Owner's verified full name. Values are verified or provided by Przelewy24 directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nPrzelewy24 rarely provides this information so the attribute is usually empty."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_passthrough_card

{
  "type": "object",
  "title": "payment_method_details_passthrough_card",
  "properties": {
    "brand": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`."
    },
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The last four digits of the card."
    },
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected."
    },
    "funding": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`."
    },
    "exp_year": {
      "type": "integer",
      "nullable": true,
      "description": "Four-digit number representing the card's expiration year."
    },
    "exp_month": {
      "type": "integer",
      "nullable": true,
      "description": "Two-digit number representing the card's expiration month."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_pay_by_bank

{
  "type": "object",
  "title": "payment_method_details_pay_by_bank",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_payco

{
  "type": "object",
  "title": "payment_method_details_payco",
  "properties": {
    "buyer_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A unique identifier for the buyer as determined by the local payment processor."
    },
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Payco transaction ID associated with this payment."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_payment_record_affirm

{
  "type": "object",
  "title": "payment_method_details_payment_record_affirm",
  "properties": {
    "reader": {
      "type": "string",
      "maxLength": 5000,
      "description": "ID of the reader this transaction was made on."
    },
    "location": {
      "type": "string",
      "maxLength": 5000,
      "description": "ID of the location that this reader is assigned to."
    },
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Affirm transaction ID associated with this payment."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_payment_record_afterpay_clearpay

{
  "type": "object",
  "title": "payment_method_details_payment_record_afterpay_clearpay",
  "properties": {
    "order_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Afterpay order ID associated with this payment intent."
    },
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Order identifier shown to the merchant in Afterpay's online portal."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_payment_record_bancontact

{
  "type": "object",
  "title": "payment_method_details_payment_record_bancontact",
  "properties": {
    "bic": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Bank Identifier Code of the bank associated with the bank account."
    },
    "bank_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Bank code of bank associated with the bank account."
    },
    "bank_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Name of the bank associated with the bank account."
    },
    "iban_last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last four characters of the IBAN."
    },
    "verified_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Owner's verified full name. Values are verified or provided by Bancontact directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."
    },
    "preferred_language": {
      "enum": [
        "de",
        "en",
        "fr",
        "nl"
      ],
      "type": "string",
      "nullable": true,
      "description": "Preferred language of the Bancontact authorization page that the customer is redirected to. Can be one of `en`, `de`, `fr`, or `nl`"
    },
    "generated_sepa_debit": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_method"
        }
      ],
      "nullable": true,
      "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_method"
          }
        ]
      }
    },
    "generated_sepa_debit_mandate": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/mandate"
        }
      ],
      "nullable": true,
      "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/mandate"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "generated_sepa_debit",
    "generated_sepa_debit_mandate"
  ]
}

object payment_method_details_payment_record_boleto

{
  "type": "object",
  "title": "payment_method_details_payment_record_boleto",
  "properties": {
    "tax_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers)"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_payment_record_cashapp

{
  "type": "object",
  "title": "payment_method_details_payment_record_cashapp",
  "properties": {
    "cashtag": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A public identifier for buyers using Cash App."
    },
    "buyer_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A unique and immutable identifier assigned by Cash App to every buyer."
    },
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A unique and immutable identifier of payments assigned by Cash App."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_payment_record_giropay

{
  "type": "object",
  "title": "payment_method_details_payment_record_giropay",
  "properties": {
    "bic": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Bank Identifier Code of the bank associated with the bank account."
    },
    "bank_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Bank code of bank associated with the bank account."
    },
    "bank_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Name of the bank associated with the bank account."
    },
    "verified_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Owner's verified full name. Values are verified or provided by Giropay directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. Giropay rarely provides this information so the attribute is usually empty."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_payment_record_ideal

{
  "type": "object",
  "title": "payment_method_details_payment_record_ideal",
  "properties": {
    "bic": {
      "enum": [
        "ABNANL2A",
        "ADYBNL2A",
        "ASNBNL21",
        "BITSNL2A",
        "BUNQNL2A",
        "BUUTNL2A",
        "FNOMNL22",
        "FVLBNL22",
        "HANDNL2A",
        "INGBNL2A",
        "KNABNL2H",
        "MLLENL2A",
        "MOYONL21",
        "NNBANL2G",
        "NTSBDEB1",
        "RABONL2U",
        "RBRBNL21",
        "REVOIE23",
        "REVOLT21",
        "SNSBNL2A",
        "TRIONL2U"
      ],
      "type": "string",
      "nullable": true,
      "description": "The Bank Identifier Code of the customer's bank."
    },
    "bank": {
      "enum": [
        "abn_amro",
        "adyen",
        "asn_bank",
        "bunq",
        "buut",
        "finom",
        "handelsbanken",
        "ing",
        "knab",
        "mollie",
        "moneyou",
        "n26",
        "nn",
        "rabobank",
        "regiobank",
        "revolut",
        "sns_bank",
        "triodos_bank",
        "van_lanschot",
        "yoursafe"
      ],
      "type": "string",
      "nullable": true,
      "description": "The customer's bank. Can be one of `abn_amro`, `adyen`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`."
    },
    "iban_last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last four characters of the IBAN."
    },
    "verified_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Owner's verified full name. Values are verified or provided by iDEAL directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."
    },
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Unique transaction ID generated by iDEAL."
    },
    "generated_sepa_debit": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_method"
        }
      ],
      "nullable": true,
      "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_method"
          }
        ]
      }
    },
    "generated_sepa_debit_mandate": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/mandate"
        }
      ],
      "nullable": true,
      "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/mandate"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "generated_sepa_debit",
    "generated_sepa_debit_mandate"
  ]
}

object payment_method_details_payment_record_kakao_pay

{
  "type": "object",
  "title": "payment_method_details_payment_record_kakao_pay",
  "properties": {
    "buyer_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A unique identifier for the buyer as determined by the local payment processor."
    },
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Kakao Pay transaction ID associated with this payment."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_payment_record_konbini

{
  "type": "object",
  "title": "payment_method_details_payment_record_konbini",
  "properties": {
    "store": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_konbini_details_resource_store"
        }
      ],
      "nullable": true,
      "description": "If the payment succeeded, this contains the details of the convenience store where the payment was completed."
    }
  },
  "description": "",
  "x-expandableFields": [
    "store"
  ]
}

object payment_method_details_payment_record_mb_way

{
  "type": "object",
  "title": "payment_method_details_payment_record_mb_way",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_payment_record_mobilepay

{
  "type": "object",
  "title": "payment_method_details_payment_record_mobilepay",
  "properties": {
    "card": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_mobilepay_details_resource_card"
        }
      ],
      "nullable": true,
      "description": "Internal card details"
    }
  },
  "description": "",
  "x-expandableFields": [
    "card"
  ]
}

object payment_method_details_payment_record_multibanco

{
  "type": "object",
  "title": "payment_method_details_payment_record_multibanco",
  "properties": {
    "entity": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Entity number associated with this Multibanco payment."
    },
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Reference number associated with this Multibanco payment."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_payment_record_naver_pay

{
  "type": "object",
  "title": "payment_method_details_payment_record_naver_pay",
  "properties": {
    "buyer_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A unique identifier for the buyer as determined by the local payment processor."
    },
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Naver Pay transaction ID associated with this payment."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_payment_record_oxxo

{
  "type": "object",
  "title": "payment_method_details_payment_record_oxxo",
  "properties": {
    "number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "OXXO reference number"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_payment_record_payco

{
  "type": "object",
  "title": "payment_method_details_payment_record_payco",
  "properties": {
    "buyer_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A unique identifier for the buyer as determined by the local payment processor."
    },
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Payco transaction ID associated with this payment."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_payment_record_paynow

{
  "type": "object",
  "title": "payment_method_details_payment_record_paynow",
  "properties": {
    "reader": {
      "type": "string",
      "maxLength": 5000,
      "description": "ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on."
    },
    "location": {
      "type": "string",
      "maxLength": 5000,
      "description": "ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to."
    },
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Reference number associated with this PayNow payment"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_payment_record_pix

{
  "type": "object",
  "title": "payment_method_details_payment_record_pix",
  "properties": {
    "bank_transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Unique transaction id generated by BCB"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_payment_record_promptpay

{
  "type": "object",
  "title": "payment_method_details_payment_record_promptpay",
  "properties": {
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Bill reference generated by PromptPay"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_payment_record_samsung_pay

{
  "type": "object",
  "title": "payment_method_details_payment_record_samsung_pay",
  "properties": {
    "buyer_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A unique identifier for the buyer as determined by the local payment processor."
    },
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Samsung Pay transaction ID associated with this payment."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_payment_record_sepa_debit

{
  "type": "object",
  "title": "payment_method_details_payment_record_sepa_debit",
  "properties": {
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last four characters of the IBAN."
    },
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter ISO code representing the country the bank account is located in."
    },
    "mandate": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://docs.stripe.com/api/mandates/retrieve)."
    },
    "bank_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Bank code of bank associated with the bank account."
    },
    "branch_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Branch code of bank associated with the bank account."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."
    },
    "expected_debit_date": {
      "type": "string",
      "maxLength": 5000,
      "description": "Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_payment_record_sofort

{
  "type": "object",
  "title": "payment_method_details_payment_record_sofort",
  "properties": {
    "bic": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Bank Identifier Code of the bank associated with the bank account."
    },
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter ISO code representing the country the bank account is located in."
    },
    "bank_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Bank code of bank associated with the bank account."
    },
    "bank_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Name of the bank associated with the bank account."
    },
    "iban_last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last four characters of the IBAN."
    },
    "verified_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Owner's verified full name. Values are verified or provided by SOFORT directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."
    },
    "preferred_language": {
      "enum": [
        "de",
        "en",
        "es",
        "fr",
        "it",
        "nl",
        "pl"
      ],
      "type": "string",
      "nullable": true,
      "description": "Preferred language of the SOFORT authorization page that the customer is redirected to. Can be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl`"
    },
    "generated_sepa_debit": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_method"
        }
      ],
      "nullable": true,
      "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_method"
          }
        ]
      }
    },
    "generated_sepa_debit_mandate": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/mandate"
        }
      ],
      "nullable": true,
      "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/mandate"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "generated_sepa_debit",
    "generated_sepa_debit_mandate"
  ]
}

object payment_method_details_payment_record_swish

{
  "type": "object",
  "title": "payment_method_details_payment_record_swish",
  "properties": {
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer"
    },
    "payment_reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Payer bank reference number for the payment"
    },
    "verified_phone_last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The last four digits of the Swish account phone number"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_payment_record_twint

{
  "type": "object",
  "title": "payment_method_details_payment_record_twint",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_payment_record_us_bank_account

{
  "type": "object",
  "title": "payment_method_details_payment_record_us_bank_account",
  "properties": {
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last four digits of the bank account number."
    },
    "mandate": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/mandate"
        }
      ],
      "description": "ID of the mandate used to make this payment.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/mandate"
          }
        ]
      }
    },
    "bank_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Name of the bank associated with the bank account."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."
    },
    "account_type": {
      "enum": [
        "checking",
        "savings"
      ],
      "type": "string",
      "nullable": true,
      "description": "The type of the bank account. This can be either 'checking' or 'savings'."
    },
    "routing_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The routing number for the bank account."
    },
    "payment_reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The ACH payment reference for this transaction."
    },
    "account_holder_type": {
      "enum": [
        "company",
        "individual"
      ],
      "type": "string",
      "nullable": true,
      "description": "The type of entity that holds the account. This can be either 'individual' or 'company'."
    },
    "expected_debit_date": {
      "type": "string",
      "maxLength": 5000,
      "description": "Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format."
    }
  },
  "description": "",
  "x-expandableFields": [
    "mandate"
  ]
}

object payment_method_details_payment_record_wechat_pay

{
  "type": "object",
  "title": "payment_method_details_payment_record_wechat_pay",
  "properties": {
    "reader": {
      "type": "string",
      "maxLength": 5000,
      "description": "ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on."
    },
    "location": {
      "type": "string",
      "maxLength": 5000,
      "description": "ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same."
    },
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Transaction ID of this particular WeChat Pay transaction."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_payment_record_zip

{
  "type": "object",
  "title": "payment_method_details_payment_record_zip",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_paynow

{
  "type": "object",
  "title": "payment_method_details_paynow",
  "properties": {
    "reader": {
      "type": "string",
      "maxLength": 5000,
      "description": "ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on."
    },
    "location": {
      "type": "string",
      "maxLength": 5000,
      "description": "ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to."
    },
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Reference number associated with this PayNow payment"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_paypal

{
  "type": "object",
  "title": "payment_method_details_paypal",
  "properties": {
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."
    },
    "payer_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "PayPal account PayerID. This identifier uniquely identifies the PayPal customer."
    },
    "payer_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Owner's full name. Values provided by PayPal directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated."
    },
    "payer_email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Owner's email. Values are provided by PayPal directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated."
    },
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A unique ID generated by PayPal for this transaction."
    },
    "seller_protection": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/paypal_seller_protection"
        }
      ],
      "nullable": true,
      "description": "The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction."
    }
  },
  "description": "",
  "x-expandableFields": [
    "seller_protection"
  ]
}

object payment_method_details_payto

{
  "type": "object",
  "title": "payment_method_details_payto",
  "properties": {
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last four digits of the bank account number."
    },
    "pay_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The PayID alias for the bank account."
    },
    "mandate": {
      "type": "string",
      "maxLength": 5000,
      "description": "ID of the mandate used to make this payment."
    },
    "bsb_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Bank-State-Branch number of the bank account."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_pix

{
  "type": "object",
  "title": "payment_method_details_pix",
  "properties": {
    "bank_transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Unique transaction id generated by BCB"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_promptpay

{
  "type": "object",
  "title": "payment_method_details_promptpay",
  "properties": {
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Bill reference generated by PromptPay"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_revolut_pay

{
  "type": "object",
  "title": "payment_method_details_revolut_pay",
  "properties": {
    "funding": {
      "$ref": "#/components/schemas/revolut_pay_underlying_payment_method_funding_details"
    },
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Revolut Pay transaction ID associated with this payment."
    }
  },
  "description": "",
  "x-expandableFields": [
    "funding"
  ]
}

object payment_method_details_samsung_pay

{
  "type": "object",
  "title": "payment_method_details_samsung_pay",
  "properties": {
    "buyer_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A unique identifier for the buyer as determined by the local payment processor."
    },
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Samsung Pay transaction ID associated with this payment."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_satispay

{
  "type": "object",
  "title": "payment_method_details_satispay",
  "properties": {
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Satispay transaction ID associated with this payment."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_sepa_debit

{
  "type": "object",
  "title": "payment_method_details_sepa_debit",
  "properties": {
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last four characters of the IBAN."
    },
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter ISO code representing the country the bank account is located in."
    },
    "mandate": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://docs.stripe.com/api/mandates/retrieve)."
    },
    "bank_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Bank code of bank associated with the bank account."
    },
    "branch_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Branch code of bank associated with the bank account."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."
    },
    "expected_debit_date": {
      "type": "string",
      "maxLength": 5000,
      "description": "Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_sofort

{
  "type": "object",
  "title": "payment_method_details_sofort",
  "properties": {
    "bic": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Bank Identifier Code of the bank associated with the bank account."
    },
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter ISO code representing the country the bank account is located in."
    },
    "bank_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Bank code of bank associated with the bank account."
    },
    "bank_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Name of the bank associated with the bank account."
    },
    "iban_last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last four characters of the IBAN."
    },
    "verified_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Owner's verified full name. Values are verified or provided by SOFORT directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated."
    },
    "preferred_language": {
      "enum": [
        "de",
        "en",
        "es",
        "fr",
        "it",
        "nl",
        "pl"
      ],
      "type": "string",
      "nullable": true,
      "description": "Preferred language of the SOFORT authorization page that the customer is redirected to.\nCan be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl`"
    },
    "generated_sepa_debit": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_method"
        }
      ],
      "nullable": true,
      "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_method"
          }
        ]
      }
    },
    "generated_sepa_debit_mandate": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/mandate"
        }
      ],
      "nullable": true,
      "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/mandate"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "generated_sepa_debit",
    "generated_sepa_debit_mandate"
  ]
}

object payment_method_details_stripe_account

{
  "type": "object",
  "title": "payment_method_details_stripe_account",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_swish

{
  "type": "object",
  "title": "payment_method_details_swish",
  "properties": {
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer"
    },
    "payment_reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Payer bank reference number for the payment"
    },
    "verified_phone_last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The last four digits of the Swish account phone number"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_twint

{
  "type": "object",
  "title": "payment_method_details_twint",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_upi

{
  "type": "object",
  "title": "payment_method_details_upi",
  "properties": {
    "vpa": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Customer's unique Virtual Payment Address."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_us_bank_account

{
  "type": "object",
  "title": "payment_method_details_us_bank_account",
  "properties": {
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last four digits of the bank account number."
    },
    "mandate": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/mandate"
        }
      ],
      "description": "ID of the mandate used to make this payment.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/mandate"
          }
        ]
      }
    },
    "bank_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Name of the bank associated with the bank account."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."
    },
    "account_type": {
      "enum": [
        "checking",
        "savings"
      ],
      "type": "string",
      "nullable": true,
      "description": "Account type: checkings or savings. Defaults to checking if omitted."
    },
    "routing_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Routing number of the bank account."
    },
    "payment_reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Reference number to locate ACH payments with customer's bank."
    },
    "account_holder_type": {
      "enum": [
        "company",
        "individual"
      ],
      "type": "string",
      "nullable": true,
      "description": "Account holder type: individual or company."
    },
    "expected_debit_date": {
      "type": "string",
      "maxLength": 5000,
      "description": "Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format."
    }
  },
  "description": "",
  "x-expandableFields": [
    "mandate"
  ]
}

object payment_method_details_wechat

{
  "type": "object",
  "title": "payment_method_details_wechat",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_wechat_pay

{
  "type": "object",
  "title": "payment_method_details_wechat_pay",
  "properties": {
    "reader": {
      "type": "string",
      "maxLength": 5000,
      "description": "ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on."
    },
    "location": {
      "type": "string",
      "maxLength": 5000,
      "description": "ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same."
    },
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Transaction ID of this particular WeChat Pay transaction."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_details_zip

{
  "type": "object",
  "title": "payment_method_details_zip",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_domain

{
  "type": "object",
  "title": "PaymentMethodDomainResourcePaymentMethodDomain",
  "required": [
    "amazon_pay",
    "apple_pay",
    "created",
    "domain_name",
    "enabled",
    "google_pay",
    "id",
    "klarna",
    "link",
    "livemode",
    "object",
    "paypal"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "link": {
      "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status"
    },
    "klarna": {
      "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status"
    },
    "object": {
      "enum": [
        "payment_method_domain"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "paypal": {
      "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status"
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "apple_pay": {
      "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status"
    },
    "amazon_pay": {
      "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status"
    },
    "google_pay": {
      "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status"
    },
    "domain_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The domain name that this payment method domain object represents."
    }
  },
  "description": "A payment method domain represents a web domain that you have registered with Stripe.\nStripe Elements use registered payment method domains to control where certain payment methods are shown.\n\nRelated guide: [Payment method domains](https://docs.stripe.com/payments/payment-methods/pmd-registration).",
  "x-resourceId": "payment_method_domain",
  "x-expandableFields": [
    "amazon_pay",
    "apple_pay",
    "google_pay",
    "klarna",
    "link",
    "paypal"
  ]
}

object payment_method_domain_resource_payment_method_status

{
  "type": "object",
  "title": "PaymentMethodDomainResourcePaymentMethodStatus",
  "required": [
    "status"
  ],
  "properties": {
    "status": {
      "enum": [
        "active",
        "inactive"
      ],
      "type": "string",
      "description": "The status of the payment method on the domain."
    },
    "status_details": {
      "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status_details"
    }
  },
  "description": "Indicates the status of a specific payment method on a payment method domain.",
  "x-expandableFields": [
    "status_details"
  ]
}

object payment_method_domain_resource_payment_method_status_details

{
  "type": "object",
  "title": "PaymentMethodDomainResourcePaymentMethodStatusDetails",
  "required": [
    "error_message"
  ],
  "properties": {
    "error_message": {
      "type": "string",
      "maxLength": 5000,
      "description": "The error message associated with the status of the payment method on the domain."
    }
  },
  "description": "Contains additional details about the status of a payment method for a specific payment method domain.",
  "x-expandableFields": []
}

object payment_method_eps

{
  "type": "object",
  "title": "payment_method_eps",
  "properties": {
    "bank": {
      "enum": [
        "arzte_und_apotheker_bank",
        "austrian_anadi_bank_ag",
        "bank_austria",
        "bankhaus_carl_spangler",
        "bankhaus_schelhammer_und_schattera_ag",
        "bawag_psk_ag",
        "bks_bank_ag",
        "brull_kallmus_bank_ag",
        "btv_vier_lander_bank",
        "capital_bank_grawe_gruppe_ag",
        "deutsche_bank_ag",
        "dolomitenbank",
        "easybank_ag",
        "erste_bank_und_sparkassen",
        "hypo_alpeadriabank_international_ag",
        "hypo_bank_burgenland_aktiengesellschaft",
        "hypo_noe_lb_fur_niederosterreich_u_wien",
        "hypo_oberosterreich_salzburg_steiermark",
        "hypo_tirol_bank_ag",
        "hypo_vorarlberg_bank_ag",
        "marchfelder_bank",
        "oberbank_ag",
        "raiffeisen_bankengruppe_osterreich",
        "schoellerbank_ag",
        "sparda_bank_wien",
        "volksbank_gruppe",
        "volkskreditbank_ag",
        "vr_bank_braunau"
      ],
      "type": "string",
      "nullable": true,
      "description": "The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_fpx

{
  "type": "object",
  "title": "payment_method_fpx",
  "required": [
    "bank"
  ],
  "properties": {
    "bank": {
      "enum": [
        "affin_bank",
        "agrobank",
        "alliance_bank",
        "ambank",
        "bank_islam",
        "bank_muamalat",
        "bank_of_china",
        "bank_rakyat",
        "bsn",
        "cimb",
        "deutsche_bank",
        "hong_leong_bank",
        "hsbc",
        "kfh",
        "maybank2e",
        "maybank2u",
        "ocbc",
        "pb_enterprise",
        "public_bank",
        "rhb",
        "standard_chartered",
        "uob"
      ],
      "type": "string",
      "description": "The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_giropay

{
  "type": "object",
  "title": "payment_method_giropay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_grabpay

{
  "type": "object",
  "title": "payment_method_grabpay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_ideal

{
  "type": "object",
  "title": "payment_method_ideal",
  "properties": {
    "bic": {
      "enum": [
        "ABNANL2A",
        "ADYBNL2A",
        "ASNBNL21",
        "BITSNL2A",
        "BUNQNL2A",
        "BUUTNL2A",
        "FNOMNL22",
        "FVLBNL22",
        "HANDNL2A",
        "INGBNL2A",
        "KNABNL2H",
        "MLLENL2A",
        "MOYONL21",
        "NNBANL2G",
        "NTSBDEB1",
        "RABONL2U",
        "RBRBNL21",
        "REVOIE23",
        "REVOLT21",
        "SNSBNL2A",
        "TRIONL2U"
      ],
      "type": "string",
      "nullable": true,
      "description": "The Bank Identifier Code of the customer's bank, if the bank was provided."
    },
    "bank": {
      "enum": [
        "abn_amro",
        "adyen",
        "asn_bank",
        "bunq",
        "buut",
        "finom",
        "handelsbanken",
        "ing",
        "knab",
        "mollie",
        "moneyou",
        "n26",
        "nn",
        "rabobank",
        "regiobank",
        "revolut",
        "sns_bank",
        "triodos_bank",
        "van_lanschot",
        "yoursafe"
      ],
      "type": "string",
      "nullable": true,
      "description": "The customer's bank, if provided. Can be one of `abn_amro`, `adyen`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_interac_present

{
  "type": "object",
  "title": "payment_method_interac_present",
  "required": [
    "exp_month",
    "exp_year"
  ],
  "properties": {
    "brand": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Card brand. Can be `interac`, `mastercard` or `visa`."
    },
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The last four digits of the card."
    },
    "issuer": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The name of the card's issuing bank."
    },
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected."
    },
    "funding": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`."
    },
    "exp_year": {
      "type": "integer",
      "description": "Four-digit number representing the card's expiration year."
    },
    "networks": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_card_present_networks"
        }
      ],
      "nullable": true,
      "description": "Contains information about card networks that can be used to process the payment."
    },
    "exp_month": {
      "type": "integer",
      "description": "Two-digit number representing the card's expiration month."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A high-level description of the type of cards issued in this range."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*"
    },
    "read_method": {
      "enum": [
        "contact_emv",
        "contactless_emv",
        "contactless_magstripe_mode",
        "magnetic_stripe_fallback",
        "magnetic_stripe_track2"
      ],
      "type": "string",
      "nullable": true,
      "description": "How card details were read in this transaction."
    },
    "cardholder_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay."
    },
    "preferred_locales": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip."
    }
  },
  "description": "",
  "x-expandableFields": [
    "networks"
  ]
}

object payment_method_kakao_pay

{
  "type": "object",
  "title": "payment_method_kakao_pay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_klarna

{
  "type": "object",
  "title": "payment_method_klarna",
  "properties": {
    "dob": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_flows_private_payment_methods_klarna_dob"
        }
      ],
      "nullable": true,
      "description": "The customer's date of birth, if provided."
    }
  },
  "description": "",
  "x-expandableFields": [
    "dob"
  ]
}

object payment_method_konbini

{
  "type": "object",
  "title": "payment_method_konbini",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_kr_card

{
  "type": "object",
  "title": "payment_method_kr_card",
  "properties": {
    "brand": {
      "enum": [
        "bc",
        "citi",
        "hana",
        "hyundai",
        "jeju",
        "jeonbuk",
        "kakaobank",
        "kbank",
        "kdbbank",
        "kookmin",
        "kwangju",
        "lotte",
        "mg",
        "nh",
        "post",
        "samsung",
        "savingsbank",
        "shinhan",
        "shinhyup",
        "suhyup",
        "tossbank",
        "woori"
      ],
      "type": "string",
      "nullable": true,
      "description": "The local credit or debit card brand."
    },
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 4,
      "description": "The last four digits of the card. This may not be present for American Express cards."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_link

{
  "type": "object",
  "title": "payment_method_link",
  "properties": {
    "email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Account owner's email address."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_mb_way

{
  "type": "object",
  "title": "payment_method_mb_way",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_mobilepay

{
  "type": "object",
  "title": "payment_method_mobilepay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_multibanco

{
  "type": "object",
  "title": "payment_method_multibanco",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_naver_pay

{
  "type": "object",
  "title": "payment_method_naver_pay",
  "required": [
    "funding"
  ],
  "properties": {
    "funding": {
      "enum": [
        "card",
        "points"
      ],
      "type": "string",
      "description": "Whether to fund this transaction with Naver Pay points or a card.",
      "x-stripeBypassValidation": true
    },
    "buyer_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular Naver Pay account. You can use this attribute to check whether two Naver Pay accounts are the same."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_nz_bank_account

{
  "type": "object",
  "title": "payment_method_nz_bank_account",
  "required": [
    "bank_code",
    "bank_name",
    "branch_code",
    "last4"
  ],
  "properties": {
    "last4": {
      "type": "string",
      "maxLength": 5000,
      "description": "Last four digits of the bank account number."
    },
    "suffix": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The suffix of the bank account number."
    },
    "bank_code": {
      "type": "string",
      "maxLength": 5000,
      "description": "The numeric code for the bank account's bank."
    },
    "bank_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The name of the bank."
    },
    "branch_code": {
      "type": "string",
      "maxLength": 5000,
      "description": "The numeric code for the bank account's bank branch."
    },
    "account_holder_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_affirm

{
  "type": "object",
  "title": "payment_method_options_affirm",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    },
    "preferred_locale": {
      "type": "string",
      "maxLength": 30,
      "description": "Preferred language of the Affirm authorization page that the customer is redirected to."
    },
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_afterpay_clearpay

{
  "type": "object",
  "title": "payment_method_options_afterpay_clearpay",
  "properties": {
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes.\nThis field differs from the statement descriptor and item name."
    },
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    },
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_alipay

{
  "type": "object",
  "title": "payment_method_options_alipay",
  "properties": {
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_alma

{
  "type": "object",
  "title": "payment_method_options_alma",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_amazon_pay

{
  "type": "object",
  "title": "payment_method_options_amazon_pay",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_bancontact

{
  "type": "object",
  "title": "payment_method_options_bancontact",
  "required": [
    "preferred_language"
  ],
  "properties": {
    "preferred_language": {
      "enum": [
        "de",
        "en",
        "fr",
        "nl"
      ],
      "type": "string",
      "description": "Preferred language of the Bancontact authorization page that the customer is redirected to."
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_billie

{
  "type": "object",
  "title": "payment_method_options_billie",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_boleto

{
  "type": "object",
  "title": "payment_method_options_boleto",
  "required": [
    "expires_after_days"
  ],
  "properties": {
    "expires_after_days": {
      "type": "integer",
      "description": "The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time."
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session",
        "on_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_card_installments

{
  "type": "object",
  "title": "payment_method_options_card_installments",
  "required": [
    "enabled"
  ],
  "properties": {
    "plan": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_details_card_installments_plan"
        }
      ],
      "nullable": true,
      "description": "Installment plan selected for this PaymentIntent."
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether Installments are enabled for this PaymentIntent."
    },
    "available_plans": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/payment_method_details_card_installments_plan"
      },
      "nullable": true,
      "description": "Installment plans that may be selected for this PaymentIntent."
    }
  },
  "description": "",
  "x-expandableFields": [
    "available_plans",
    "plan"
  ]
}

object payment_method_options_card_mandate_options

{
  "type": "object",
  "title": "payment_method_options_card_mandate_options",
  "required": [
    "amount",
    "amount_type",
    "interval",
    "reference",
    "start_date"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "Amount to be charged for future payments, specified in the presentment currency."
    },
    "end_date": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date."
    },
    "interval": {
      "enum": [
        "day",
        "month",
        "sporadic",
        "week",
        "year"
      ],
      "type": "string",
      "description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`."
    },
    "reference": {
      "type": "string",
      "maxLength": 80,
      "description": "Unique identifier for the mandate or subscription."
    },
    "start_date": {
      "type": "integer",
      "format": "unix-time",
      "description": "Start date of the mandate or subscription. Start date should not be lesser than yesterday."
    },
    "amount_type": {
      "enum": [
        "fixed",
        "maximum"
      ],
      "type": "string",
      "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 200,
      "description": "A description of the mandate or subscription that is meant to be displayed to the customer."
    },
    "interval_count": {
      "type": "integer",
      "nullable": true,
      "description": "The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`."
    },
    "supported_types": {
      "type": "array",
      "items": {
        "enum": [
          "india"
        ],
        "type": "string"
      },
      "nullable": true,
      "description": "Specifies the type of mandates supported. Possible values are `india`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_card_present

{
  "type": "object",
  "title": "payment_method_options_card_present",
  "properties": {
    "routing": {
      "$ref": "#/components/schemas/payment_method_options_card_present_routing"
    },
    "capture_method": {
      "enum": [
        "manual",
        "manual_preferred"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    },
    "request_extended_authorization": {
      "type": "boolean",
      "nullable": true,
      "description": "Request ability to capture this payment beyond the standard [authorization validity window](https://docs.stripe.com/terminal/features/extended-authorizations#authorization-validity)"
    },
    "request_incremental_authorization_support": {
      "type": "boolean",
      "nullable": true,
      "description": "Request ability to [increment](https://docs.stripe.com/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://docs.stripe.com/api/payment_intents/confirm) response to verify support."
    }
  },
  "description": "",
  "x-expandableFields": [
    "routing"
  ]
}

object payment_method_options_card_present_routing

{
  "type": "object",
  "title": "payment_method_options_card_present_routing",
  "properties": {
    "requested_priority": {
      "enum": [
        "domestic",
        "international"
      ],
      "type": "string",
      "nullable": true,
      "description": "Requested routing priority"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_cashapp

{
  "type": "object",
  "title": "payment_method_options_cashapp",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session",
        "on_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_crypto

{
  "type": "object",
  "title": "payment_method_options_crypto",
  "properties": {
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_customer_balance

{
  "type": "object",
  "title": "payment_method_options_customer_balance",
  "properties": {
    "funding_type": {
      "enum": [
        "bank_transfer"
      ],
      "type": "string",
      "nullable": true,
      "description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`."
    },
    "bank_transfer": {
      "$ref": "#/components/schemas/payment_method_options_customer_balance_bank_transfer"
    },
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": [
    "bank_transfer"
  ]
}

object payment_method_options_customer_balance_bank_transfer

{
  "type": "object",
  "title": "payment_method_options_customer_balance_bank_transfer",
  "properties": {
    "type": {
      "enum": [
        "eu_bank_transfer",
        "gb_bank_transfer",
        "jp_bank_transfer",
        "mx_bank_transfer",
        "us_bank_transfer"
      ],
      "type": "string",
      "nullable": true,
      "description": "The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.",
      "x-stripeBypassValidation": true
    },
    "eu_bank_transfer": {
      "$ref": "#/components/schemas/payment_method_options_customer_balance_eu_bank_account"
    },
    "requested_address_types": {
      "type": "array",
      "items": {
        "enum": [
          "aba",
          "iban",
          "sepa",
          "sort_code",
          "spei",
          "swift",
          "zengin"
        ],
        "type": "string",
        "x-stripeBypassValidation": true
      },
      "description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`."
    }
  },
  "description": "",
  "x-expandableFields": [
    "eu_bank_transfer"
  ]
}

object payment_method_options_customer_balance_eu_bank_account

{
  "type": "object",
  "title": "payment_method_options_customer_balance_eu_bank_account",
  "required": [
    "country"
  ],
  "properties": {
    "country": {
      "enum": [
        "BE",
        "DE",
        "ES",
        "FR",
        "IE",
        "NL"
      ],
      "type": "string",
      "description": "The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_fpx

{
  "type": "object",
  "title": "payment_method_options_fpx",
  "properties": {
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_giropay

{
  "type": "object",
  "title": "payment_method_options_giropay",
  "properties": {
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_grabpay

{
  "type": "object",
  "title": "payment_method_options_grabpay",
  "properties": {
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_ideal

{
  "type": "object",
  "title": "payment_method_options_ideal",
  "properties": {
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_interac_present

{
  "type": "object",
  "title": "payment_method_options_interac_present",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_klarna

{
  "type": "object",
  "title": "payment_method_options_klarna",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    },
    "preferred_locale": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Preferred locale of the Klarna checkout page that the customer is redirected to."
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session",
        "on_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_konbini

{
  "type": "object",
  "title": "payment_method_options_konbini",
  "properties": {
    "expires_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set."
    },
    "expires_after_days": {
      "type": "integer",
      "nullable": true,
      "description": "The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST."
    },
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    },
    "confirmation_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores."
    },
    "product_description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_kr_card

{
  "type": "object",
  "title": "payment_method_options_kr_card",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_mandate_options_upi

{
  "type": "object",
  "title": "payment_method_options_mandate_options_upi",
  "properties": {
    "amount": {
      "type": "integer",
      "nullable": true,
      "description": "Amount to be charged for future payments."
    },
    "end_date": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "End date of the mandate or subscription."
    },
    "amount_type": {
      "enum": [
        "fixed",
        "maximum"
      ],
      "type": "string",
      "nullable": true,
      "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 20,
      "description": "A description of the mandate or subscription that is meant to be displayed to the customer."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_mb_way

{
  "type": "object",
  "title": "payment_method_options_mb_way",
  "properties": {
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_multibanco

{
  "type": "object",
  "title": "payment_method_options_multibanco",
  "properties": {
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_oxxo

{
  "type": "object",
  "title": "payment_method_options_oxxo",
  "required": [
    "expires_after_days"
  ],
  "properties": {
    "expires_after_days": {
      "type": "integer",
      "description": "The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time."
    },
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_p24

{
  "type": "object",
  "title": "payment_method_options_p24",
  "properties": {
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_pay_by_bank

{
  "type": "object",
  "title": "payment_method_options_pay_by_bank",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_paynow

{
  "type": "object",
  "title": "payment_method_options_paynow",
  "properties": {
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_paypal

{
  "type": "object",
  "title": "payment_method_options_paypal",
  "properties": {
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID."
    },
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    },
    "preferred_locale": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Preferred locale of the PayPal checkout page that the customer is redirected to."
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_pix

{
  "type": "object",
  "title": "payment_method_options_pix",
  "properties": {
    "expires_at": {
      "type": "integer",
      "nullable": true,
      "description": "The timestamp at which the Pix expires."
    },
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
      "x-stripeBypassValidation": true
    },
    "amount_includes_iof": {
      "enum": [
        "always",
        "never"
      ],
      "type": "string",
      "description": "Determines if the amount includes the IOF tax."
    },
    "expires_after_seconds": {
      "type": "integer",
      "nullable": true,
      "description": "The number of seconds (between 10 and 1209600) after which Pix payment will expire."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_promptpay

{
  "type": "object",
  "title": "payment_method_options_promptpay",
  "properties": {
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_revolut_pay

{
  "type": "object",
  "title": "payment_method_options_revolut_pay",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_satispay

{
  "type": "object",
  "title": "payment_method_options_satispay",
  "properties": {
    "capture_method": {
      "enum": [
        "manual"
      ],
      "type": "string",
      "description": "Controls when the funds will be captured from the customer's account."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_sofort

{
  "type": "object",
  "title": "payment_method_options_sofort",
  "properties": {
    "preferred_language": {
      "enum": [
        "de",
        "en",
        "es",
        "fr",
        "it",
        "nl",
        "pl"
      ],
      "type": "string",
      "nullable": true,
      "description": "Preferred language of the SOFORT authorization page that the customer is redirected to."
    },
    "setup_future_usage": {
      "enum": [
        "none",
        "off_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_twint

{
  "type": "object",
  "title": "payment_method_options_twint",
  "properties": {
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_upi

{
  "type": "object",
  "title": "payment_method_options_upi",
  "properties": {
    "setup_future_usage": {
      "enum": [
        "off_session",
        "on_session"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_us_bank_account_mandate_options

{
  "type": "object",
  "title": "payment_method_options_us_bank_account_mandate_options",
  "properties": {
    "collection_method": {
      "enum": [
        "paper"
      ],
      "type": "string",
      "description": "Mandate collection method",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_wechat_pay

{
  "type": "object",
  "title": "payment_method_options_wechat_pay",
  "properties": {
    "app_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The app ID registered with WeChat Pay. Only required when client is ios or android."
    },
    "client": {
      "enum": [
        "android",
        "ios",
        "web"
      ],
      "type": "string",
      "nullable": true,
      "description": "The client type that the end customer will pay from",
      "x-stripeBypassValidation": true
    },
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_options_zip

{
  "type": "object",
  "title": "payment_method_options_zip",
  "properties": {
    "setup_future_usage": {
      "enum": [
        "none"
      ],
      "type": "string",
      "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_oxxo

{
  "type": "object",
  "title": "payment_method_oxxo",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_p24

{
  "type": "object",
  "title": "payment_method_p24",
  "properties": {
    "bank": {
      "enum": [
        "alior_bank",
        "bank_millennium",
        "bank_nowy_bfg_sa",
        "bank_pekao_sa",
        "banki_spbdzielcze",
        "blik",
        "bnp_paribas",
        "boz",
        "citi_handlowy",
        "credit_agricole",
        "envelobank",
        "etransfer_pocztowy24",
        "getin_bank",
        "ideabank",
        "ing",
        "inteligo",
        "mbank_mtransfer",
        "nest_przelew",
        "noble_pay",
        "pbac_z_ipko",
        "plus_bank",
        "santander_przelew24",
        "tmobile_usbugi_bankowe",
        "toyota_bank",
        "velobank",
        "volkswagen_bank"
      ],
      "type": "string",
      "nullable": true,
      "description": "The customer's bank, if provided.",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_pay_by_bank

{
  "type": "object",
  "title": "payment_method_pay_by_bank",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_payco

{
  "type": "object",
  "title": "payment_method_payco",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_paynow

{
  "type": "object",
  "title": "payment_method_paynow",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_paypal

{
  "type": "object",
  "title": "payment_method_paypal",
  "properties": {
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."
    },
    "payer_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "PayPal account PayerID. This identifier uniquely identifies the PayPal customer."
    },
    "payer_email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Owner's email. Values are provided by PayPal directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_payto

{
  "type": "object",
  "title": "payment_method_payto",
  "properties": {
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last four digits of the bank account number."
    },
    "pay_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The PayID alias for the bank account."
    },
    "bsb_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Bank-State-Branch number of the bank account."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_pix

{
  "type": "object",
  "title": "payment_method_pix",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_promptpay

{
  "type": "object",
  "title": "payment_method_promptpay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_revolut_pay

{
  "type": "object",
  "title": "payment_method_revolut_pay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_samsung_pay

{
  "type": "object",
  "title": "payment_method_samsung_pay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_satispay

{
  "type": "object",
  "title": "payment_method_satispay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_sepa_debit

{
  "type": "object",
  "title": "payment_method_sepa_debit",
  "properties": {
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last four characters of the IBAN."
    },
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter ISO code representing the country the bank account is located in."
    },
    "bank_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Bank code of bank associated with the bank account."
    },
    "branch_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Branch code of bank associated with the bank account."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."
    },
    "generated_from": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/sepa_debit_generated_from"
        }
      ],
      "nullable": true,
      "description": "Information about the object that generated this PaymentMethod."
    }
  },
  "description": "",
  "x-expandableFields": [
    "generated_from"
  ]
}

object payment_method_sofort

{
  "type": "object",
  "title": "payment_method_sofort",
  "properties": {
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter ISO code representing the country the bank account is located in."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_swish

{
  "type": "object",
  "title": "payment_method_swish",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_twint

{
  "type": "object",
  "title": "payment_method_twint",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_upi

{
  "type": "object",
  "title": "payment_method_upi",
  "properties": {
    "vpa": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Customer's unique Virtual Payment Address"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_us_bank_account

{
  "type": "object",
  "title": "payment_method_us_bank_account",
  "properties": {
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last four digits of the bank account number."
    },
    "networks": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/us_bank_account_networks"
        }
      ],
      "nullable": true,
      "description": "Contains information about US bank account networks that can be used."
    },
    "bank_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The name of the bank."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."
    },
    "account_type": {
      "enum": [
        "checking",
        "savings"
      ],
      "type": "string",
      "nullable": true,
      "description": "Account type: checkings or savings. Defaults to checking if omitted."
    },
    "routing_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Routing number of the bank account."
    },
    "status_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_us_bank_account_status_details"
        }
      ],
      "nullable": true,
      "description": "Contains information about the future reusability of this PaymentMethod."
    },
    "account_holder_type": {
      "enum": [
        "company",
        "individual"
      ],
      "type": "string",
      "nullable": true,
      "description": "Account holder type: individual or company."
    },
    "financial_connections_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The ID of the Financial Connections Account used to create the payment method."
    }
  },
  "description": "",
  "x-expandableFields": [
    "networks",
    "status_details"
  ]
}

object payment_method_us_bank_account_blocked

{
  "type": "object",
  "title": "payment_method_us_bank_account_blocked",
  "properties": {
    "reason": {
      "enum": [
        "bank_account_closed",
        "bank_account_frozen",
        "bank_account_invalid_details",
        "bank_account_restricted",
        "bank_account_unusable",
        "debit_not_authorized",
        "tokenized_account_number_deactivated"
      ],
      "type": "string",
      "nullable": true,
      "description": "The reason why this PaymentMethod's fingerprint has been blocked"
    },
    "network_code": {
      "enum": [
        "R02",
        "R03",
        "R04",
        "R05",
        "R07",
        "R08",
        "R10",
        "R11",
        "R16",
        "R20",
        "R29",
        "R31"
      ],
      "type": "string",
      "nullable": true,
      "description": "The ACH network code that resulted in this block."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_method_us_bank_account_status_details

{
  "type": "object",
  "title": "payment_method_us_bank_account_status_details",
  "properties": {
    "blocked": {
      "$ref": "#/components/schemas/payment_method_us_bank_account_blocked"
    }
  },
  "description": "",
  "x-expandableFields": [
    "blocked"
  ]
}

object payment_method_wechat_pay

{
  "type": "object",
  "title": "payment_method_wechat_pay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_method_zip

{
  "type": "object",
  "title": "payment_method_zip",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payment_pages_checkout_session_adaptive_pricing

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionAdaptivePricing",
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "If enabled, Adaptive Pricing is available on [eligible sessions](https://docs.stripe.com/payments/currencies/localize-prices/adaptive-pricing?payment-ui=stripe-hosted#restrictions)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_pages_checkout_session_after_expiration

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionAfterExpiration",
  "properties": {
    "recovery": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_pages_checkout_session_after_expiration_recovery"
        }
      ],
      "nullable": true,
      "description": "When set, configuration used to recover the Checkout Session on expiry."
    }
  },
  "description": "",
  "x-expandableFields": [
    "recovery"
  ]
}

object payment_pages_checkout_session_after_expiration_recovery

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionAfterExpirationRecovery",
  "required": [
    "allow_promotion_codes",
    "enabled"
  ],
  "properties": {
    "url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session"
    },
    "enabled": {
      "type": "boolean",
      "description": "If `true`, a recovery url will be generated to recover this Checkout Session if it\nexpires before a transaction is completed. It will be attached to the\nCheckout Session object upon expiration."
    },
    "expires_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The timestamp at which the recovery URL will expire."
    },
    "allow_promotion_codes": {
      "type": "boolean",
      "description": "Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_pages_checkout_session_automatic_tax

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionAutomaticTax",
  "required": [
    "enabled"
  ],
  "properties": {
    "status": {
      "enum": [
        "complete",
        "failed",
        "requires_location_inputs"
      ],
      "type": "string",
      "nullable": true,
      "description": "The status of the most recent automated tax calculation for this session."
    },
    "enabled": {
      "type": "boolean",
      "description": "Indicates whether automatic tax is enabled for the session"
    },
    "provider": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The tax provider powering automatic tax."
    },
    "liability": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/connect_account_reference"
        }
      ],
      "nullable": true,
      "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account."
    }
  },
  "description": "",
  "x-expandableFields": [
    "liability"
  ]
}

object payment_pages_checkout_session_branding_settings

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionBrandingSettings",
  "required": [
    "background_color",
    "border_style",
    "button_color",
    "display_name",
    "font_family"
  ],
  "properties": {
    "icon": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_pages_checkout_session_branding_settings_icon"
        }
      ],
      "nullable": true,
      "description": "The icon for the Checkout Session. You cannot set both `logo` and `icon`."
    },
    "logo": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_pages_checkout_session_branding_settings_logo"
        }
      ],
      "nullable": true,
      "description": "The logo for the Checkout Session. You cannot set both `logo` and `icon`."
    },
    "font_family": {
      "type": "string",
      "maxLength": 5000,
      "description": "The font family for the Checkout Session. Must be one of the [supported font families](https://docs.stripe.com/payments/checkout/customization/appearance?payment-ui=stripe-hosted#font-compatibility)."
    },
    "border_style": {
      "enum": [
        "pill",
        "rectangular",
        "rounded"
      ],
      "type": "string",
      "description": "The border style for the Checkout Session. Must be one of `rounded`, `rectangular`, or `pill`."
    },
    "button_color": {
      "type": "string",
      "maxLength": 5000,
      "description": "A hex color value starting with `#` representing the button color for the Checkout Session."
    },
    "display_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The display name shown on the Checkout Session."
    },
    "background_color": {
      "type": "string",
      "maxLength": 5000,
      "description": "A hex color value starting with `#` representing the background color for the Checkout Session."
    }
  },
  "description": "",
  "x-expandableFields": [
    "icon",
    "logo"
  ]
}

object payment_pages_checkout_session_branding_settings_icon

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionBrandingSettingsIcon",
  "required": [
    "type"
  ],
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 5000,
      "description": "The URL of the image. Present when `type` is `url`."
    },
    "file": {
      "type": "string",
      "maxLength": 5000,
      "description": "The ID of a [File upload](https://stripe.com/docs/api/files) representing the icon. Purpose must be `business_icon`. Required if `type` is `file` and disallowed otherwise."
    },
    "type": {
      "enum": [
        "file",
        "url"
      ],
      "type": "string",
      "description": "The type of image for the icon. Must be one of `file` or `url`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_pages_checkout_session_branding_settings_logo

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionBrandingSettingsLogo",
  "required": [
    "type"
  ],
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 5000,
      "description": "The URL of the image. Present when `type` is `url`."
    },
    "file": {
      "type": "string",
      "maxLength": 5000,
      "description": "The ID of a [File upload](https://stripe.com/docs/api/files) representing the logo. Purpose must be `business_logo`. Required if `type` is `file` and disallowed otherwise."
    },
    "type": {
      "enum": [
        "file",
        "url"
      ],
      "type": "string",
      "description": "The type of image for the logo. Must be one of `file` or `url`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_pages_checkout_session_business_name

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionBusinessName",
  "required": [
    "enabled",
    "optional"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Indicates whether business name collection is enabled for the session"
    },
    "optional": {
      "type": "boolean",
      "description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_pages_checkout_session_checkout_address_details

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionCheckoutAddressDetails",
  "required": [
    "address",
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 5000,
      "description": "Customer name."
    },
    "address": {
      "$ref": "#/components/schemas/address"
    }
  },
  "description": "",
  "x-expandableFields": [
    "address"
  ]
}

object payment_pages_checkout_session_collected_information

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionCollectedInformation",
  "properties": {
    "business_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Customer’s business name for this Checkout Session"
    },
    "individual_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Customer’s individual name for this Checkout Session"
    },
    "shipping_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_pages_checkout_session_checkout_address_details"
        }
      ],
      "nullable": true,
      "description": "Shipping information for this Checkout Session."
    }
  },
  "description": "",
  "x-expandableFields": [
    "shipping_details"
  ]
}

object payment_pages_checkout_session_consent

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionConsent",
  "properties": {
    "promotions": {
      "enum": [
        "opt_in",
        "opt_out"
      ],
      "type": "string",
      "nullable": true,
      "description": "If `opt_in`, the customer consents to receiving promotional communications\nfrom the merchant about this Checkout Session."
    },
    "terms_of_service": {
      "enum": [
        "accepted"
      ],
      "type": "string",
      "nullable": true,
      "description": "If `accepted`, the customer in this Checkout Session has agreed to the merchant's terms of service.",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_pages_checkout_session_consent_collection

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionConsentCollection",
  "properties": {
    "promotions": {
      "enum": [
        "auto",
        "none"
      ],
      "type": "string",
      "nullable": true,
      "description": "If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout\nSession will determine whether to display an option to opt into promotional communication\nfrom the merchant depending on the customer's locale. Only available to US merchants."
    },
    "terms_of_service": {
      "enum": [
        "none",
        "required"
      ],
      "type": "string",
      "nullable": true,
      "description": "If set to `required`, it requires customers to accept the terms of service before being able to pay."
    },
    "payment_method_reuse_agreement": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_pages_checkout_session_payment_method_reuse_agreement"
        }
      ],
      "nullable": true,
      "description": "If set to `hidden`, it will hide legal text related to the reuse of a payment method."
    }
  },
  "description": "",
  "x-expandableFields": [
    "payment_method_reuse_agreement"
  ]
}

object payment_pages_checkout_session_currency_conversion

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionCurrencyConversion",
  "required": [
    "amount_subtotal",
    "amount_total",
    "fx_rate",
    "source_currency"
  ],
  "properties": {
    "fx_rate": {
      "type": "string",
      "format": "decimal",
      "description": "Exchange rate used to convert source currency amounts to customer currency amounts"
    },
    "amount_total": {
      "type": "integer",
      "description": "Total of all items in source currency after discounts and taxes are applied."
    },
    "amount_subtotal": {
      "type": "integer",
      "description": "Total of all items in source currency before discounts or taxes are applied."
    },
    "source_currency": {
      "type": "string",
      "maxLength": 5000,
      "description": "Creation currency of the CheckoutSession before localization"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_pages_checkout_session_custom_fields

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionCustomFields",
  "required": [
    "key",
    "label",
    "optional",
    "type"
  ],
  "properties": {
    "key": {
      "type": "string",
      "maxLength": 5000,
      "description": "String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters."
    },
    "text": {
      "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_text"
    },
    "type": {
      "enum": [
        "dropdown",
        "numeric",
        "text"
      ],
      "type": "string",
      "description": "The type of the field."
    },
    "label": {
      "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_label"
    },
    "numeric": {
      "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_numeric"
    },
    "dropdown": {
      "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_dropdown"
    },
    "optional": {
      "type": "boolean",
      "description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`."
    }
  },
  "description": "",
  "x-expandableFields": [
    "dropdown",
    "label",
    "numeric",
    "text"
  ]
}

object payment_pages_checkout_session_custom_fields_dropdown

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionCustomFieldsDropdown",
  "required": [
    "options"
  ],
  "properties": {
    "value": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The option selected by the customer. This will be the `value` for the option."
    },
    "options": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_option"
      },
      "description": "The options available for the customer to select. Up to 200 options allowed."
    },
    "default_value": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The value that pre-fills on the payment page."
    }
  },
  "description": "",
  "x-expandableFields": [
    "options"
  ]
}

object payment_pages_checkout_session_custom_fields_label

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionCustomFieldsLabel",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "custom"
      ],
      "type": "string",
      "description": "The type of the label."
    },
    "custom": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Custom text for the label, displayed to the customer. Up to 50 characters."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_pages_checkout_session_custom_fields_numeric

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionCustomFieldsNumeric",
  "properties": {
    "value": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The value entered by the customer, containing only digits."
    },
    "default_value": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The value that pre-fills the field on the payment page."
    },
    "maximum_length": {
      "type": "integer",
      "nullable": true,
      "description": "The maximum character length constraint for the customer's input."
    },
    "minimum_length": {
      "type": "integer",
      "nullable": true,
      "description": "The minimum character length requirement for the customer's input."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_pages_checkout_session_custom_fields_option

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionCustomFieldsOption",
  "required": [
    "label",
    "value"
  ],
  "properties": {
    "label": {
      "type": "string",
      "maxLength": 5000,
      "description": "The label for the option, displayed to the customer. Up to 100 characters."
    },
    "value": {
      "type": "string",
      "maxLength": 5000,
      "description": "The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_pages_checkout_session_custom_fields_text

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionCustomFieldsText",
  "properties": {
    "value": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The value entered by the customer."
    },
    "default_value": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The value that pre-fills the field on the payment page."
    },
    "maximum_length": {
      "type": "integer",
      "nullable": true,
      "description": "The maximum character length constraint for the customer's input."
    },
    "minimum_length": {
      "type": "integer",
      "nullable": true,
      "description": "The minimum character length requirement for the customer's input."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_pages_checkout_session_custom_text

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionCustomText",
  "properties": {
    "submit": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_pages_checkout_session_custom_text_position"
        }
      ],
      "nullable": true,
      "description": "Custom text that should be displayed alongside the payment confirmation button."
    },
    "after_submit": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_pages_checkout_session_custom_text_position"
        }
      ],
      "nullable": true,
      "description": "Custom text that should be displayed after the payment confirmation button."
    },
    "shipping_address": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_pages_checkout_session_custom_text_position"
        }
      ],
      "nullable": true,
      "description": "Custom text that should be displayed alongside shipping address collection."
    },
    "terms_of_service_acceptance": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_pages_checkout_session_custom_text_position"
        }
      ],
      "nullable": true,
      "description": "Custom text that should be displayed in place of the default terms of service agreement text."
    }
  },
  "description": "",
  "x-expandableFields": [
    "after_submit",
    "shipping_address",
    "submit",
    "terms_of_service_acceptance"
  ]
}

object payment_pages_checkout_session_custom_text_position

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionCustomTextPosition",
  "required": [
    "message"
  ],
  "properties": {
    "message": {
      "type": "string",
      "maxLength": 1200,
      "description": "Text can be up to 1200 characters in length."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_pages_checkout_session_customer_details

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionCustomerDetails",
  "properties": {
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022."
    },
    "email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The email associated with the Customer, if one exists, on the Checkout Session after a completed Checkout Session or at time of session expiry.\nOtherwise, if the customer has consented to promotional content, this value is the most recent valid email provided by the customer on the Checkout form."
    },
    "phone": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The customer's phone number after a completed Checkout Session."
    },
    "address": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/address"
        }
      ],
      "nullable": true,
      "description": "The customer's address after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022."
    },
    "tax_ids": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/payment_pages_checkout_session_tax_id"
      },
      "nullable": true,
      "description": "The customer’s tax IDs after a completed Checkout Session."
    },
    "tax_exempt": {
      "enum": [
        "exempt",
        "none",
        "reverse"
      ],
      "type": "string",
      "nullable": true,
      "description": "The customer’s tax exempt status after a completed Checkout Session."
    },
    "business_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 150,
      "description": "The customer's business name after a completed Checkout Session."
    },
    "individual_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 150,
      "description": "The customer's individual name after a completed Checkout Session."
    }
  },
  "description": "",
  "x-expandableFields": [
    "address",
    "tax_ids"
  ]
}

object payment_pages_checkout_session_discount

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionDiscount",
  "properties": {
    "coupon": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/coupon"
        }
      ],
      "nullable": true,
      "description": "Coupon attached to the Checkout Session.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/coupon"
          }
        ]
      }
    },
    "promotion_code": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/promotion_code"
        }
      ],
      "nullable": true,
      "description": "Promotion code attached to the Checkout Session.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/promotion_code"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "coupon",
    "promotion_code"
  ]
}

object payment_pages_checkout_session_individual_name

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionIndividualName",
  "required": [
    "enabled",
    "optional"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Indicates whether individual name collection is enabled for the session"
    },
    "optional": {
      "type": "boolean",
      "description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_pages_checkout_session_invoice_creation

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionInvoiceCreation",
  "required": [
    "enabled",
    "invoice_data"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Indicates whether invoice creation is enabled for the Checkout Session."
    },
    "invoice_data": {
      "$ref": "#/components/schemas/payment_pages_checkout_session_invoice_settings"
    }
  },
  "description": "",
  "x-expandableFields": [
    "invoice_data"
  ]
}

object payment_pages_checkout_session_invoice_settings

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionInvoiceSettings",
  "properties": {
    "footer": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Footer displayed on the invoice."
    },
    "issuer": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/connect_account_reference"
        }
      ],
      "nullable": true,
      "description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An arbitrary string attached to the object. Often useful for displaying to users."
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/invoice_setting_custom_field"
      },
      "nullable": true,
      "description": "Custom fields displayed on the invoice."
    },
    "account_tax_ids": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 5000
          },
          {
            "$ref": "#/components/schemas/tax_id"
          },
          {
            "$ref": "#/components/schemas/deleted_tax_id"
          }
        ],
        "x-expansionResources": {
          "oneOf": [
            {
              "$ref": "#/components/schemas/tax_id"
            },
            {
              "$ref": "#/components/schemas/deleted_tax_id"
            }
          ]
        }
      },
      "nullable": true,
      "description": "The account tax IDs associated with the invoice."
    },
    "rendering_options": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/invoice_setting_checkout_rendering_options"
        }
      ],
      "nullable": true,
      "description": "Options for invoice PDF rendering."
    }
  },
  "description": "",
  "x-expandableFields": [
    "account_tax_ids",
    "custom_fields",
    "issuer",
    "rendering_options"
  ]
}

object payment_pages_checkout_session_name_collection

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionNameCollection",
  "properties": {
    "business": {
      "$ref": "#/components/schemas/payment_pages_checkout_session_business_name"
    },
    "individual": {
      "$ref": "#/components/schemas/payment_pages_checkout_session_individual_name"
    }
  },
  "description": "",
  "x-expandableFields": [
    "business",
    "individual"
  ]
}

object payment_pages_checkout_session_optional_item

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionOptionalItem",
  "required": [
    "price",
    "quantity"
  ],
  "properties": {
    "price": {
      "type": "string",
      "maxLength": 5000
    },
    "quantity": {
      "type": "integer"
    },
    "adjustable_quantity": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_pages_checkout_session_optional_item_adjustable_quantity"
        }
      ],
      "nullable": true
    }
  },
  "description": "",
  "x-expandableFields": [
    "adjustable_quantity"
  ]
}

object payment_pages_checkout_session_optional_item_adjustable_quantity

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionOptionalItemAdjustableQuantity",
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Set to true if the quantity can be adjusted to any non-negative integer."
    },
    "maximum": {
      "type": "integer",
      "nullable": true,
      "description": "The maximum quantity of this item the customer can purchase. By default this value is 99. You can specify a value up to 999999."
    },
    "minimum": {
      "type": "integer",
      "nullable": true,
      "description": "The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_pages_checkout_session_payment_method_reuse_agreement

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionPaymentMethodReuseAgreement",
  "required": [
    "position"
  ],
  "properties": {
    "position": {
      "enum": [
        "auto",
        "hidden"
      ],
      "type": "string",
      "description": "Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's defaults will be used.\n\nWhen set to `hidden`, the payment method reuse agreement text will always be hidden in the UI."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_pages_checkout_session_permissions

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionPermissions",
  "properties": {
    "update_shipping_details": {
      "enum": [
        "client_only",
        "server_only"
      ],
      "type": "string",
      "nullable": true,
      "description": "Determines which entity is allowed to update the shipping details.\n\nDefault is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.\n\nWhen set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_pages_checkout_session_phone_number_collection

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionPhoneNumberCollection",
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Indicates whether phone number collection is enabled for the session"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_pages_checkout_session_saved_payment_method_options

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionSavedPaymentMethodOptions",
  "properties": {
    "payment_method_save": {
      "enum": [
        "disabled",
        "enabled"
      ],
      "type": "string",
      "nullable": true,
      "description": "Enable customers to choose if they wish to save their payment method for future use. Disabled by default."
    },
    "payment_method_remove": {
      "enum": [
        "disabled",
        "enabled"
      ],
      "type": "string",
      "nullable": true,
      "description": "Enable customers to choose if they wish to remove their saved payment methods. Disabled by default."
    },
    "allow_redisplay_filters": {
      "type": "array",
      "items": {
        "enum": [
          "always",
          "limited",
          "unspecified"
        ],
        "type": "string"
      },
      "nullable": true,
      "description": "Uses the `allow_redisplay` value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_pages_checkout_session_shipping_address_collection

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionShippingAddressCollection",
  "required": [
    "allowed_countries"
  ],
  "properties": {
    "allowed_countries": {
      "type": "array",
      "items": {
        "enum": [
          "AC",
          "AD",
          "AE",
          "AF",
          "AG",
          "AI",
          "AL",
          "AM",
          "AO",
          "AQ",
          "AR",
          "AT",
          "AU",
          "AW",
          "AX",
          "AZ",
          "BA",
          "BB",
          "BD",
          "BE",
          "BF",
          "BG",
          "BH",
          "BI",
          "BJ",
          "BL",
          "BM",
          "BN",
          "BO",
          "BQ",
          "BR",
          "BS",
          "BT",
          "BV",
          "BW",
          "BY",
          "BZ",
          "CA",
          "CD",
          "CF",
          "CG",
          "CH",
          "CI",
          "CK",
          "CL",
          "CM",
          "CN",
          "CO",
          "CR",
          "CV",
          "CW",
          "CY",
          "CZ",
          "DE",
          "DJ",
          "DK",
          "DM",
          "DO",
          "DZ",
          "EC",
          "EE",
          "EG",
          "EH",
          "ER",
          "ES",
          "ET",
          "FI",
          "FJ",
          "FK",
          "FO",
          "FR",
          "GA",
          "GB",
          "GD",
          "GE",
          "GF",
          "GG",
          "GH",
          "GI",
          "GL",
          "GM",
          "GN",
          "GP",
          "GQ",
          "GR",
          "GS",
          "GT",
          "GU",
          "GW",
          "GY",
          "HK",
          "HN",
          "HR",
          "HT",
          "HU",
          "ID",
          "IE",
          "IL",
          "IM",
          "IN",
          "IO",
          "IQ",
          "IS",
          "IT",
          "JE",
          "JM",
          "JO",
          "JP",
          "KE",
          "KG",
          "KH",
          "KI",
          "KM",
          "KN",
          "KR",
          "KW",
          "KY",
          "KZ",
          "LA",
          "LB",
          "LC",
          "LI",
          "LK",
          "LR",
          "LS",
          "LT",
          "LU",
          "LV",
          "LY",
          "MA",
          "MC",
          "MD",
          "ME",
          "MF",
          "MG",
          "MK",
          "ML",
          "MM",
          "MN",
          "MO",
          "MQ",
          "MR",
          "MS",
          "MT",
          "MU",
          "MV",
          "MW",
          "MX",
          "MY",
          "MZ",
          "NA",
          "NC",
          "NE",
          "NG",
          "NI",
          "NL",
          "NO",
          "NP",
          "NR",
          "NU",
          "NZ",
          "OM",
          "PA",
          "PE",
          "PF",
          "PG",
          "PH",
          "PK",
          "PL",
          "PM",
          "PN",
          "PR",
          "PS",
          "PT",
          "PY",
          "QA",
          "RE",
          "RO",
          "RS",
          "RU",
          "RW",
          "SA",
          "SB",
          "SC",
          "SD",
          "SE",
          "SG",
          "SH",
          "SI",
          "SJ",
          "SK",
          "SL",
          "SM",
          "SN",
          "SO",
          "SR",
          "SS",
          "ST",
          "SV",
          "SX",
          "SZ",
          "TA",
          "TC",
          "TD",
          "TF",
          "TG",
          "TH",
          "TJ",
          "TK",
          "TL",
          "TM",
          "TN",
          "TO",
          "TR",
          "TT",
          "TV",
          "TW",
          "TZ",
          "UA",
          "UG",
          "US",
          "UY",
          "UZ",
          "VA",
          "VC",
          "VE",
          "VG",
          "VN",
          "VU",
          "WF",
          "WS",
          "XK",
          "YE",
          "YT",
          "ZA",
          "ZM",
          "ZW",
          "ZZ"
        ],
        "type": "string"
      },
      "description": "An array of two-letter ISO country codes representing which countries Checkout should provide as options for\nshipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SY, UM, VI`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_pages_checkout_session_shipping_cost

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionShippingCost",
  "required": [
    "amount_subtotal",
    "amount_tax",
    "amount_total"
  ],
  "properties": {
    "taxes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/line_items_tax_amount"
      },
      "description": "The taxes applied to the shipping rate."
    },
    "amount_tax": {
      "type": "integer",
      "description": "Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0."
    },
    "amount_total": {
      "type": "integer",
      "description": "Total shipping cost after discounts and taxes are applied."
    },
    "shipping_rate": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/shipping_rate"
        }
      ],
      "nullable": true,
      "description": "The ID of the ShippingRate for this order.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/shipping_rate"
          }
        ]
      }
    },
    "amount_subtotal": {
      "type": "integer",
      "description": "Total shipping cost before any discounts or taxes are applied."
    }
  },
  "description": "",
  "x-expandableFields": [
    "shipping_rate",
    "taxes"
  ]
}

object payment_pages_checkout_session_shipping_option

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionShippingOption",
  "required": [
    "shipping_amount",
    "shipping_rate"
  ],
  "properties": {
    "shipping_rate": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/shipping_rate"
        }
      ],
      "description": "The shipping rate.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/shipping_rate"
          }
        ]
      }
    },
    "shipping_amount": {
      "type": "integer",
      "description": "A non-negative integer in cents representing how much to charge."
    }
  },
  "description": "",
  "x-expandableFields": [
    "shipping_rate"
  ]
}

object payment_pages_checkout_session_tax_id

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionTaxID",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "ad_nrt",
        "ae_trn",
        "al_tin",
        "am_tin",
        "ao_tin",
        "ar_cuit",
        "au_abn",
        "au_arn",
        "aw_tin",
        "az_tin",
        "ba_tin",
        "bb_tin",
        "bd_bin",
        "bf_ifu",
        "bg_uic",
        "bh_vat",
        "bj_ifu",
        "bo_tin",
        "br_cnpj",
        "br_cpf",
        "bs_tin",
        "by_tin",
        "ca_bn",
        "ca_gst_hst",
        "ca_pst_bc",
        "ca_pst_mb",
        "ca_pst_sk",
        "ca_qst",
        "cd_nif",
        "ch_uid",
        "ch_vat",
        "cl_tin",
        "cm_niu",
        "cn_tin",
        "co_nit",
        "cr_tin",
        "cv_nif",
        "de_stn",
        "do_rcn",
        "ec_ruc",
        "eg_tin",
        "es_cif",
        "et_tin",
        "eu_oss_vat",
        "eu_vat",
        "gb_vat",
        "ge_vat",
        "gn_nif",
        "hk_br",
        "hr_oib",
        "hu_tin",
        "id_npwp",
        "il_vat",
        "in_gst",
        "is_vat",
        "jp_cn",
        "jp_rn",
        "jp_trn",
        "ke_pin",
        "kg_tin",
        "kh_tin",
        "kr_brn",
        "kz_bin",
        "la_tin",
        "li_uid",
        "li_vat",
        "lk_vat",
        "ma_vat",
        "md_vat",
        "me_pib",
        "mk_vat",
        "mr_nif",
        "mx_rfc",
        "my_frp",
        "my_itn",
        "my_sst",
        "ng_tin",
        "no_vat",
        "no_voec",
        "np_pan",
        "nz_gst",
        "om_vat",
        "pe_ruc",
        "ph_tin",
        "pl_nip",
        "ro_tin",
        "rs_pib",
        "ru_inn",
        "ru_kpp",
        "sa_vat",
        "sg_gst",
        "sg_uen",
        "si_tin",
        "sn_ninea",
        "sr_fin",
        "sv_nit",
        "th_vat",
        "tj_tin",
        "tr_tin",
        "tw_vat",
        "tz_vat",
        "ua_vat",
        "ug_tin",
        "unknown",
        "us_ein",
        "uy_ruc",
        "uz_tin",
        "uz_vat",
        "ve_rif",
        "vn_tin",
        "za_vat",
        "zm_tin",
        "zw_tin"
      ],
      "type": "string",
      "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`"
    },
    "value": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The value of the tax ID."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_pages_checkout_session_tax_id_collection

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionTaxIDCollection",
  "required": [
    "enabled",
    "required"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Indicates whether tax ID collection is enabled for the session"
    },
    "required": {
      "enum": [
        "if_supported",
        "never"
      ],
      "type": "string",
      "description": "Indicates whether a tax ID is required on the payment page"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_pages_checkout_session_total_details

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionTotalDetails",
  "required": [
    "amount_discount",
    "amount_tax"
  ],
  "properties": {
    "breakdown": {
      "$ref": "#/components/schemas/payment_pages_checkout_session_total_details_resource_breakdown"
    },
    "amount_tax": {
      "type": "integer",
      "description": "This is the sum of all the tax amounts."
    },
    "amount_discount": {
      "type": "integer",
      "description": "This is the sum of all the discounts."
    },
    "amount_shipping": {
      "type": "integer",
      "nullable": true,
      "description": "This is the sum of all the shipping amounts."
    }
  },
  "description": "",
  "x-expandableFields": [
    "breakdown"
  ]
}

object payment_pages_checkout_session_total_details_resource_breakdown

{
  "type": "object",
  "title": "PaymentPagesCheckoutSessionTotalDetailsResourceBreakdown",
  "required": [
    "discounts",
    "taxes"
  ],
  "properties": {
    "taxes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/line_items_tax_amount"
      },
      "description": "The aggregated tax amounts by rate."
    },
    "discounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/line_items_discount_amount"
      },
      "description": "The aggregated discounts."
    }
  },
  "description": "",
  "x-expandableFields": [
    "discounts",
    "taxes"
  ]
}

object payment_pages_private_card_payment_method_options_resource_restrictions

{
  "type": "object",
  "title": "PaymentPagesPrivateCardPaymentMethodOptionsResourceRestrictions",
  "properties": {
    "brands_blocked": {
      "type": "array",
      "items": {
        "enum": [
          "american_express",
          "discover_global_network",
          "mastercard",
          "visa"
        ],
        "type": "string"
      },
      "description": "Specify the card brands to block in the Checkout Session. If a customer enters or selects a card belonging to a blocked brand, they can't complete the Session."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payment_record

{
  "type": "object",
  "title": "PaymentRecord",
  "required": [
    "amount",
    "amount_authorized",
    "amount_canceled",
    "amount_failed",
    "amount_guaranteed",
    "amount_refunded",
    "amount_requested",
    "created",
    "id",
    "livemode",
    "metadata",
    "object",
    "processor_details",
    "reported_by"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "amount": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount"
    },
    "object": {
      "enum": [
        "payment_record"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "application": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the Connect application that created the PaymentRecord."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An arbitrary string attached to the object. Often useful for displaying to users."
    },
    "reported_by": {
      "enum": [
        "self",
        "stripe"
      ],
      "type": "string",
      "description": "Indicates who reported the payment."
    },
    "amount_failed": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount"
    },
    "amount_canceled": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount"
    },
    "amount_refunded": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount"
    },
    "amount_requested": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount"
    },
    "customer_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payments_primitives_payment_records_resource_customer_details"
        }
      ],
      "nullable": true,
      "description": "Customer information for this payment."
    },
    "shipping_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payments_primitives_payment_records_resource_shipping_details"
        }
      ],
      "nullable": true,
      "description": "Shipping information for this payment."
    },
    "amount_authorized": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount"
    },
    "amount_guaranteed": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount"
    },
    "customer_presence": {
      "enum": [
        "off_session",
        "on_session"
      ],
      "type": "string",
      "nullable": true,
      "description": "Indicates whether the customer was present in your checkout flow during this payment."
    },
    "processor_details": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_processor_details"
    },
    "payment_method_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_details"
        }
      ],
      "nullable": true,
      "description": "Information about the Payment Method debited for this payment."
    },
    "latest_payment_attempt_record": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the latest Payment Attempt Record attached to this Payment Record."
    }
  },
  "description": "A Payment Record is a resource that allows you to represent payments that occur on- or off-Stripe.\nFor example, you can create a Payment Record to model a payment made on a different payment processor,\nin order to mark an Invoice as paid and a Subscription as active. Payment Records consist of one or\nmore Payment Attempt Records, which represent individual attempts made on a payment network.",
  "x-resourceId": "payment_record",
  "x-expandableFields": [
    "amount",
    "amount_authorized",
    "amount_canceled",
    "amount_failed",
    "amount_guaranteed",
    "amount_refunded",
    "amount_requested",
    "customer_details",
    "payment_method_details",
    "processor_details",
    "shipping_details"
  ]
}

object payment_source

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/account"
    },
    {
      "$ref": "#/components/schemas/bank_account"
    },
    {
      "$ref": "#/components/schemas/card"
    },
    {
      "$ref": "#/components/schemas/source"
    }
  ],
  "title": "Polymorphic",
  "x-resourceId": "payment_source",
  "x-stripeBypassValidation": true
}

object payments_primitives_payment_records_resource_address

{
  "type": "object",
  "title": "PaymentsPrimitivesPaymentRecordsResourceAddress",
  "properties": {
    "city": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "City, district, suburb, town, or village."
    },
    "line1": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Address line 1, such as the street, PO Box, or company name."
    },
    "line2": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Address line 2, such as the apartment, suite, unit, or building."
    },
    "state": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."
    },
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."
    },
    "postal_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ZIP or postal code."
    }
  },
  "description": "A representation of a physical address.",
  "x-expandableFields": []
}

object payments_primitives_payment_records_resource_amount

{
  "type": "object",
  "title": "PaymentsPrimitivesPaymentRecordsResourceAmount",
  "required": [
    "currency",
    "value"
  ],
  "properties": {
    "value": {
      "type": "integer",
      "description": "A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    }
  },
  "description": "A representation of an amount of money, consisting of an amount and a currency.",
  "x-expandableFields": []
}

object payments_primitives_payment_records_resource_billing_details

{
  "type": "object",
  "title": "PaymentsPrimitivesPaymentRecordsResourceBillingDetails",
  "required": [
    "address"
  ],
  "properties": {
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The billing name associated with the method of payment."
    },
    "email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The billing email associated with the method of payment."
    },
    "phone": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The billing phone number associated with the method of payment."
    },
    "address": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_address"
    }
  },
  "description": "Billing details used by the customer for this payment.",
  "x-expandableFields": [
    "address"
  ]
}

object payments_primitives_payment_records_resource_customer_details

{
  "type": "object",
  "title": "PaymentsPrimitivesPaymentRecordsResourceCustomerDetails",
  "properties": {
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The customer's name."
    },
    "email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The customer's email address."
    },
    "phone": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The customer's phone number."
    },
    "customer": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the Stripe Customer associated with this payment."
    }
  },
  "description": "Information about the customer for this payment.",
  "x-expandableFields": []
}

object payments_primitives_payment_records_resource_payment_method_card_details

{
  "type": "object",
  "title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetails",
  "properties": {
    "iin": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Issuer identification number of the card."
    },
    "brand": {
      "enum": [
        "amex",
        "cartes_bancaires",
        "diners",
        "discover",
        "eftpos_au",
        "interac",
        "jcb",
        "link",
        "mastercard",
        "unionpay",
        "unknown",
        "visa"
      ],
      "type": "string",
      "nullable": true,
      "description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`."
    },
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The last four digits of the card."
    },
    "checks": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_checks"
        }
      ],
      "nullable": true,
      "description": "Check results by Card networks on Card address and CVC at time of payment."
    },
    "issuer": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The name of the card's issuing bank."
    },
    "wallet": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet"
        }
      ],
      "nullable": true,
      "description": "If this Card is part of a card wallet, this contains the details of the card wallet."
    },
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected."
    },
    "funding": {
      "enum": [
        "credit",
        "debit",
        "prepaid",
        "unknown"
      ],
      "type": "string",
      "nullable": true,
      "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`."
    },
    "network": {
      "enum": [
        "amex",
        "cartes_bancaires",
        "diners",
        "discover",
        "eftpos_au",
        "interac",
        "jcb",
        "link",
        "mastercard",
        "unionpay",
        "unknown",
        "visa"
      ],
      "type": "string",
      "nullable": true,
      "description": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`."
    },
    "exp_year": {
      "type": "integer",
      "nullable": true,
      "description": "Four-digit number representing the card's expiration year."
    },
    "exp_month": {
      "type": "integer",
      "nullable": true,
      "description": "Two-digit number representing the card's expiration month."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A high-level description of the type of cards issued in this range."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*"
    },
    "installments": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_installments"
        }
      ],
      "nullable": true,
      "description": "Installment details for this payment."
    },
    "network_token": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_network_token"
        }
      ],
      "nullable": true,
      "description": "If this card has network token credentials, this contains the details of the network token credentials."
    },
    "capture_before": {
      "type": "integer",
      "format": "unix-time",
      "description": "When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured."
    },
    "three_d_secure": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_three_d_secure"
        }
      ],
      "nullable": true,
      "description": "Populated if this transaction used 3D Secure authentication."
    },
    "authorization_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The authorization code of the payment."
    },
    "network_advice_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Advice code from the card network for the failed payment."
    },
    "network_decline_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Decline code from the card network for the failed payment."
    },
    "network_transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise."
    },
    "stored_credential_usage": {
      "enum": [
        "recurring",
        "unscheduled"
      ],
      "type": "string",
      "nullable": true,
      "description": "The transaction type that was passed for an off-session, Merchant-Initiated transaction, one of `recurring` or `unscheduled`."
    }
  },
  "description": "Details of the card used for this payment attempt.",
  "x-expandableFields": [
    "checks",
    "installments",
    "network_token",
    "three_d_secure",
    "wallet"
  ]
}

object payments_primitives_payment_records_resource_payment_method_card_details_resource_checks

{
  "type": "object",
  "title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceChecks",
  "properties": {
    "cvc_check": {
      "enum": [
        "fail",
        "pass",
        "unavailable",
        "unchecked"
      ],
      "type": "string",
      "nullable": true,
      "description": "If you provide a CVC, the check results is one of `pass`, `fail`, `unavailable`, or `unchecked`."
    },
    "address_line1_check": {
      "enum": [
        "fail",
        "pass",
        "unavailable",
        "unchecked"
      ],
      "type": "string",
      "nullable": true,
      "description": "If you provide a value for `address.line1`, the check result is one of `pass`, `fail`, `unavailable`, or `unchecked`."
    },
    "address_postal_code_check": {
      "enum": [
        "fail",
        "pass",
        "unavailable",
        "unchecked"
      ],
      "type": "string",
      "nullable": true,
      "description": "If you provide a address postal code, the check result is one of `pass`, `fail`, `unavailable`, or `unchecked`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payments_primitives_payment_records_resource_payment_method_card_details_resource_installment_plan

{
  "type": "object",
  "title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceInstallmentPlan",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "bonus",
        "fixed_count",
        "revolving"
      ],
      "type": "string",
      "description": "Type of installment plan, one of `fixed_count`, `revolving`, or `bonus`."
    },
    "count": {
      "type": "integer",
      "nullable": true,
      "description": "For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card."
    },
    "interval": {
      "enum": [
        "month"
      ],
      "type": "string",
      "nullable": true,
      "description": "For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card. One of `month`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payments_primitives_payment_records_resource_payment_method_card_details_resource_installments

{
  "type": "object",
  "title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceInstallments",
  "properties": {
    "plan": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_installment_plan"
        }
      ],
      "nullable": true,
      "description": "Installment plan selected for the payment."
    }
  },
  "description": "",
  "x-expandableFields": [
    "plan"
  ]
}

object payments_primitives_payment_records_resource_payment_method_card_details_resource_network_token

{
  "type": "object",
  "title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceNetworkToken",
  "required": [
    "used"
  ],
  "properties": {
    "used": {
      "type": "boolean",
      "description": "Indicates if Stripe used a network token, either user provided or Stripe managed when processing the transaction."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payments_primitives_payment_records_resource_payment_method_card_details_resource_three_d_secure

{
  "type": "object",
  "title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceThreeDSecure",
  "properties": {
    "result": {
      "enum": [
        "attempt_acknowledged",
        "authenticated",
        "exempted",
        "failed",
        "not_supported",
        "processing_error"
      ],
      "type": "string",
      "nullable": true,
      "description": "Indicates the outcome of 3D Secure authentication."
    },
    "version": {
      "enum": [
        "1.0.2",
        "2.1.0",
        "2.2.0"
      ],
      "type": "string",
      "nullable": true,
      "description": "The version of 3D Secure that was used."
    },
    "cryptogram": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The 3D Secure cryptogram, also known as the \"authentication value\" (AAV, CAVV or AEVV)."
    },
    "result_reason": {
      "enum": [
        "abandoned",
        "bypassed",
        "canceled",
        "card_not_enrolled",
        "network_not_supported",
        "protocol_error",
        "rejected"
      ],
      "type": "string",
      "nullable": true,
      "description": "Additional information about why 3D Secure succeeded or failed, based on the `result`."
    },
    "authentication_flow": {
      "enum": [
        "challenge",
        "frictionless"
      ],
      "type": "string",
      "nullable": true,
      "description": "For authenticated transactions: Indicates how the issuing bank authenticated the customer."
    },
    "exemption_indicator": {
      "enum": [
        "low_risk",
        "none"
      ],
      "type": "string",
      "nullable": true,
      "description": "The exemption requested via 3DS and accepted by the issuer at authentication time."
    },
    "exemption_indicator_applied": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether Stripe requested the value of `exemption_indicator` in the transaction. This will depend on the outcome of Stripe's internal risk assessment."
    },
    "electronic_commerce_indicator": {
      "enum": [
        "01",
        "02",
        "03",
        "04",
        "05",
        "06",
        "07"
      ],
      "type": "string",
      "nullable": true,
      "description": "The Electronic Commerce Indicator (ECI). A protocol-level field indicating what degree of authentication was performed."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet

{
  "type": "object",
  "title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceWallet",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "type": "string",
      "maxLength": 5000,
      "description": "The type of the card wallet, one of `apple_pay` or `google_pay`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type."
    },
    "apple_pay": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet_resource_apple_pay"
    },
    "google_pay": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet_resource_google_pay"
    },
    "dynamic_last4": {
      "type": "string",
      "maxLength": 5000,
      "description": "(For tokenized numbers only.) The last four digits of the device account number."
    }
  },
  "description": "",
  "x-expandableFields": [
    "apple_pay",
    "google_pay"
  ]
}

object payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet_resource_apple_pay

{
  "type": "object",
  "title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceWalletResourceApplePay",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "type": "string",
      "maxLength": 5000,
      "description": "Type of the apple_pay transaction, one of `apple_pay` or `apple_pay_later`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet_resource_google_pay

{
  "type": "object",
  "title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceWalletResourceGooglePay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object payments_primitives_payment_records_resource_payment_method_custom_details

{
  "type": "object",
  "title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCustomDetails",
  "required": [
    "display_name"
  ],
  "properties": {
    "type": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The custom payment method type associated with this payment."
    },
    "display_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "Display name for the custom (user-defined) payment method type used to make this payment."
    }
  },
  "description": "Custom Payment Methods represent Payment Method types not modeled directly in\nthe Stripe API. This resource consists of details about the custom payment method\nused for this payment attempt.",
  "x-expandableFields": []
}

object payments_primitives_payment_records_resource_payment_method_details

{
  "type": "object",
  "title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails",
  "required": [
    "type"
  ],
  "properties": {
    "eps": {
      "$ref": "#/components/schemas/payment_method_details_eps"
    },
    "fpx": {
      "$ref": "#/components/schemas/payment_method_details_fpx"
    },
    "p24": {
      "$ref": "#/components/schemas/payment_method_details_p24"
    },
    "pix": {
      "$ref": "#/components/schemas/payment_method_details_payment_record_pix"
    },
    "upi": {
      "$ref": "#/components/schemas/payment_method_details_upi"
    },
    "zip": {
      "$ref": "#/components/schemas/payment_method_details_payment_record_zip"
    },
    "alma": {
      "$ref": "#/components/schemas/payment_method_details_alma"
    },
    "blik": {
      "$ref": "#/components/schemas/payment_method_details_blik"
    },
    "card": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details"
    },
    "link": {
      "$ref": "#/components/schemas/payment_method_details_link"
    },
    "oxxo": {
      "$ref": "#/components/schemas/payment_method_details_payment_record_oxxo"
    },
    "type": {
      "type": "string",
      "maxLength": 5000,
      "description": "The type of transaction-specific details of the payment method used in the payment. See [PaymentMethod.type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type) for the full list of possible types.\nAn additional hash is included on `payment_method_details` with a name matching this value.\nIt contains information specific to the payment method."
    },
    "ideal": {
      "$ref": "#/components/schemas/payment_method_details_payment_record_ideal"
    },
    "payco": {
      "$ref": "#/components/schemas/payment_method_details_payment_record_payco"
    },
    "payto": {
      "$ref": "#/components/schemas/payment_method_details_payto"
    },
    "swish": {
      "$ref": "#/components/schemas/payment_method_details_payment_record_swish"
    },
    "twint": {
      "$ref": "#/components/schemas/payment_method_details_payment_record_twint"
    },
    "affirm": {
      "$ref": "#/components/schemas/payment_method_details_payment_record_affirm"
    },
    "alipay": {
      "$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay_details"
    },
    "billie": {
      "$ref": "#/components/schemas/payment_method_details_billie"
    },
    "boleto": {
      "$ref": "#/components/schemas/payment_method_details_payment_record_boleto"
    },
    "crypto": {
      "$ref": "#/components/schemas/payment_method_details_crypto"
    },
    "custom": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_custom_details"
    },
    "klarna": {
      "$ref": "#/components/schemas/payment_method_details_klarna"
    },
    "mb_way": {
      "$ref": "#/components/schemas/payment_method_details_payment_record_mb_way"
    },
    "paynow": {
      "$ref": "#/components/schemas/payment_method_details_payment_record_paynow"
    },
    "paypal": {
      "$ref": "#/components/schemas/payment_method_details_paypal"
    },
    "sofort": {
      "$ref": "#/components/schemas/payment_method_details_payment_record_sofort"
    },
    "wechat": {
      "$ref": "#/components/schemas/payment_method_details_wechat"
    },
    "cashapp": {
      "$ref": "#/components/schemas/payment_method_details_payment_record_cashapp"
    },
    "giropay": {
      "$ref": "#/components/schemas/payment_method_details_payment_record_giropay"
    },
    "grabpay": {
      "$ref": "#/components/schemas/payment_method_details_grabpay"
    },
    "konbini": {
      "$ref": "#/components/schemas/payment_method_details_payment_record_konbini"
    },
    "kr_card": {
      "$ref": "#/components/schemas/payment_method_details_kr_card"
    },
    "satispay": {
      "$ref": "#/components/schemas/payment_method_details_satispay"
    },
    "ach_debit": {
      "$ref": "#/components/schemas/payment_method_details_ach_debit"
    },
    "kakao_pay": {
      "$ref": "#/components/schemas/payment_method_details_payment_record_kakao_pay"
    },
    "mobilepay": {
      "$ref": "#/components/schemas/payment_method_details_payment_record_mobilepay"
    },
    "naver_pay": {
      "$ref": "#/components/schemas/payment_method_details_payment_record_naver_pay"
    },
    "promptpay": {
      "$ref": "#/components/schemas/payment_method_details_payment_record_promptpay"
    },
    "acss_debit": {
      "$ref": "#/components/schemas/payment_method_details_acss_debit"
    },
    "amazon_pay": {
      "$ref": "#/components/schemas/payment_method_details_amazon_pay"
    },
    "bacs_debit": {
      "$ref": "#/components/schemas/payment_method_details_bacs_debit"
    },
    "bancontact": {
      "$ref": "#/components/schemas/payment_method_details_payment_record_bancontact"
    },
    "multibanco": {
      "$ref": "#/components/schemas/payment_method_details_payment_record_multibanco"
    },
    "sepa_debit": {
      "$ref": "#/components/schemas/payment_method_details_payment_record_sepa_debit"
    },
    "wechat_pay": {
      "$ref": "#/components/schemas/payment_method_details_payment_record_wechat_pay"
    },
    "pay_by_bank": {
      "$ref": "#/components/schemas/payment_method_details_pay_by_bank"
    },
    "revolut_pay": {
      "$ref": "#/components/schemas/payment_method_details_revolut_pay"
    },
    "samsung_pay": {
      "$ref": "#/components/schemas/payment_method_details_payment_record_samsung_pay"
    },
    "card_present": {
      "$ref": "#/components/schemas/payment_method_details_card_present"
    },
    "au_becs_debit": {
      "$ref": "#/components/schemas/payment_method_details_au_becs_debit"
    },
    "payment_method": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the Stripe PaymentMethod used to make this payment."
    },
    "stripe_account": {
      "$ref": "#/components/schemas/payment_method_details_stripe_account"
    },
    "billing_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payments_primitives_payment_records_resource_billing_details"
        }
      ],
      "nullable": true,
      "description": "The billing details associated with the method of payment."
    },
    "interac_present": {
      "$ref": "#/components/schemas/payment_method_details_interac_present"
    },
    "nz_bank_account": {
      "$ref": "#/components/schemas/payment_method_details_nz_bank_account"
    },
    "us_bank_account": {
      "$ref": "#/components/schemas/payment_method_details_payment_record_us_bank_account"
    },
    "customer_balance": {
      "$ref": "#/components/schemas/payment_method_details_customer_balance"
    },
    "afterpay_clearpay": {
      "$ref": "#/components/schemas/payment_method_details_payment_record_afterpay_clearpay"
    },
    "ach_credit_transfer": {
      "$ref": "#/components/schemas/payment_method_details_ach_credit_transfer"
    }
  },
  "description": "Details about the Payment Method used in this payment attempt.",
  "x-expandableFields": [
    "ach_credit_transfer",
    "ach_debit",
    "acss_debit",
    "affirm",
    "afterpay_clearpay",
    "alipay",
    "alma",
    "amazon_pay",
    "au_becs_debit",
    "bacs_debit",
    "bancontact",
    "billie",
    "billing_details",
    "blik",
    "boleto",
    "card",
    "card_present",
    "cashapp",
    "crypto",
    "custom",
    "customer_balance",
    "eps",
    "fpx",
    "giropay",
    "grabpay",
    "ideal",
    "interac_present",
    "kakao_pay",
    "klarna",
    "konbini",
    "kr_card",
    "link",
    "mb_way",
    "mobilepay",
    "multibanco",
    "naver_pay",
    "nz_bank_account",
    "oxxo",
    "p24",
    "pay_by_bank",
    "payco",
    "paynow",
    "paypal",
    "payto",
    "pix",
    "promptpay",
    "revolut_pay",
    "samsung_pay",
    "satispay",
    "sepa_debit",
    "sofort",
    "stripe_account",
    "swish",
    "twint",
    "upi",
    "us_bank_account",
    "wechat",
    "wechat_pay",
    "zip"
  ]
}

object payments_primitives_payment_records_resource_payment_method_konbini_details_resource_store

{
  "type": "object",
  "title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodKonbiniDetailsResourceStore",
  "properties": {
    "chain": {
      "enum": [
        "familymart",
        "lawson",
        "ministop",
        "seicomart"
      ],
      "type": "string",
      "nullable": true,
      "description": "The name of the convenience store chain where the payment was completed.",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payments_primitives_payment_records_resource_payment_method_mobilepay_details_resource_card

{
  "type": "object",
  "title": "PaymentsPrimitivesPaymentRecordsResourcePaymentMethodMobilepayDetailsResourceCard",
  "properties": {
    "brand": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Brand of the card used in the transaction"
    },
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The last 4 digits of the card"
    },
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter ISO code representing the country of the card"
    },
    "exp_year": {
      "type": "integer",
      "nullable": true,
      "description": "Two digit number representing the card's expiration year"
    },
    "exp_month": {
      "type": "integer",
      "nullable": true,
      "description": "Two digit number representing the card's expiration month"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object payments_primitives_payment_records_resource_processor_details

{
  "type": "object",
  "title": "PaymentsPrimitivesPaymentRecordsResourceProcessorDetails",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "custom"
      ],
      "type": "string",
      "description": "The processor used for this payment attempt.",
      "x-stripeBypassValidation": true
    },
    "custom": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_processor_details_resource_custom_details"
    }
  },
  "description": "Processor information associated with this payment.",
  "x-expandableFields": [
    "custom"
  ]
}

object payments_primitives_payment_records_resource_processor_details_resource_custom_details

{
  "type": "object",
  "title": "PaymentsPrimitivesPaymentRecordsResourceProcessorDetailsResourceCustomDetails",
  "properties": {
    "payment_reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID."
    }
  },
  "description": "Custom processors represent payment processors not modeled directly in\nthe Stripe API. This resource consists of details about the custom processor\nused for this payment attempt.",
  "x-expandableFields": []
}

object payments_primitives_payment_records_resource_shipping_details

{
  "type": "object",
  "title": "PaymentsPrimitivesPaymentRecordsResourceShippingDetails",
  "required": [
    "address"
  ],
  "properties": {
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The shipping recipient's name."
    },
    "phone": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The shipping recipient's phone number."
    },
    "address": {
      "$ref": "#/components/schemas/payments_primitives_payment_records_resource_address"
    }
  },
  "description": "The customer's shipping information associated with this payment.",
  "x-expandableFields": [
    "address"
  ]
}

object payout

{
  "type": "object",
  "title": "Payout",
  "required": [
    "amount",
    "arrival_date",
    "automatic",
    "created",
    "currency",
    "id",
    "livemode",
    "method",
    "object",
    "reconciliation_status",
    "source_type",
    "status",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "type": {
      "enum": [
        "bank_account",
        "card"
      ],
      "type": "string",
      "description": "Can be `bank_account` or `card`.",
      "x-stripeBypassValidation": true
    },
    "amount": {
      "type": "integer",
      "description": "The amount (in cents (or local equivalent)) that transfers to your bank account or debit card."
    },
    "method": {
      "type": "string",
      "maxLength": 5000,
      "description": "The method used to send this payout, which can be `standard` or `instant`. `instant` is supported for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks)."
    },
    "object": {
      "enum": [
        "payout"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "type": "string",
      "maxLength": 5000,
      "description": "Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it's submitted to the bank, when it becomes `in_transit`. The status changes to `paid` if the transaction succeeds, or to `failed` or `canceled` (within 5 business days). Some payouts that fail might initially show as `paid`, then change to `failed`."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "trace_id": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payouts_trace_id"
        }
      ],
      "nullable": true,
      "description": "A value that generates from the beneficiary's bank that allows users to track payouts with their bank. Banks might call this a \"reference number\" or something similar."
    },
    "automatic": {
      "type": "boolean",
      "description": "Returns `true` if the payout is created by an [automated payout schedule](https://docs.stripe.com/payouts#payout-schedule) and `false` if it's [requested manually](https://stripe.com/docs/payouts#manual-payouts)."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An arbitrary string attached to the object. Often useful for displaying to users."
    },
    "destination": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/bank_account"
        },
        {
          "$ref": "#/components/schemas/card"
        },
        {
          "$ref": "#/components/schemas/deleted_bank_account"
        },
        {
          "$ref": "#/components/schemas/deleted_card"
        }
      ],
      "nullable": true,
      "description": "ID of the bank account or card the payout is sent to.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/bank_account"
          },
          {
            "$ref": "#/components/schemas/card"
          },
          {
            "$ref": "#/components/schemas/deleted_bank_account"
          },
          {
            "$ref": "#/components/schemas/deleted_card"
          }
        ]
      },
      "x-stripeBypassValidation": true
    },
    "reversed_by": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payout"
        }
      ],
      "nullable": true,
      "description": "If the payout reverses, this is the ID of the payout that reverses this payout.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payout"
          }
        ]
      }
    },
    "source_type": {
      "type": "string",
      "maxLength": 5000,
      "description": "The source balance this payout came from, which can be one of the following: `card`, `fpx`, or `bank_account`."
    },
    "arrival_date": {
      "type": "integer",
      "format": "unix-time",
      "description": "Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays."
    },
    "failure_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://docs.stripe.com/api#payout_failures)."
    },
    "payout_method": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the v2 FinancialAccount the funds are sent to."
    },
    "application_fee": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/application_fee"
        }
      ],
      "nullable": true,
      "description": "The application fee (if any) for the payout. [See the Connect documentation](https://docs.stripe.com/connect/instant-payouts#monetization-and-fees) for details.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/application_fee"
          }
        ]
      }
    },
    "failure_message": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Message that provides the reason for a payout failure, if available."
    },
    "original_payout": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payout"
        }
      ],
      "nullable": true,
      "description": "If the payout reverses another, this is the ID of the original payout.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payout"
          }
        ]
      }
    },
    "balance_transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/balance_transaction"
        }
      ],
      "nullable": true,
      "description": "ID of the balance transaction that describes the impact of this payout on your account balance.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/balance_transaction"
          }
        ]
      }
    },
    "statement_descriptor": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Extra information about a payout that displays on the user's bank statement."
    },
    "reconciliation_status": {
      "enum": [
        "completed",
        "in_progress",
        "not_applicable"
      ],
      "type": "string",
      "description": "If `completed`, you can use the [Balance Transactions API](https://docs.stripe.com/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout."
    },
    "application_fee_amount": {
      "type": "integer",
      "nullable": true,
      "description": "The amount of the application fee (if any) requested for the payout. [See the Connect documentation](https://docs.stripe.com/connect/instant-payouts#monetization-and-fees) for details."
    },
    "failure_balance_transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/balance_transaction"
        }
      ],
      "nullable": true,
      "description": "If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/balance_transaction"
          }
        ]
      }
    }
  },
  "description": "A `Payout` object is created when you receive funds from Stripe, or when you\ninitiate a payout to either a bank account or debit card of a [connected\nStripe account](/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,\nand list all payouts. Payouts are made on [varying\nschedules](/docs/connect/manage-payout-schedule), depending on your country and\nindustry.\n\nRelated guide: [Receiving payouts](https://docs.stripe.com/payouts)",
  "x-resourceId": "payout",
  "x-expandableFields": [
    "application_fee",
    "balance_transaction",
    "destination",
    "failure_balance_transaction",
    "original_payout",
    "reversed_by",
    "trace_id"
  ]
}

object payouts_trace_id

{
  "type": "object",
  "title": "PayoutsTraceID",
  "required": [
    "status"
  ],
  "properties": {
    "value": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The trace ID value if `trace_id.status` is `supported`, otherwise `nil`."
    },
    "status": {
      "type": "string",
      "maxLength": 5000,
      "description": "Possible values are `pending`, `supported`, and `unsupported`. When `payout.status` is `pending` or `in_transit`, this will be `pending`. When the payout transitions to `paid`, `failed`, or `canceled`, this status will become `supported` or `unsupported` shortly after in most cases. In some cases, this may appear as `pending` for up to 10 days after `arrival_date` until transitioning to `supported` or `unsupported`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object paypal_seller_protection

{
  "type": "object",
  "title": "paypal_seller_protection",
  "required": [
    "status"
  ],
  "properties": {
    "status": {
      "enum": [
        "eligible",
        "not_eligible",
        "partially_eligible"
      ],
      "type": "string",
      "description": "Indicates whether the transaction is eligible for PayPal's seller protection."
    },
    "dispute_categories": {
      "type": "array",
      "items": {
        "enum": [
          "fraudulent",
          "product_not_received"
        ],
        "type": "string",
        "x-stripeBypassValidation": true
      },
      "nullable": true,
      "description": "An array of conditions that are covered for the transaction, if applicable."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object person

{
  "type": "object",
  "title": "Person",
  "required": [
    "account",
    "created",
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "dob": {
      "$ref": "#/components/schemas/legal_entity_dob"
    },
    "email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The person's email address. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`."
    },
    "phone": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The person's phone number."
    },
    "gender": {
      "type": "string",
      "nullable": true,
      "description": "The person's gender."
    },
    "object": {
      "enum": [
        "person"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "account": {
      "type": "string",
      "maxLength": 5000,
      "description": "The account the person is associated with."
    },
    "address": {
      "$ref": "#/components/schemas/address"
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "last_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The person's last name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`."
    },
    "first_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The person's first name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`."
    },
    "maiden_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The person's maiden name."
    },
    "nationality": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The country where the person is a national."
    },
    "address_kana": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/legal_entity_japan_address"
        }
      ],
      "nullable": true
    },
    "relationship": {
      "$ref": "#/components/schemas/person_relationship"
    },
    "requirements": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/person_requirements"
        }
      ],
      "nullable": true
    },
    "us_cfpb_data": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/person_us_cfpb_data"
        }
      ],
      "nullable": true,
      "description": "Demographic data related to the person."
    },
    "verification": {
      "$ref": "#/components/schemas/legal_entity_person_verification"
    },
    "address_kanji": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/legal_entity_japan_address"
        }
      ],
      "nullable": true
    },
    "last_name_kana": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Kana variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`."
    },
    "first_name_kana": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Kana variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`."
    },
    "last_name_kanji": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Kanji variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`."
    },
    "first_name_kanji": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Kanji variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`."
    },
    "full_name_aliases": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "A list of alternate names or aliases that the person is known by. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`."
    },
    "id_number_provided": {
      "type": "boolean",
      "description": "Whether the person's `id_number` was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by `ssn_last_4_provided`)."
    },
    "political_exposure": {
      "enum": [
        "existing",
        "none"
      ],
      "type": "string",
      "description": "Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction."
    },
    "registered_address": {
      "$ref": "#/components/schemas/address"
    },
    "future_requirements": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/person_future_requirements"
        }
      ],
      "nullable": true
    },
    "ssn_last_4_provided": {
      "type": "boolean",
      "description": "Whether the last four digits of the person's Social Security number have been provided (U.S. only)."
    },
    "additional_tos_acceptances": {
      "$ref": "#/components/schemas/person_additional_tos_acceptances"
    },
    "id_number_secondary_provided": {
      "type": "boolean",
      "description": "Whether the person's `id_number_secondary` was provided."
    }
  },
  "description": "This is an object representing a person associated with a Stripe account.\n\nA platform can only access a subset of data in a person for an account where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.\n\nSee the [Standard onboarding](/connect/standard-accounts) or [Express onboarding](/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](/connect/handling-api-verification#person-information).",
  "x-resourceId": "person",
  "x-expandableFields": [
    "additional_tos_acceptances",
    "address",
    "address_kana",
    "address_kanji",
    "dob",
    "future_requirements",
    "registered_address",
    "relationship",
    "requirements",
    "us_cfpb_data",
    "verification"
  ]
}

object person_additional_tos_acceptance

{
  "type": "object",
  "title": "PersonAdditionalTOSAcceptance",
  "properties": {
    "ip": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The IP address from which the legal guardian accepted the service agreement."
    },
    "date": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The Unix timestamp marking when the legal guardian accepted the service agreement."
    },
    "user_agent": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The user agent of the browser from which the legal guardian accepted the service agreement."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object person_additional_tos_acceptances

{
  "type": "object",
  "title": "PersonAdditionalTOSAcceptances",
  "properties": {
    "account": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/person_additional_tos_acceptance"
        }
      ],
      "nullable": true,
      "description": "Details on the legal guardian's acceptance of the main Stripe service agreement."
    }
  },
  "description": "",
  "x-expandableFields": [
    "account"
  ]
}

object person_ethnicity_details

{
  "type": "object",
  "title": "PersonEthnicityDetails",
  "properties": {
    "ethnicity": {
      "type": "array",
      "items": {
        "enum": [
          "cuban",
          "hispanic_or_latino",
          "mexican",
          "not_hispanic_or_latino",
          "other_hispanic_or_latino",
          "prefer_not_to_answer",
          "puerto_rican"
        ],
        "type": "string"
      },
      "nullable": true,
      "description": "The persons ethnicity"
    },
    "ethnicity_other": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Please specify your origin, when other is selected."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object person_future_requirements

{
  "type": "object",
  "title": "PersonFutureRequirements",
  "required": [
    "currently_due",
    "errors",
    "eventually_due",
    "past_due",
    "pending_verification"
  ],
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/account_requirements_error"
      },
      "description": "Details about validation and verification failures for `due` requirements that must be resolved."
    },
    "past_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Fields that haven't been resolved by the account's `requirements.current_deadline`. These fields need to be resolved to enable the person's account. `future_requirements.past_due` is a subset of `requirements.past_due`."
    },
    "alternatives": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/account_requirements_alternative"
      },
      "nullable": true,
      "description": "Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again."
    },
    "currently_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Fields that need to be resolved to keep the person's account enabled. If not resolved by the account's `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash, and may immediately become `past_due`, but the account may also be given a grace period depending on the account's enablement state prior to transition."
    },
    "eventually_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `future_requirements[current_deadline]` becomes set."
    },
    "pending_verification": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending."
    }
  },
  "description": "",
  "x-expandableFields": [
    "alternatives",
    "errors"
  ]
}

object person_race_details

{
  "type": "object",
  "title": "PersonRaceDetails",
  "properties": {
    "race": {
      "type": "array",
      "items": {
        "enum": [
          "african_american",
          "american_indian_or_alaska_native",
          "asian",
          "asian_indian",
          "black_or_african_american",
          "chinese",
          "ethiopian",
          "filipino",
          "guamanian_or_chamorro",
          "haitian",
          "jamaican",
          "japanese",
          "korean",
          "native_hawaiian",
          "native_hawaiian_or_other_pacific_islander",
          "nigerian",
          "other_asian",
          "other_black_or_african_american",
          "other_pacific_islander",
          "prefer_not_to_answer",
          "samoan",
          "somali",
          "vietnamese",
          "white"
        ],
        "type": "string"
      },
      "nullable": true,
      "description": "The persons race."
    },
    "race_other": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Please specify your race, when other is selected."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object person_relationship

{
  "type": "object",
  "title": "PersonRelationship",
  "properties": {
    "owner": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether the person is an owner of the account’s legal entity."
    },
    "title": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The person's title (e.g., CEO, Support Engineer)."
    },
    "director": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations."
    },
    "executive": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether the person has significant responsibility to control, manage, or direct the organization."
    },
    "authorizer": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether the person is the authorizer of the account's representative."
    },
    "legal_guardian": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether the person is the legal guardian of the account's representative."
    },
    "representative": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account."
    },
    "percent_ownership": {
      "type": "number",
      "nullable": true,
      "description": "The percent owned by the person of the account's legal entity."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object person_requirements

{
  "type": "object",
  "title": "PersonRequirements",
  "required": [
    "currently_due",
    "errors",
    "eventually_due",
    "past_due",
    "pending_verification"
  ],
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/account_requirements_error"
      },
      "description": "Details about validation and verification failures for `due` requirements that must be resolved."
    },
    "past_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the person's account."
    },
    "alternatives": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/account_requirements_alternative"
      },
      "nullable": true,
      "description": "Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again."
    },
    "currently_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Fields that need to be resolved to keep the person's account enabled. If not resolved by the account's `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled."
    },
    "eventually_due": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set."
    },
    "pending_verification": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending."
    }
  },
  "description": "",
  "x-expandableFields": [
    "alternatives",
    "errors"
  ]
}

object person_us_cfpb_data

{
  "type": "object",
  "title": "PersonUSCfpbData",
  "properties": {
    "race_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/person_race_details"
        }
      ],
      "nullable": true,
      "description": "The persons race details"
    },
    "ethnicity_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/person_ethnicity_details"
        }
      ],
      "nullable": true,
      "description": "The persons ethnicity details"
    },
    "self_identified_gender": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The persons self-identified gender"
    }
  },
  "description": "",
  "x-expandableFields": [
    "ethnicity_details",
    "race_details"
  ]
}

object plan

{
  "type": "object",
  "title": "Plan",
  "required": [
    "active",
    "billing_scheme",
    "created",
    "currency",
    "id",
    "interval",
    "interval_count",
    "livemode",
    "object",
    "usage_type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "meter": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The meter tracking the usage of a metered price"
    },
    "tiers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/plan_tier"
      },
      "description": "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`."
    },
    "active": {
      "type": "boolean",
      "description": "Whether the plan can be used for new purchases."
    },
    "amount": {
      "type": "integer",
      "nullable": true,
      "description": "The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`."
    },
    "object": {
      "enum": [
        "plan"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "product": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/product"
        },
        {
          "$ref": "#/components/schemas/deleted_product"
        }
      ],
      "nullable": true,
      "description": "The product whose pricing this plan determines.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/product"
          },
          {
            "$ref": "#/components/schemas/deleted_product"
          }
        ]
      }
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "interval": {
      "enum": [
        "day",
        "month",
        "week",
        "year"
      ],
      "type": "string",
      "description": "The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "nickname": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A brief description of the plan, hidden from customers."
    },
    "tiers_mode": {
      "enum": [
        "graduated",
        "volume"
      ],
      "type": "string",
      "nullable": true,
      "description": "Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows."
    },
    "usage_type": {
      "enum": [
        "licensed",
        "metered"
      ],
      "type": "string",
      "description": "Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`."
    },
    "amount_decimal": {
      "type": "string",
      "format": "decimal",
      "nullable": true,
      "description": "The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`."
    },
    "billing_scheme": {
      "enum": [
        "per_unit",
        "tiered"
      ],
      "type": "string",
      "description": "Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes."
    },
    "interval_count": {
      "type": "integer",
      "description": "The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months."
    },
    "transform_usage": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/transform_usage"
        }
      ],
      "nullable": true,
      "description": "Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`."
    },
    "trial_period_days": {
      "type": "integer",
      "nullable": true,
      "description": "Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://docs.stripe.com/api#create_subscription-trial_from_plan)."
    }
  },
  "description": "You can now model subscriptions more flexibly using the [Prices API](https://api.stripe.com#prices). It replaces the Plans API and is backwards compatible to simplify your migration.\n\nPlans define the base price, currency, and billing cycle for recurring purchases of products.\n[Products](https://api.stripe.com#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.\n\nFor example, you might have a single \"gold\" product that has plans for $10/month, $100/year, €9/month, and €90/year.\n\nRelated guides: [Set up a subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription) and more about [products and prices](https://docs.stripe.com/products-prices/overview).",
  "x-resourceId": "plan",
  "x-expandableFields": [
    "product",
    "tiers",
    "transform_usage"
  ]
}

object plan_tier

{
  "type": "object",
  "title": "PlanTier",
  "properties": {
    "up_to": {
      "type": "integer",
      "nullable": true,
      "description": "Up to and including to this quantity will be contained in the tier."
    },
    "flat_amount": {
      "type": "integer",
      "nullable": true,
      "description": "Price for the entire tier."
    },
    "unit_amount": {
      "type": "integer",
      "nullable": true,
      "description": "Per unit price for units relevant to the tier."
    },
    "flat_amount_decimal": {
      "type": "string",
      "format": "decimal",
      "nullable": true,
      "description": "Same as `flat_amount`, but contains a decimal value with at most 12 decimal places."
    },
    "unit_amount_decimal": {
      "type": "string",
      "format": "decimal",
      "nullable": true,
      "description": "Same as `unit_amount`, but contains a decimal value with at most 12 decimal places."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object platform_earning_fee_source

{
  "type": "object",
  "title": "PlatformEarningFeeSource",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "charge",
        "payout"
      ],
      "type": "string",
      "description": "Type of object that created the application fee.",
      "x-stripeBypassValidation": true
    },
    "charge": {
      "type": "string",
      "maxLength": 5000,
      "description": "Charge ID that created this application fee."
    },
    "payout": {
      "type": "string",
      "maxLength": 5000,
      "description": "Payout ID that created this application fee."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object portal_business_profile

{
  "type": "object",
  "title": "PortalBusinessProfile",
  "properties": {
    "headline": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The messaging shown to customers in the portal."
    },
    "privacy_policy_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A link to the business’s publicly available privacy policy."
    },
    "terms_of_service_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A link to the business’s publicly available terms of service."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object portal_customer_update

{
  "type": "object",
  "title": "PortalCustomerUpdate",
  "required": [
    "allowed_updates",
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Whether the feature is enabled."
    },
    "allowed_updates": {
      "type": "array",
      "items": {
        "enum": [
          "address",
          "email",
          "name",
          "phone",
          "shipping",
          "tax_id"
        ],
        "type": "string"
      },
      "description": "The types of customer updates that are supported. When empty, customers are not updateable."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object portal_features

{
  "type": "object",
  "title": "PortalFeatures",
  "required": [
    "customer_update",
    "invoice_history",
    "payment_method_update",
    "subscription_cancel",
    "subscription_update"
  ],
  "properties": {
    "customer_update": {
      "$ref": "#/components/schemas/portal_customer_update"
    },
    "invoice_history": {
      "$ref": "#/components/schemas/portal_invoice_list"
    },
    "subscription_cancel": {
      "$ref": "#/components/schemas/portal_subscription_cancel"
    },
    "subscription_update": {
      "$ref": "#/components/schemas/portal_subscription_update"
    },
    "payment_method_update": {
      "$ref": "#/components/schemas/portal_payment_method_update"
    }
  },
  "description": "",
  "x-expandableFields": [
    "customer_update",
    "invoice_history",
    "payment_method_update",
    "subscription_cancel",
    "subscription_update"
  ]
}

object portal_flows_after_completion_hosted_confirmation

{
  "type": "object",
  "title": "PortalFlowsAfterCompletionHostedConfirmation",
  "properties": {
    "custom_message": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A custom message to display to the customer after the flow is completed."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object portal_flows_after_completion_redirect

{
  "type": "object",
  "title": "PortalFlowsAfterCompletionRedirect",
  "required": [
    "return_url"
  ],
  "properties": {
    "return_url": {
      "type": "string",
      "maxLength": 5000,
      "description": "The URL the customer will be redirected to after the flow is completed."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object portal_flows_coupon_offer

{
  "type": "object",
  "title": "PortalFlowsCouponOffer",
  "required": [
    "coupon"
  ],
  "properties": {
    "coupon": {
      "type": "string",
      "maxLength": 5000,
      "description": "The ID of the coupon to be offered."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object portal_flows_flow

{
  "type": "object",
  "title": "PortalFlowsFlow",
  "required": [
    "after_completion",
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "payment_method_update",
        "subscription_cancel",
        "subscription_update",
        "subscription_update_confirm"
      ],
      "type": "string",
      "description": "Type of flow that the customer will go through."
    },
    "after_completion": {
      "$ref": "#/components/schemas/portal_flows_flow_after_completion"
    },
    "subscription_cancel": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/portal_flows_flow_subscription_cancel"
        }
      ],
      "nullable": true,
      "description": "Configuration when `flow.type=subscription_cancel`."
    },
    "subscription_update": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/portal_flows_flow_subscription_update"
        }
      ],
      "nullable": true,
      "description": "Configuration when `flow.type=subscription_update`."
    },
    "subscription_update_confirm": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/portal_flows_flow_subscription_update_confirm"
        }
      ],
      "nullable": true,
      "description": "Configuration when `flow.type=subscription_update_confirm`."
    }
  },
  "description": "",
  "x-expandableFields": [
    "after_completion",
    "subscription_cancel",
    "subscription_update",
    "subscription_update_confirm"
  ]
}

object portal_flows_flow_after_completion

{
  "type": "object",
  "title": "PortalFlowsFlowAfterCompletion",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "hosted_confirmation",
        "portal_homepage",
        "redirect"
      ],
      "type": "string",
      "description": "The specified type of behavior after the flow is completed."
    },
    "redirect": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/portal_flows_after_completion_redirect"
        }
      ],
      "nullable": true,
      "description": "Configuration when `after_completion.type=redirect`."
    },
    "hosted_confirmation": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/portal_flows_after_completion_hosted_confirmation"
        }
      ],
      "nullable": true,
      "description": "Configuration when `after_completion.type=hosted_confirmation`."
    }
  },
  "description": "",
  "x-expandableFields": [
    "hosted_confirmation",
    "redirect"
  ]
}

object portal_flows_flow_subscription_cancel

{
  "type": "object",
  "title": "PortalFlowsFlowSubscriptionCancel",
  "required": [
    "subscription"
  ],
  "properties": {
    "retention": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/portal_flows_retention"
        }
      ],
      "nullable": true,
      "description": "Specify a retention strategy to be used in the cancellation flow."
    },
    "subscription": {
      "type": "string",
      "maxLength": 5000,
      "description": "The ID of the subscription to be canceled."
    }
  },
  "description": "",
  "x-expandableFields": [
    "retention"
  ]
}

object portal_flows_flow_subscription_update

{
  "type": "object",
  "title": "PortalFlowsFlowSubscriptionUpdate",
  "required": [
    "subscription"
  ],
  "properties": {
    "subscription": {
      "type": "string",
      "maxLength": 5000,
      "description": "The ID of the subscription to be updated."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object portal_flows_flow_subscription_update_confirm

{
  "type": "object",
  "title": "PortalFlowsFlowSubscriptionUpdateConfirm",
  "required": [
    "items",
    "subscription"
  ],
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/portal_flows_subscription_update_confirm_item"
      },
      "description": "The [subscription item](https://docs.stripe.com/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable."
    },
    "discounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/portal_flows_subscription_update_confirm_discount"
      },
      "nullable": true,
      "description": "The coupon or promotion code to apply to this subscription update."
    },
    "subscription": {
      "type": "string",
      "maxLength": 5000,
      "description": "The ID of the subscription to be updated."
    }
  },
  "description": "",
  "x-expandableFields": [
    "discounts",
    "items"
  ]
}

object portal_flows_retention

{
  "type": "object",
  "title": "PortalFlowsRetention",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "coupon_offer"
      ],
      "type": "string",
      "description": "Type of retention strategy that will be used."
    },
    "coupon_offer": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/portal_flows_coupon_offer"
        }
      ],
      "nullable": true,
      "description": "Configuration when `retention.type=coupon_offer`."
    }
  },
  "description": "",
  "x-expandableFields": [
    "coupon_offer"
  ]
}

object portal_flows_subscription_update_confirm_discount

{
  "type": "object",
  "title": "PortalFlowsSubscriptionUpdateConfirmDiscount",
  "properties": {
    "coupon": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The ID of the coupon to apply to this subscription update."
    },
    "promotion_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The ID of a promotion code to apply to this subscription update."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object portal_flows_subscription_update_confirm_item

{
  "type": "object",
  "title": "PortalFlowsSubscriptionUpdateConfirmItem",
  "properties": {
    "id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The ID of the [subscription item](https://docs.stripe.com/api/subscriptions/object#subscription_object-items-data-id) to be updated."
    },
    "price": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products)."
    },
    "quantity": {
      "type": "integer",
      "description": "[Quantity](https://docs.stripe.com/subscriptions/quantities) for this item that the customer should subscribe to through this flow."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object portal_invoice_list

{
  "type": "object",
  "title": "PortalInvoiceList",
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Whether the feature is enabled."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object portal_login_page

{
  "type": "object",
  "title": "PortalLoginPage",
  "required": [
    "enabled"
  ],
  "properties": {
    "url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A shareable URL to the hosted portal login page. Your customers will be able to log in with their [email](https://docs.stripe.com/api/customers/object#customer_object-email) and receive a link to their customer portal."
    },
    "enabled": {
      "type": "boolean",
      "description": "If `true`, a shareable `url` will be generated that will take your customers to a hosted login page for the customer portal.\n\nIf `false`, the previously generated `url`, if any, will be deactivated."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object portal_payment_method_update

{
  "type": "object",
  "title": "PortalPaymentMethodUpdate",
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Whether the feature is enabled."
    },
    "payment_method_configuration": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The [Payment Method Configuration](/api/payment_method_configurations) to use for this portal session. When specified, customers will be able to update their payment method to one of the options specified by the payment method configuration. If not set, the default payment method configuration is used."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object portal_resource_schedule_update_at_period_end

{
  "type": "object",
  "title": "PortalResourceScheduleUpdateAtPeriodEnd",
  "required": [
    "conditions"
  ],
  "properties": {
    "conditions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/portal_resource_schedule_update_at_period_end_condition"
      },
      "description": "List of conditions. When any condition is true, an update will be scheduled at the end of the current period."
    }
  },
  "description": "",
  "x-expandableFields": [
    "conditions"
  ]
}

object portal_resource_schedule_update_at_period_end_condition

{
  "type": "object",
  "title": "PortalResourceScheduleUpdateAtPeriodEndCondition",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "decreasing_item_amount",
        "shortening_interval"
      ],
      "type": "string",
      "description": "The type of condition."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object portal_subscription_cancel

{
  "type": "object",
  "title": "PortalSubscriptionCancel",
  "required": [
    "cancellation_reason",
    "enabled",
    "mode",
    "proration_behavior"
  ],
  "properties": {
    "mode": {
      "enum": [
        "at_period_end",
        "immediately"
      ],
      "type": "string",
      "description": "Whether to cancel subscriptions immediately or at the end of the billing period."
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether the feature is enabled."
    },
    "proration_behavior": {
      "enum": [
        "always_invoice",
        "create_prorations",
        "none"
      ],
      "type": "string",
      "description": "Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`."
    },
    "cancellation_reason": {
      "$ref": "#/components/schemas/portal_subscription_cancellation_reason"
    }
  },
  "description": "",
  "x-expandableFields": [
    "cancellation_reason"
  ]
}

object portal_subscription_cancellation_reason

{
  "type": "object",
  "title": "PortalSubscriptionCancellationReason",
  "required": [
    "enabled",
    "options"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Whether the feature is enabled."
    },
    "options": {
      "type": "array",
      "items": {
        "enum": [
          "customer_service",
          "low_quality",
          "missing_features",
          "other",
          "switched_service",
          "too_complex",
          "too_expensive",
          "unused"
        ],
        "type": "string"
      },
      "description": "Which cancellation reasons will be given as options to the customer."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object portal_subscription_update

{
  "type": "object",
  "title": "PortalSubscriptionUpdate",
  "required": [
    "default_allowed_updates",
    "enabled",
    "proration_behavior",
    "schedule_at_period_end",
    "trial_update_behavior"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Whether the feature is enabled."
    },
    "products": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/portal_subscription_update_product"
      },
      "nullable": true,
      "description": "The list of up to 10 products that support subscription updates."
    },
    "proration_behavior": {
      "enum": [
        "always_invoice",
        "create_prorations",
        "none"
      ],
      "type": "string",
      "description": "Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`. Defaults to a value of `none` if you don't set it during creation."
    },
    "billing_cycle_anchor": {
      "enum": [
        "now",
        "unchanged"
      ],
      "type": "string",
      "nullable": true,
      "description": "Determines the value to use for the billing cycle anchor on subscription updates. Valid values are `now` or `unchanged`, and the default value is `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle)."
    },
    "trial_update_behavior": {
      "enum": [
        "continue_trial",
        "end_trial"
      ],
      "type": "string",
      "description": "Determines how handle updates to trialing subscriptions. Valid values are `end_trial` and `continue_trial`. Defaults to a value of `end_trial` if you don't set it during creation."
    },
    "schedule_at_period_end": {
      "$ref": "#/components/schemas/portal_resource_schedule_update_at_period_end"
    },
    "default_allowed_updates": {
      "type": "array",
      "items": {
        "enum": [
          "price",
          "promotion_code",
          "quantity"
        ],
        "type": "string"
      },
      "description": "The types of subscription updates that are supported for items listed in the `products` attribute. When empty, subscriptions are not updateable."
    }
  },
  "description": "",
  "x-expandableFields": [
    "products",
    "schedule_at_period_end"
  ]
}

object portal_subscription_update_product

{
  "type": "object",
  "title": "PortalSubscriptionUpdateProduct",
  "required": [
    "adjustable_quantity",
    "prices",
    "product"
  ],
  "properties": {
    "prices": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "The list of price IDs which, when subscribed to, a subscription can be updated."
    },
    "product": {
      "type": "string",
      "maxLength": 5000,
      "description": "The product ID."
    },
    "adjustable_quantity": {
      "$ref": "#/components/schemas/portal_subscription_update_product_adjustable_quantity"
    }
  },
  "description": "",
  "x-expandableFields": [
    "adjustable_quantity"
  ]
}

object portal_subscription_update_product_adjustable_quantity

{
  "type": "object",
  "title": "PortalSubscriptionUpdateProductAdjustableQuantity",
  "required": [
    "enabled",
    "minimum"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "If true, the quantity can be adjusted to any non-negative integer."
    },
    "maximum": {
      "type": "integer",
      "nullable": true,
      "description": "The maximum quantity that can be set for the product."
    },
    "minimum": {
      "type": "integer",
      "description": "The minimum quantity that can be set for the product."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object price

{
  "type": "object",
  "title": "Price",
  "required": [
    "active",
    "billing_scheme",
    "created",
    "currency",
    "id",
    "livemode",
    "metadata",
    "object",
    "product",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "type": {
      "enum": [
        "one_time",
        "recurring"
      ],
      "type": "string",
      "description": "One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase."
    },
    "tiers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/price_tier"
      },
      "description": "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`."
    },
    "active": {
      "type": "boolean",
      "description": "Whether the price can be used for new purchases."
    },
    "object": {
      "enum": [
        "price"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "product": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/product"
        },
        {
          "$ref": "#/components/schemas/deleted_product"
        }
      ],
      "description": "The ID of the product this price is associated with.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/product"
          },
          {
            "$ref": "#/components/schemas/deleted_product"
          }
        ]
      }
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "nickname": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A brief description of the price, hidden from customers."
    },
    "recurring": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/recurring"
        }
      ],
      "nullable": true,
      "description": "The recurring components of a price such as `interval` and `usage_type`."
    },
    "lookup_key": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters."
    },
    "tiers_mode": {
      "enum": [
        "graduated",
        "volume"
      ],
      "type": "string",
      "nullable": true,
      "description": "Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows."
    },
    "unit_amount": {
      "type": "integer",
      "nullable": true,
      "description": "The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`."
    },
    "tax_behavior": {
      "enum": [
        "exclusive",
        "inclusive",
        "unspecified"
      ],
      "type": "string",
      "nullable": true,
      "description": "Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed."
    },
    "billing_scheme": {
      "enum": [
        "per_unit",
        "tiered"
      ],
      "type": "string",
      "description": "Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes."
    },
    "currency_options": {
      "type": "object",
      "description": "Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).",
      "additionalProperties": {
        "$ref": "#/components/schemas/currency_option"
      }
    },
    "custom_unit_amount": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/custom_unit_amount"
        }
      ],
      "nullable": true,
      "description": "When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links."
    },
    "transform_quantity": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/transform_quantity"
        }
      ],
      "nullable": true,
      "description": "Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`."
    },
    "unit_amount_decimal": {
      "type": "string",
      "format": "decimal",
      "nullable": true,
      "description": "The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`."
    }
  },
  "description": "Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products.\n[Products](https://api.stripe.com#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.\n\nFor example, you might have a single \"gold\" product that has prices for $10/month, $100/year, and €9 once.\n\nRelated guides: [Set up a subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription), [create an invoice](https://docs.stripe.com/billing/invoices/create), and more about [products and prices](https://docs.stripe.com/products-prices/overview).",
  "x-resourceId": "price",
  "x-expandableFields": [
    "currency_options",
    "custom_unit_amount",
    "product",
    "recurring",
    "tiers",
    "transform_quantity"
  ]
}

object price_tier

{
  "type": "object",
  "title": "PriceTier",
  "properties": {
    "up_to": {
      "type": "integer",
      "nullable": true,
      "description": "Up to and including to this quantity will be contained in the tier."
    },
    "flat_amount": {
      "type": "integer",
      "nullable": true,
      "description": "Price for the entire tier."
    },
    "unit_amount": {
      "type": "integer",
      "nullable": true,
      "description": "Per unit price for units relevant to the tier."
    },
    "flat_amount_decimal": {
      "type": "string",
      "format": "decimal",
      "nullable": true,
      "description": "Same as `flat_amount`, but contains a decimal value with at most 12 decimal places."
    },
    "unit_amount_decimal": {
      "type": "string",
      "format": "decimal",
      "nullable": true,
      "description": "Same as `unit_amount`, but contains a decimal value with at most 12 decimal places."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object product

{
  "type": "object",
  "title": "Product",
  "required": [
    "active",
    "created",
    "id",
    "images",
    "livemode",
    "marketing_features",
    "metadata",
    "name",
    "object",
    "updated"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "url": {
      "type": "string",
      "nullable": true,
      "maxLength": 2048,
      "description": "A URL of a publicly-accessible webpage for this product."
    },
    "name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The product's name, meant to be displayable to the customer."
    },
    "active": {
      "type": "boolean",
      "description": "Whether the product is currently available for purchase."
    },
    "images": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer."
    },
    "object": {
      "enum": [
        "product"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "updated": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "tax_code": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/tax_code"
        }
      ],
      "nullable": true,
      "description": "A [tax code](https://docs.stripe.com/tax/tax-categories) ID.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/tax_code"
          }
        ]
      }
    },
    "shippable": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether this product is shipped (i.e., physical goods)."
    },
    "unit_label": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes."
    },
    "default_price": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/price"
        }
      ],
      "nullable": true,
      "description": "The ID of the [Price](https://docs.stripe.com/api/prices) object that is the default price for this product.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/price"
          }
        ]
      }
    },
    "marketing_features": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/product_marketing_feature"
      },
      "description": "A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://docs.stripe.com/payments/checkout/pricing-table)."
    },
    "package_dimensions": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/package_dimensions"
        }
      ],
      "nullable": true,
      "description": "The dimensions of this product for shipping purposes."
    },
    "statement_descriptor": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments."
    }
  },
  "description": "Products describe the specific goods or services you offer to your customers.\nFor example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product.\nThey can be used in conjunction with [Prices](https://api.stripe.com#prices) to configure pricing in Payment Links, Checkout, and Subscriptions.\n\nRelated guides: [Set up a subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription),\n[share a Payment Link](https://docs.stripe.com/payment-links),\n[accept payments with Checkout](https://docs.stripe.com/payments/accept-a-payment#create-product-prices-upfront),\nand more about [Products and Prices](https://docs.stripe.com/products-prices/overview)",
  "x-resourceId": "product",
  "x-expandableFields": [
    "default_price",
    "marketing_features",
    "package_dimensions",
    "tax_code"
  ]
}

object product_feature

{
  "type": "object",
  "title": "ProductFeature",
  "required": [
    "entitlement_feature",
    "id",
    "livemode",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "product_feature"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "entitlement_feature": {
      "$ref": "#/components/schemas/entitlements.feature"
    }
  },
  "description": "A product_feature represents an attachment between a feature and a product.\nWhen a product is purchased that has a feature attached, Stripe will create an entitlement to the feature for the purchasing customer.",
  "x-resourceId": "product_feature",
  "x-expandableFields": [
    "entitlement_feature"
  ]
}

object product_marketing_feature

{
  "type": "object",
  "title": "ProductMarketingFeature",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The marketing feature name. Up to 80 characters long."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object promotion_code

{
  "type": "object",
  "title": "PromotionCode",
  "required": [
    "active",
    "code",
    "created",
    "id",
    "livemode",
    "object",
    "promotion",
    "restrictions",
    "times_redeemed"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "code": {
      "type": "string",
      "maxLength": 5000,
      "description": "The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-)."
    },
    "active": {
      "type": "boolean",
      "description": "Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid."
    },
    "object": {
      "enum": [
        "promotion_code"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        },
        {
          "$ref": "#/components/schemas/deleted_customer"
        }
      ],
      "nullable": true,
      "description": "The customer who can use this promotion code.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          },
          {
            "$ref": "#/components/schemas/deleted_customer"
          }
        ]
      }
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "promotion": {
      "$ref": "#/components/schemas/promotion_codes_resource_promotion"
    },
    "expires_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Date at which the promotion code can no longer be redeemed."
    },
    "restrictions": {
      "$ref": "#/components/schemas/promotion_codes_resource_restrictions"
    },
    "times_redeemed": {
      "type": "integer",
      "description": "Number of times this promotion code has been used."
    },
    "max_redemptions": {
      "type": "integer",
      "nullable": true,
      "description": "Maximum number of times this promotion code can be redeemed."
    },
    "customer_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The account representing the customer who can use this promotion code."
    }
  },
  "description": "A Promotion Code represents a customer-redeemable code for an underlying promotion.\nYou can create multiple codes for a single promotion.\n\nIf you enable promotion codes in your [customer portal configuration](https://docs.stripe.com/customer-management/configure-portal), then customers can redeem a code themselves when updating a subscription in the portal.\nCustomers can also view the currently active promotion codes and coupons on each of their subscriptions in the portal.",
  "x-resourceId": "promotion_code",
  "x-expandableFields": [
    "customer",
    "promotion",
    "restrictions"
  ]
}

object promotion_code_currency_option

{
  "type": "object",
  "title": "PromotionCodeCurrencyOption",
  "required": [
    "minimum_amount"
  ],
  "properties": {
    "minimum_amount": {
      "type": "integer",
      "description": "Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object promotion_codes_resource_promotion

{
  "type": "object",
  "title": "PromotionCodesResourcePromotion",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "coupon"
      ],
      "type": "string",
      "description": "The type of promotion."
    },
    "coupon": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/coupon"
        }
      ],
      "nullable": true,
      "description": "If promotion `type` is `coupon`, the coupon for this promotion.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/coupon"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "coupon"
  ]
}

object promotion_codes_resource_restrictions

{
  "type": "object",
  "title": "PromotionCodesResourceRestrictions",
  "required": [
    "first_time_transaction"
  ],
  "properties": {
    "minimum_amount": {
      "type": "integer",
      "nullable": true,
      "description": "Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work)."
    },
    "currency_options": {
      "type": "object",
      "description": "Promotion code restrictions defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).",
      "additionalProperties": {
        "$ref": "#/components/schemas/promotion_code_currency_option"
      }
    },
    "first_time_transaction": {
      "type": "boolean",
      "description": "A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices"
    },
    "minimum_amount_currency": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount"
    }
  },
  "description": "",
  "x-expandableFields": [
    "currency_options"
  ]
}

object proration_details

{
  "type": "object",
  "title": "ProrationDetails",
  "required": [
    "discount_amounts"
  ],
  "properties": {
    "discount_amounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/discounts_resource_discount_amount"
      },
      "description": "Discount amounts applied when the proration was created."
    }
  },
  "description": "",
  "x-expandableFields": [
    "discount_amounts"
  ]
}

object quote

{
  "type": "object",
  "title": "Quote",
  "required": [
    "amount_subtotal",
    "amount_total",
    "automatic_tax",
    "collection_method",
    "computed",
    "created",
    "discounts",
    "expires_at",
    "id",
    "invoice_settings",
    "livemode",
    "metadata",
    "object",
    "status",
    "status_transitions",
    "subscription_data",
    "total_details"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "footer": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A footer that will be displayed on the quote PDF."
    },
    "header": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A header that will be displayed on the quote PDF."
    },
    "number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://docs.stripe.com/quotes/overview#finalize)."
    },
    "object": {
      "enum": [
        "quote"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "accepted",
        "canceled",
        "draft",
        "open"
      ],
      "type": "string",
      "description": "The status of the quote.",
      "x-stripeBypassValidation": true
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "invoice": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/invoice"
        },
        {
          "$ref": "#/components/schemas/deleted_invoice"
        }
      ],
      "nullable": true,
      "description": "The invoice that was created from this quote.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/invoice"
          },
          {
            "$ref": "#/components/schemas/deleted_invoice"
          }
        ]
      }
    },
    "computed": {
      "$ref": "#/components/schemas/quotes_resource_computed"
    },
    "currency": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        },
        {
          "$ref": "#/components/schemas/deleted_customer"
        }
      ],
      "nullable": true,
      "description": "The customer who received this quote. A customer is required to finalize the quote. Once specified, you can't change it.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          },
          {
            "$ref": "#/components/schemas/deleted_customer"
          }
        ]
      }
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "discounts": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 5000
          },
          {
            "$ref": "#/components/schemas/discount"
          }
        ],
        "x-expansionResources": {
          "oneOf": [
            {
              "$ref": "#/components/schemas/discount"
            }
          ]
        }
      },
      "description": "The discounts applied to this quote."
    },
    "expires_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch."
    },
    "from_quote": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/quotes_resource_from_quote"
        }
      ],
      "nullable": true,
      "description": "Details of the quote that was cloned. See the [cloning documentation](https://docs.stripe.com/quotes/clone) for more details."
    },
    "line_items": {
      "type": "object",
      "title": "QuotesResourceListLineItems",
      "required": [
        "data",
        "has_more",
        "object",
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "maxLength": 5000,
          "description": "The URL where this list can be accessed."
        },
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/item"
          },
          "description": "Details about each object."
        },
        "object": {
          "enum": [
            "list"
          ],
          "type": "string",
          "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
        },
        "has_more": {
          "type": "boolean",
          "description": "True if this list has another page of items after this one that can be fetched."
        }
      },
      "description": "A list of items the customer is being quoted for.",
      "x-expandableFields": [
        "data"
      ]
    },
    "test_clock": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/test_helpers.test_clock"
        }
      ],
      "nullable": true,
      "description": "ID of the test clock this quote belongs to.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/test_helpers.test_clock"
          }
        ]
      }
    },
    "application": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/application"
        },
        {
          "$ref": "#/components/schemas/deleted_application"
        }
      ],
      "nullable": true,
      "description": "ID of the Connect Application that created the quote.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/application"
          },
          {
            "$ref": "#/components/schemas/deleted_application"
          }
        ]
      }
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A description that will be displayed on the quote PDF."
    },
    "amount_total": {
      "type": "integer",
      "description": "Total after discounts and taxes are applied."
    },
    "on_behalf_of": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/account"
        }
      ],
      "nullable": true,
      "description": "The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/account"
          }
        ]
      }
    },
    "subscription": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/subscription"
        }
      ],
      "nullable": true,
      "description": "The subscription that was created or updated from this quote.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/subscription"
          }
        ]
      }
    },
    "automatic_tax": {
      "$ref": "#/components/schemas/quotes_resource_automatic_tax"
    },
    "total_details": {
      "$ref": "#/components/schemas/quotes_resource_total_details"
    },
    "transfer_data": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/quotes_resource_transfer_data"
        }
      ],
      "nullable": true,
      "description": "The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices."
    },
    "amount_subtotal": {
      "type": "integer",
      "description": "Total before any discounts or taxes are applied."
    },
    "customer_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The account representing the customer who received this quote. A customer or account is required to finalize the quote. Once specified, you can't change it."
    },
    "invoice_settings": {
      "$ref": "#/components/schemas/invoice_setting_quote_setting"
    },
    "collection_method": {
      "enum": [
        "charge_automatically",
        "send_invoice"
      ],
      "type": "string",
      "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`."
    },
    "default_tax_rates": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 5000
          },
          {
            "$ref": "#/components/schemas/tax_rate"
          }
        ],
        "x-expansionResources": {
          "oneOf": [
            {
              "$ref": "#/components/schemas/tax_rate"
            }
          ]
        }
      },
      "description": "The tax rates applied to this quote."
    },
    "subscription_data": {
      "$ref": "#/components/schemas/quotes_resource_subscription_data_subscription_data"
    },
    "status_transitions": {
      "$ref": "#/components/schemas/quotes_resource_status_transitions"
    },
    "subscription_schedule": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/subscription_schedule"
        }
      ],
      "nullable": true,
      "description": "The subscription schedule that was created or updated from this quote.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/subscription_schedule"
          }
        ]
      }
    },
    "application_fee_amount": {
      "type": "integer",
      "nullable": true,
      "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote."
    },
    "application_fee_percent": {
      "type": "number",
      "nullable": true,
      "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote."
    }
  },
  "description": "A Quote is a way to model prices that you'd like to provide to a customer.\nOnce accepted, it will automatically create an invoice, subscription or subscription schedule.",
  "x-resourceId": "quote",
  "x-expandableFields": [
    "application",
    "automatic_tax",
    "computed",
    "customer",
    "default_tax_rates",
    "discounts",
    "from_quote",
    "invoice",
    "invoice_settings",
    "line_items",
    "on_behalf_of",
    "status_transitions",
    "subscription",
    "subscription_data",
    "subscription_schedule",
    "test_clock",
    "total_details",
    "transfer_data"
  ]
}

object quotes_resource_automatic_tax

{
  "type": "object",
  "title": "QuotesResourceAutomaticTax",
  "required": [
    "enabled"
  ],
  "properties": {
    "status": {
      "enum": [
        "complete",
        "failed",
        "requires_location_inputs"
      ],
      "type": "string",
      "nullable": true,
      "description": "The status of the most recent automated tax calculation for this quote."
    },
    "enabled": {
      "type": "boolean",
      "description": "Automatically calculate taxes"
    },
    "provider": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The tax provider powering automatic tax."
    },
    "liability": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/connect_account_reference"
        }
      ],
      "nullable": true,
      "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account."
    }
  },
  "description": "",
  "x-expandableFields": [
    "liability"
  ]
}

object quotes_resource_computed

{
  "type": "object",
  "title": "QuotesResourceComputed",
  "required": [
    "upfront"
  ],
  "properties": {
    "upfront": {
      "$ref": "#/components/schemas/quotes_resource_upfront"
    },
    "recurring": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/quotes_resource_recurring"
        }
      ],
      "nullable": true,
      "description": "The definitive totals and line items the customer will be charged on a recurring basis. Takes into account the line items with recurring prices and discounts with `duration=forever` coupons only. Defaults to `null` if no inputted line items with recurring prices."
    }
  },
  "description": "",
  "x-expandableFields": [
    "recurring",
    "upfront"
  ]
}

object quotes_resource_from_quote

{
  "type": "object",
  "title": "QuotesResourceFromQuote",
  "required": [
    "is_revision",
    "quote"
  ],
  "properties": {
    "quote": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/quote"
        }
      ],
      "description": "The quote that was cloned.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/quote"
          }
        ]
      }
    },
    "is_revision": {
      "type": "boolean",
      "description": "Whether this quote is a revision of a different quote."
    }
  },
  "description": "",
  "x-expandableFields": [
    "quote"
  ]
}

object quotes_resource_recurring

{
  "type": "object",
  "title": "QuotesResourceRecurring",
  "required": [
    "amount_subtotal",
    "amount_total",
    "interval",
    "interval_count",
    "total_details"
  ],
  "properties": {
    "interval": {
      "enum": [
        "day",
        "month",
        "week",
        "year"
      ],
      "type": "string",
      "description": "The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`."
    },
    "amount_total": {
      "type": "integer",
      "description": "Total after discounts and taxes are applied."
    },
    "total_details": {
      "$ref": "#/components/schemas/quotes_resource_total_details"
    },
    "interval_count": {
      "type": "integer",
      "description": "The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months."
    },
    "amount_subtotal": {
      "type": "integer",
      "description": "Total before any discounts or taxes are applied."
    }
  },
  "description": "",
  "x-expandableFields": [
    "total_details"
  ]
}

object quotes_resource_status_transitions

{
  "type": "object",
  "title": "QuotesResourceStatusTransitions",
  "properties": {
    "accepted_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The time that the quote was accepted. Measured in seconds since Unix epoch."
    },
    "canceled_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The time that the quote was canceled. Measured in seconds since Unix epoch."
    },
    "finalized_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The time that the quote was finalized. Measured in seconds since Unix epoch."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object quotes_resource_subscription_data_billing_mode

{
  "type": "object",
  "title": "QuotesResourceSubscriptionDataBillingMode",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "classic",
        "flexible"
      ],
      "type": "string",
      "description": "Controls how prorations and invoices for subscriptions are calculated and orchestrated."
    },
    "flexible": {
      "$ref": "#/components/schemas/subscriptions_resource_billing_mode_flexible"
    }
  },
  "description": "The billing mode of the quote.",
  "x-expandableFields": [
    "flexible"
  ]
}

object quotes_resource_subscription_data_subscription_data

{
  "type": "object",
  "title": "QuotesResourceSubscriptionDataSubscriptionData",
  "required": [
    "billing_mode"
  ],
  "properties": {
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs."
    },
    "billing_mode": {
      "$ref": "#/components/schemas/quotes_resource_subscription_data_billing_mode"
    },
    "effective_date": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch."
    },
    "trial_period_days": {
      "type": "integer",
      "nullable": true,
      "description": "Integer representing the number of trial period days before the customer is charged for the first time."
    }
  },
  "description": "",
  "x-expandableFields": [
    "billing_mode"
  ]
}

object quotes_resource_total_details

{
  "type": "object",
  "title": "QuotesResourceTotalDetails",
  "required": [
    "amount_discount",
    "amount_tax"
  ],
  "properties": {
    "breakdown": {
      "$ref": "#/components/schemas/quotes_resource_total_details_resource_breakdown"
    },
    "amount_tax": {
      "type": "integer",
      "description": "This is the sum of all the tax amounts."
    },
    "amount_discount": {
      "type": "integer",
      "description": "This is the sum of all the discounts."
    },
    "amount_shipping": {
      "type": "integer",
      "nullable": true,
      "description": "This is the sum of all the shipping amounts."
    }
  },
  "description": "",
  "x-expandableFields": [
    "breakdown"
  ]
}

object quotes_resource_total_details_resource_breakdown

{
  "type": "object",
  "title": "QuotesResourceTotalDetailsResourceBreakdown",
  "required": [
    "discounts",
    "taxes"
  ],
  "properties": {
    "taxes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/line_items_tax_amount"
      },
      "description": "The aggregated tax amounts by rate."
    },
    "discounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/line_items_discount_amount"
      },
      "description": "The aggregated discounts."
    }
  },
  "description": "",
  "x-expandableFields": [
    "discounts",
    "taxes"
  ]
}

object quotes_resource_transfer_data

{
  "type": "object",
  "title": "QuotesResourceTransferData",
  "required": [
    "destination"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "nullable": true,
      "description": "The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination."
    },
    "destination": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/account"
        }
      ],
      "description": "The account where funds from the payment will be transferred to upon payment success.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/account"
          }
        ]
      }
    },
    "amount_percent": {
      "type": "number",
      "nullable": true,
      "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount will be transferred to the destination."
    }
  },
  "description": "",
  "x-expandableFields": [
    "destination"
  ]
}

object quotes_resource_upfront

{
  "type": "object",
  "title": "QuotesResourceUpfront",
  "required": [
    "amount_subtotal",
    "amount_total",
    "total_details"
  ],
  "properties": {
    "line_items": {
      "type": "object",
      "title": "QuotesResourceListLineItems",
      "required": [
        "data",
        "has_more",
        "object",
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "maxLength": 5000,
          "description": "The URL where this list can be accessed."
        },
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/item"
          },
          "description": "Details about each object."
        },
        "object": {
          "enum": [
            "list"
          ],
          "type": "string",
          "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
        },
        "has_more": {
          "type": "boolean",
          "description": "True if this list has another page of items after this one that can be fetched."
        }
      },
      "description": "The line items that will appear on the next invoice after this quote is accepted. This does not include pending invoice items that exist on the customer but may still be included in the next invoice.",
      "x-expandableFields": [
        "data"
      ]
    },
    "amount_total": {
      "type": "integer",
      "description": "Total after discounts and taxes are applied."
    },
    "total_details": {
      "$ref": "#/components/schemas/quotes_resource_total_details"
    },
    "amount_subtotal": {
      "type": "integer",
      "description": "Total before any discounts or taxes are applied."
    }
  },
  "description": "",
  "x-expandableFields": [
    "line_items",
    "total_details"
  ]
}

object radar.early_fraud_warning

{
  "type": "object",
  "title": "RadarEarlyFraudWarning",
  "required": [
    "actionable",
    "charge",
    "created",
    "fraud_type",
    "id",
    "livemode",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "charge": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/charge"
        }
      ],
      "description": "ID of the charge this early fraud warning is for, optionally expanded.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/charge"
          }
        ]
      }
    },
    "object": {
      "enum": [
        "radar.early_fraud_warning"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "actionable": {
      "type": "boolean",
      "description": "An EFW is actionable if it has not received a dispute and has not been fully refunded. You may wish to proactively refund a charge that receives an EFW, in order to avoid receiving a dispute later."
    },
    "fraud_type": {
      "type": "string",
      "maxLength": 5000,
      "description": "The type of fraud labelled by the issuer. One of `card_never_received`, `fraudulent_card_application`, `made_with_counterfeit_card`, `made_with_lost_card`, `made_with_stolen_card`, `misc`, `unauthorized_use_of_card`."
    },
    "payment_intent": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_intent"
        }
      ],
      "description": "ID of the Payment Intent this early fraud warning is for, optionally expanded.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_intent"
          }
        ]
      }
    }
  },
  "description": "An early fraud warning indicates that the card issuer has notified us that a\ncharge may be fraudulent.\n\nRelated guide: [Early fraud warnings](https://docs.stripe.com/disputes/measuring#early-fraud-warnings)",
  "x-resourceId": "radar.early_fraud_warning",
  "x-expandableFields": [
    "charge",
    "payment_intent"
  ]
}

object radar.payment_evaluation

{
  "type": "object",
  "title": "InsightsResourcesPaymentEvaluation",
  "required": [
    "created_at",
    "events",
    "id",
    "livemode",
    "object",
    "recommended_action",
    "signals"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "events": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/insights_resources_payment_evaluation_event"
      },
      "description": "Event information associated with the payment evaluation, such as refunds, dispute, early fraud warnings, or user interventions."
    },
    "object": {
      "enum": [
        "radar.payment_evaluation"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "outcome": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/insights_resources_payment_evaluation_outcome"
        }
      ],
      "nullable": true,
      "description": "Indicates the final outcome for the payment evaluation."
    },
    "signals": {
      "$ref": "#/components/schemas/insights_resources_payment_evaluation_signals"
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "created_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "payment_details": {
      "$ref": "#/components/schemas/insights_resources_payment_evaluation_payment_details"
    },
    "customer_details": {
      "$ref": "#/components/schemas/insights_resources_payment_evaluation_customer_details"
    },
    "recommended_action": {
      "enum": [
        "block",
        "continue"
      ],
      "type": "string",
      "description": "Recommended action based on the score of the fraudulent_payment signal. Possible values are `block` and `continue`."
    },
    "client_device_metadata_details": {
      "$ref": "#/components/schemas/insights_resources_payment_evaluation_client_device_metadata"
    }
  },
  "description": "Payment Evaluations represent the risk lifecycle of an externally processed payment. It includes the Radar risk score from Stripe, payment outcome taken by the merchant or processor, and any post transaction events, such as refunds or disputes. See the [Radar API guide](/radar/multiprocessor) for integration steps.",
  "x-resourceId": "radar.payment_evaluation",
  "x-expandableFields": [
    "client_device_metadata_details",
    "customer_details",
    "events",
    "outcome",
    "payment_details",
    "signals"
  ]
}

object radar.value_list

{
  "type": "object",
  "title": "RadarListList",
  "required": [
    "alias",
    "created",
    "created_by",
    "id",
    "item_type",
    "list_items",
    "livemode",
    "metadata",
    "name",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The name of the value list."
    },
    "alias": {
      "type": "string",
      "maxLength": 5000,
      "description": "The name of the value list for use in rules."
    },
    "object": {
      "enum": [
        "radar.value_list"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "item_type": {
      "enum": [
        "card_bin",
        "card_fingerprint",
        "case_sensitive_string",
        "country",
        "crypto_fingerprint",
        "customer_id",
        "email",
        "ip_address",
        "sepa_debit_fingerprint",
        "string",
        "us_bank_account_fingerprint"
      ],
      "type": "string",
      "description": "The type of items in the value list. One of `card_fingerprint`, `card_bin`, `crypto_fingerprint`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, `customer_id`, `sepa_debit_fingerprint`, or `us_bank_account_fingerprint`."
    },
    "created_by": {
      "type": "string",
      "maxLength": 5000,
      "description": "The name or email address of the user who created this value list."
    },
    "list_items": {
      "type": "object",
      "title": "RadarListListItemList",
      "required": [
        "data",
        "has_more",
        "object",
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "maxLength": 5000,
          "description": "The URL where this list can be accessed."
        },
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/radar.value_list_item"
          },
          "description": "Details about each object."
        },
        "object": {
          "enum": [
            "list"
          ],
          "type": "string",
          "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
        },
        "has_more": {
          "type": "boolean",
          "description": "True if this list has another page of items after this one that can be fetched."
        }
      },
      "description": "List of items contained within this value list.",
      "x-expandableFields": [
        "data"
      ]
    }
  },
  "description": "Value lists allow you to group values together which can then be referenced in rules.\n\nRelated guide: [Default Stripe lists](https://docs.stripe.com/radar/lists#managing-list-items)",
  "x-resourceId": "radar.value_list",
  "x-expandableFields": [
    "list_items"
  ]
}

object radar.value_list_item

{
  "type": "object",
  "title": "RadarListListItem",
  "required": [
    "created",
    "created_by",
    "id",
    "livemode",
    "object",
    "value",
    "value_list"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "value": {
      "type": "string",
      "maxLength": 5000,
      "description": "The value of the item."
    },
    "object": {
      "enum": [
        "radar.value_list_item"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "created_by": {
      "type": "string",
      "maxLength": 5000,
      "description": "The name or email address of the user who added this item to the value list."
    },
    "value_list": {
      "type": "string",
      "maxLength": 5000,
      "description": "The identifier of the value list this item belongs to."
    }
  },
  "description": "Value list items allow you to add specific values to a given Radar value list, which can then be used in rules.\n\nRelated guide: [Managing list items](https://docs.stripe.com/radar/lists#managing-list-items)",
  "x-resourceId": "radar.value_list_item",
  "x-expandableFields": []
}

object radar_radar_options

{
  "type": "object",
  "title": "RadarRadarOptions",
  "properties": {
    "session": {
      "type": "string",
      "maxLength": 5000,
      "description": "A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments."
    }
  },
  "description": "Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information.",
  "x-expandableFields": []
}

object radar_review_resource_location

{
  "type": "object",
  "title": "RadarReviewResourceLocation",
  "properties": {
    "city": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The city where the payment originated."
    },
    "region": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The state/county/province/region where the payment originated."
    },
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter ISO code representing the country where the payment originated."
    },
    "latitude": {
      "type": "number",
      "nullable": true,
      "description": "The geographic latitude where the payment originated."
    },
    "longitude": {
      "type": "number",
      "nullable": true,
      "description": "The geographic longitude where the payment originated."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object radar_review_resource_session

{
  "type": "object",
  "title": "RadarReviewResourceSession",
  "properties": {
    "device": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Information about the device used for the browser session (e.g., `Samsung SM-G930T`)."
    },
    "browser": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The browser used in this browser session (e.g., `Chrome`)."
    },
    "version": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The version for the browser session (e.g., `61.0.3163.100`)."
    },
    "platform": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The platform for the browser session (e.g., `Macintosh`)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object received_payment_method_details_financial_account

{
  "type": "object",
  "title": "received_payment_method_details_financial_account",
  "required": [
    "id",
    "network"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "The FinancialAccount ID."
    },
    "network": {
      "enum": [
        "stripe"
      ],
      "type": "string",
      "description": "The rails the ReceivedCredit was sent over. A FinancialAccount can only send funds over `stripe`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object recurring

{
  "type": "object",
  "title": "Recurring",
  "required": [
    "interval",
    "interval_count",
    "usage_type"
  ],
  "properties": {
    "meter": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The meter tracking the usage of a metered price"
    },
    "interval": {
      "enum": [
        "day",
        "month",
        "week",
        "year"
      ],
      "type": "string",
      "description": "The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`."
    },
    "usage_type": {
      "enum": [
        "licensed",
        "metered"
      ],
      "type": "string",
      "description": "Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`."
    },
    "interval_count": {
      "type": "integer",
      "description": "The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object refund

{
  "type": "object",
  "title": "Refund",
  "required": [
    "amount",
    "created",
    "currency",
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "amount": {
      "type": "integer",
      "description": "Amount, in cents (or local equivalent)."
    },
    "charge": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/charge"
        }
      ],
      "nullable": true,
      "description": "ID of the charge that's refunded.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/charge"
          }
        ]
      }
    },
    "object": {
      "enum": [
        "refund"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "reason": {
      "enum": [
        "duplicate",
        "expired_uncaptured_charge",
        "fraudulent",
        "requested_by_customer"
      ],
      "type": "string",
      "nullable": true,
      "description": "Reason for the refund, which is either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`).",
      "x-stripeBypassValidation": true
    },
    "status": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://docs.stripe.com/refunds#failed-refunds)."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "description": {
      "type": "string",
      "maxLength": 5000,
      "description": "An arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only)."
    },
    "next_action": {
      "$ref": "#/components/schemas/refund_next_action"
    },
    "failure_reason": {
      "type": "string",
      "maxLength": 5000,
      "description": "Provides the reason for the refund failure. Possible values are: `lost_or_stolen_card`, `expired_or_canceled_card`, `charge_for_pending_refund_disputed`, `insufficient_funds`, `declined`, `merchant_request`, or `unknown`."
    },
    "payment_intent": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_intent"
        }
      ],
      "nullable": true,
      "description": "ID of the PaymentIntent that's refunded.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_intent"
          }
        ]
      }
    },
    "pending_reason": {
      "enum": [
        "charge_pending",
        "insufficient_funds",
        "processing"
      ],
      "type": "string",
      "description": "Provides the reason for why the refund is pending. Possible values are: `processing`, `insufficient_funds`, or `charge_pending`."
    },
    "receipt_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "This is the transaction number that appears on email receipts sent for this refund."
    },
    "transfer_reversal": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/transfer_reversal"
        }
      ],
      "nullable": true,
      "description": "This refers to the transfer reversal object if the accompanying transfer reverses. This is only applicable if the charge was created using the destination parameter.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/transfer_reversal"
          }
        ]
      }
    },
    "instructions_email": {
      "type": "string",
      "maxLength": 5000,
      "description": "For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions."
    },
    "balance_transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/balance_transaction"
        }
      ],
      "nullable": true,
      "description": "Balance transaction that describes the impact on your account balance.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/balance_transaction"
          }
        ]
      }
    },
    "destination_details": {
      "$ref": "#/components/schemas/refund_destination_details"
    },
    "presentment_details": {
      "$ref": "#/components/schemas/payment_flows_payment_intent_presentment_details"
    },
    "source_transfer_reversal": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/transfer_reversal"
        }
      ],
      "nullable": true,
      "description": "The transfer reversal that's associated with the refund. Only present if the charge came from another Stripe account.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/transfer_reversal"
          }
        ]
      }
    },
    "failure_balance_transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/balance_transaction"
        }
      ],
      "description": "After the refund fails, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/balance_transaction"
          }
        ]
      }
    }
  },
  "description": "Refund objects allow you to refund a previously created charge that isn't\nrefunded yet. Funds are refunded to the credit or debit card that's\ninitially charged.\n\nRelated guide: [Refunds](https://docs.stripe.com/refunds)",
  "x-resourceId": "refund",
  "x-expandableFields": [
    "balance_transaction",
    "charge",
    "destination_details",
    "failure_balance_transaction",
    "next_action",
    "payment_intent",
    "presentment_details",
    "source_transfer_reversal",
    "transfer_reversal"
  ]
}

object refund_destination_details

{
  "type": "object",
  "title": "refund_destination_details",
  "required": [
    "type"
  ],
  "properties": {
    "eps": {
      "$ref": "#/components/schemas/destination_details_unimplemented"
    },
    "p24": {
      "$ref": "#/components/schemas/refund_destination_details_p24"
    },
    "pix": {
      "$ref": "#/components/schemas/destination_details_unimplemented"
    },
    "zip": {
      "$ref": "#/components/schemas/destination_details_unimplemented"
    },
    "alma": {
      "$ref": "#/components/schemas/destination_details_unimplemented"
    },
    "blik": {
      "$ref": "#/components/schemas/refund_destination_details_blik"
    },
    "card": {
      "$ref": "#/components/schemas/refund_destination_details_card"
    },
    "type": {
      "type": "string",
      "maxLength": 5000,
      "description": "The type of transaction-specific details of the payment method used in the refund (e.g., `card`). An additional hash is included on `destination_details` with a name matching this value. It contains information specific to the refund transaction."
    },
    "swish": {
      "$ref": "#/components/schemas/refund_destination_details_swish"
    },
    "twint": {
      "$ref": "#/components/schemas/destination_details_unimplemented"
    },
    "affirm": {
      "$ref": "#/components/schemas/destination_details_unimplemented"
    },
    "alipay": {
      "$ref": "#/components/schemas/destination_details_unimplemented"
    },
    "crypto": {
      "$ref": "#/components/schemas/refund_destination_details_crypto"
    },
    "klarna": {
      "$ref": "#/components/schemas/destination_details_unimplemented"
    },
    "mb_way": {
      "$ref": "#/components/schemas/refund_destination_details_mb_way"
    },
    "paynow": {
      "$ref": "#/components/schemas/destination_details_unimplemented"
    },
    "paypal": {
      "$ref": "#/components/schemas/refund_destination_details_paypal"
    },
    "sofort": {
      "$ref": "#/components/schemas/destination_details_unimplemented"
    },
    "cashapp": {
      "$ref": "#/components/schemas/destination_details_unimplemented"
    },
    "giropay": {
      "$ref": "#/components/schemas/destination_details_unimplemented"
    },
    "grabpay": {
      "$ref": "#/components/schemas/destination_details_unimplemented"
    },
    "revolut": {
      "$ref": "#/components/schemas/destination_details_unimplemented"
    },
    "amazon_pay": {
      "$ref": "#/components/schemas/destination_details_unimplemented"
    },
    "multibanco": {
      "$ref": "#/components/schemas/refund_destination_details_multibanco"
    },
    "wechat_pay": {
      "$ref": "#/components/schemas/destination_details_unimplemented"
    },
    "au_bank_transfer": {
      "$ref": "#/components/schemas/destination_details_unimplemented"
    },
    "br_bank_transfer": {
      "$ref": "#/components/schemas/refund_destination_details_br_bank_transfer"
    },
    "eu_bank_transfer": {
      "$ref": "#/components/schemas/refund_destination_details_eu_bank_transfer"
    },
    "gb_bank_transfer": {
      "$ref": "#/components/schemas/refund_destination_details_gb_bank_transfer"
    },
    "jp_bank_transfer": {
      "$ref": "#/components/schemas/refund_destination_details_jp_bank_transfer"
    },
    "mx_bank_transfer": {
      "$ref": "#/components/schemas/refund_destination_details_mx_bank_transfer"
    },
    "nz_bank_transfer": {
      "$ref": "#/components/schemas/destination_details_unimplemented"
    },
    "th_bank_transfer": {
      "$ref": "#/components/schemas/refund_destination_details_th_bank_transfer"
    },
    "us_bank_transfer": {
      "$ref": "#/components/schemas/refund_destination_details_us_bank_transfer"
    },
    "afterpay_clearpay": {
      "$ref": "#/components/schemas/destination_details_unimplemented"
    },
    "customer_cash_balance": {
      "$ref": "#/components/schemas/destination_details_unimplemented"
    }
  },
  "description": "",
  "x-expandableFields": [
    "affirm",
    "afterpay_clearpay",
    "alipay",
    "alma",
    "amazon_pay",
    "au_bank_transfer",
    "blik",
    "br_bank_transfer",
    "card",
    "cashapp",
    "crypto",
    "customer_cash_balance",
    "eps",
    "eu_bank_transfer",
    "gb_bank_transfer",
    "giropay",
    "grabpay",
    "jp_bank_transfer",
    "klarna",
    "mb_way",
    "multibanco",
    "mx_bank_transfer",
    "nz_bank_transfer",
    "p24",
    "paynow",
    "paypal",
    "pix",
    "revolut",
    "sofort",
    "swish",
    "th_bank_transfer",
    "twint",
    "us_bank_transfer",
    "wechat_pay",
    "zip"
  ]
}

object refund_destination_details_blik

{
  "type": "object",
  "title": "refund_destination_details_blik",
  "properties": {
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The reference assigned to the refund."
    },
    "reference_status": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`."
    },
    "network_decline_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object refund_destination_details_br_bank_transfer

{
  "type": "object",
  "title": "refund_destination_details_br_bank_transfer",
  "properties": {
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The reference assigned to the refund."
    },
    "reference_status": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object refund_destination_details_card

{
  "type": "object",
  "title": "refund_destination_details_card",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "pending",
        "refund",
        "reversal"
      ],
      "type": "string",
      "description": "The type of refund. This can be `refund`, `reversal`, or `pending`."
    },
    "reference": {
      "type": "string",
      "maxLength": 5000,
      "description": "Value of the reference number assigned to the refund."
    },
    "reference_type": {
      "type": "string",
      "maxLength": 5000,
      "description": "Type of the reference number assigned to the refund."
    },
    "reference_status": {
      "type": "string",
      "maxLength": 5000,
      "description": "Status of the reference number on the refund. This can be `pending`, `available` or `unavailable`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object refund_destination_details_crypto

{
  "type": "object",
  "title": "refund_destination_details_crypto",
  "properties": {
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The transaction hash of the refund."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object refund_destination_details_eu_bank_transfer

{
  "type": "object",
  "title": "refund_destination_details_eu_bank_transfer",
  "properties": {
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The reference assigned to the refund."
    },
    "reference_status": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object refund_destination_details_gb_bank_transfer

{
  "type": "object",
  "title": "refund_destination_details_gb_bank_transfer",
  "properties": {
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The reference assigned to the refund."
    },
    "reference_status": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object refund_destination_details_jp_bank_transfer

{
  "type": "object",
  "title": "refund_destination_details_jp_bank_transfer",
  "properties": {
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The reference assigned to the refund."
    },
    "reference_status": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object refund_destination_details_mb_way

{
  "type": "object",
  "title": "refund_destination_details_mb_way",
  "properties": {
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The reference assigned to the refund."
    },
    "reference_status": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object refund_destination_details_multibanco

{
  "type": "object",
  "title": "refund_destination_details_multibanco",
  "properties": {
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The reference assigned to the refund."
    },
    "reference_status": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object refund_destination_details_mx_bank_transfer

{
  "type": "object",
  "title": "refund_destination_details_mx_bank_transfer",
  "properties": {
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The reference assigned to the refund."
    },
    "reference_status": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object refund_destination_details_p24

{
  "type": "object",
  "title": "refund_destination_details_p24",
  "properties": {
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The reference assigned to the refund."
    },
    "reference_status": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object refund_destination_details_paypal

{
  "type": "object",
  "title": "refund_destination_details_paypal",
  "properties": {
    "network_decline_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object refund_destination_details_swish

{
  "type": "object",
  "title": "refund_destination_details_swish",
  "properties": {
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The reference assigned to the refund."
    },
    "reference_status": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`."
    },
    "network_decline_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object refund_destination_details_th_bank_transfer

{
  "type": "object",
  "title": "refund_destination_details_th_bank_transfer",
  "properties": {
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The reference assigned to the refund."
    },
    "reference_status": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object refund_destination_details_us_bank_transfer

{
  "type": "object",
  "title": "refund_destination_details_us_bank_transfer",
  "properties": {
    "reference": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The reference assigned to the refund."
    },
    "reference_status": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object refund_next_action

{
  "type": "object",
  "title": "RefundNextAction",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "type": "string",
      "maxLength": 5000,
      "description": "Type of the next action to perform."
    },
    "display_details": {
      "$ref": "#/components/schemas/refund_next_action_display_details"
    }
  },
  "description": "",
  "x-expandableFields": [
    "display_details"
  ]
}

object refund_next_action_display_details

{
  "type": "object",
  "title": "RefundNextActionDisplayDetails",
  "required": [
    "email_sent",
    "expires_at"
  ],
  "properties": {
    "email_sent": {
      "$ref": "#/components/schemas/email_sent"
    },
    "expires_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "The expiry timestamp."
    }
  },
  "description": "",
  "x-expandableFields": [
    "email_sent"
  ]
}

object reporting.report_run

{
  "type": "object",
  "title": "reporting_report_run",
  "required": [
    "created",
    "id",
    "livemode",
    "object",
    "parameters",
    "report_type",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "error": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "If something should go wrong during the run, a message about the failure (populated when\n `status=failed`)."
    },
    "object": {
      "enum": [
        "reporting.report_run"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "result": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "The file object representing the result of the report run (populated when\n `status=succeeded`)."
    },
    "status": {
      "type": "string",
      "maxLength": 5000,
      "description": "Status of this report run. This will be `pending` when the run is initially created.\n When the run finishes, this will be set to `succeeded` and the `result` field will be populated.\n Rarely, we may encounter an error, at which point this will be set to `failed` and the `error` field will be populated."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "livemode": {
      "type": "boolean",
      "description": "`true` if the report is run on live mode data and `false` if it is run on test mode data."
    },
    "parameters": {
      "$ref": "#/components/schemas/financial_reporting_finance_report_run_run_parameters"
    },
    "report_type": {
      "type": "string",
      "maxLength": 5000,
      "description": "The ID of the [report type](https://docs.stripe.com/reports/report-types) to run, such as `\"balance.summary.1\"`."
    },
    "succeeded_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Timestamp at which this run successfully finished (populated when\n `status=succeeded`). Measured in seconds since the Unix epoch."
    }
  },
  "description": "The Report Run object represents an instance of a report type generated with\nspecific run parameters. Once the object is created, Stripe begins processing the report.\nWhen the report has finished running, it will give you a reference to a file\nwhere you can retrieve your results. For an overview, see\n[API Access to Reports](https://docs.stripe.com/reporting/statements/api).\n\nNote that certain report types can only be run based on your live-mode data (not test-mode\ndata), and will error when queried without a [live-mode API key](https://docs.stripe.com/keys#test-live-modes).",
  "x-resourceId": "reporting.report_run",
  "x-expandableFields": [
    "parameters",
    "result"
  ]
}

object reporting.report_type

{
  "type": "object",
  "title": "reporting_report_type",
  "required": [
    "data_available_end",
    "data_available_start",
    "id",
    "livemode",
    "name",
    "object",
    "updated",
    "version"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "The [ID of the Report Type](https://docs.stripe.com/reporting/statements/api#available-report-types), such as `balance.summary.1`."
    },
    "name": {
      "type": "string",
      "maxLength": 5000,
      "description": "Human-readable name of the Report Type"
    },
    "object": {
      "enum": [
        "reporting.report_type"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "updated": {
      "type": "integer",
      "format": "unix-time",
      "description": "When this Report Type was latest updated. Measured in seconds since the Unix epoch."
    },
    "version": {
      "type": "integer",
      "description": "Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "default_columns": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the `columns` parameter, this will be null.)"
    },
    "data_available_end": {
      "type": "integer",
      "format": "unix-time",
      "description": "Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch."
    },
    "data_available_start": {
      "type": "integer",
      "format": "unix-time",
      "description": "Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch."
    }
  },
  "description": "The Report Type resource corresponds to a particular type of report, such as\nthe \"Activity summary\" or \"Itemized payouts\" reports. These objects are\nidentified by an ID belonging to a set of enumerated values. See\n[API Access to Reports documentation](https://docs.stripe.com/reporting/statements/api)\nfor those Report Type IDs, along with required and optional parameters.\n\nNote that certain report types can only be run based on your live-mode data (not test-mode\ndata), and will error when queried without a [live-mode API key](https://docs.stripe.com/keys#test-live-modes).",
  "x-resourceId": "reporting.report_type",
  "x-expandableFields": []
}

object reserve_transaction

{
  "type": "object",
  "title": "ReserveTransaction",
  "required": [
    "amount",
    "currency",
    "id",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "amount": {
      "type": "integer"
    },
    "object": {
      "enum": [
        "reserve_transaction"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An arbitrary string attached to the object. Often useful for displaying to users."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object review

{
  "type": "object",
  "title": "RadarReview",
  "required": [
    "created",
    "id",
    "livemode",
    "object",
    "open",
    "opened_reason",
    "reason"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "open": {
      "type": "boolean",
      "description": "If `true`, the review needs action."
    },
    "charge": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/charge"
        }
      ],
      "nullable": true,
      "description": "The charge associated with this review.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/charge"
          }
        ]
      }
    },
    "object": {
      "enum": [
        "review"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "reason": {
      "type": "string",
      "maxLength": 5000,
      "description": "The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, `redacted`, `canceled`, `payment_never_settled`, or `acknowledged`."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "session": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/radar_review_resource_session"
        }
      ],
      "nullable": true,
      "description": "Information related to the browsing session of the user who initiated the payment."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "ip_address": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The IP address where the payment originated."
    },
    "billing_zip": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The ZIP or postal code of the card used, if applicable."
    },
    "closed_reason": {
      "enum": [
        "acknowledged",
        "approved",
        "canceled",
        "disputed",
        "payment_never_settled",
        "redacted",
        "refunded",
        "refunded_as_fraud"
      ],
      "type": "string",
      "nullable": true,
      "description": "The reason the review was closed, or null if it has not yet been closed. One of `approved`, `refunded`, `refunded_as_fraud`, `disputed`, `redacted`, `canceled`, `payment_never_settled`, or `acknowledged`."
    },
    "opened_reason": {
      "enum": [
        "manual",
        "rule"
      ],
      "type": "string",
      "description": "The reason the review was opened. One of `rule` or `manual`."
    },
    "payment_intent": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_intent"
        }
      ],
      "description": "The PaymentIntent ID associated with this review, if one exists.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_intent"
          }
        ]
      }
    },
    "ip_address_location": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/radar_review_resource_location"
        }
      ],
      "nullable": true,
      "description": "Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address."
    }
  },
  "description": "Reviews can be used to supplement automated fraud detection with human expertise.\n\nLearn more about [Radar](/radar) and reviewing payments\n[here](https://docs.stripe.com/radar/reviews).",
  "x-resourceId": "review",
  "x-expandableFields": [
    "charge",
    "ip_address_location",
    "payment_intent",
    "session"
  ]
}

object revolut_pay_underlying_payment_method_funding_details

{
  "type": "object",
  "title": "revolut_pay_underlying_payment_method_funding_details",
  "properties": {
    "card": {
      "$ref": "#/components/schemas/payment_method_details_passthrough_card"
    },
    "type": {
      "enum": [
        "card"
      ],
      "type": "string",
      "nullable": true,
      "description": "funding type of the underlying payment method."
    }
  },
  "description": "",
  "x-expandableFields": [
    "card"
  ]
}

object rule

{
  "type": "object",
  "title": "RadarRule",
  "required": [
    "action",
    "id",
    "predicate"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "action": {
      "type": "string",
      "maxLength": 5000,
      "description": "The action taken on the payment."
    },
    "predicate": {
      "type": "string",
      "maxLength": 5000,
      "description": "The predicate to evaluate the payment against."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object scheduled_query_run

{
  "type": "object",
  "title": "ScheduledQueryRun",
  "required": [
    "created",
    "data_load_time",
    "id",
    "livemode",
    "object",
    "result_available_until",
    "sql",
    "status",
    "title"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "sql": {
      "type": "string",
      "maxLength": 100000,
      "description": "SQL for the query."
    },
    "file": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "nullable": true,
      "description": "The file object representing the results of the query."
    },
    "error": {
      "$ref": "#/components/schemas/sigma_scheduled_query_run_error"
    },
    "title": {
      "type": "string",
      "maxLength": 5000,
      "description": "Title of the query."
    },
    "object": {
      "enum": [
        "scheduled_query_run"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "type": "string",
      "maxLength": 5000,
      "description": "The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "data_load_time": {
      "type": "integer",
      "format": "unix-time",
      "description": "When the query was run, Sigma contained a snapshot of your Stripe data at this time."
    },
    "result_available_until": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the result expires and is no longer available for download."
    }
  },
  "description": "If you have [scheduled a Sigma query](https://docs.stripe.com/sigma/scheduled-queries), you'll\nreceive a `sigma.scheduled_query_run.created` webhook each time the query\nruns. The webhook contains a `ScheduledQueryRun` object, which you can use to\nretrieve the query results.",
  "x-resourceId": "scheduled_query_run",
  "x-expandableFields": [
    "error",
    "file"
  ]
}

object schedules_phase_automatic_tax

{
  "type": "object",
  "title": "SchedulesPhaseAutomaticTax",
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Whether Stripe automatically computes tax on invoices created during this phase."
    },
    "liability": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/connect_account_reference"
        }
      ],
      "nullable": true,
      "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account."
    },
    "disabled_reason": {
      "enum": [
        "requires_location_inputs"
      ],
      "type": "string",
      "nullable": true,
      "description": "If Stripe disabled automatic tax, this enum describes why."
    }
  },
  "description": "",
  "x-expandableFields": [
    "liability"
  ]
}

object secret_service_resource_scope

{
  "type": "object",
  "title": "SecretServiceResourceScope",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "account",
        "user"
      ],
      "type": "string",
      "description": "The secret scope type."
    },
    "user": {
      "type": "string",
      "maxLength": 5000,
      "description": "The user ID, if type is set to \"user\""
    }
  },
  "description": "",
  "x-expandableFields": []
}

object sepa_debit_generated_from

{
  "type": "object",
  "title": "sepa_debit_generated_from",
  "properties": {
    "charge": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/charge"
        }
      ],
      "nullable": true,
      "description": "The ID of the Charge that generated this PaymentMethod, if any.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/charge"
          }
        ]
      }
    },
    "setup_attempt": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/setup_attempt"
        }
      ],
      "nullable": true,
      "description": "The ID of the SetupAttempt that generated this PaymentMethod, if any.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/setup_attempt"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "charge",
    "setup_attempt"
  ]
}

object setup_attempt

{
  "type": "object",
  "title": "PaymentFlowsSetupIntentSetupAttempt",
  "required": [
    "created",
    "id",
    "livemode",
    "object",
    "payment_method",
    "payment_method_details",
    "setup_intent",
    "status",
    "usage"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "usage": {
      "type": "string",
      "maxLength": 5000,
      "description": "The value of [usage](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-usage) on the SetupIntent at the time of this confirmation, one of `off_session` or `on_session`."
    },
    "object": {
      "enum": [
        "setup_attempt"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "type": "string",
      "maxLength": 5000,
      "description": "Status of this SetupAttempt, one of `requires_confirmation`, `requires_action`, `processing`, `succeeded`, `failed`, or `abandoned`."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        },
        {
          "$ref": "#/components/schemas/deleted_customer"
        }
      ],
      "nullable": true,
      "description": "The value of [customer](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-customer) on the SetupIntent at the time of this confirmation.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          },
          {
            "$ref": "#/components/schemas/deleted_customer"
          }
        ]
      }
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "application": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/application"
        }
      ],
      "nullable": true,
      "description": "The value of [application](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-application) on the SetupIntent at the time of this confirmation.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/application"
          }
        ]
      }
    },
    "setup_error": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/api_errors"
        }
      ],
      "nullable": true,
      "description": "The error encountered during this attempt to confirm the SetupIntent, if any."
    },
    "on_behalf_of": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/account"
        }
      ],
      "nullable": true,
      "description": "The value of [on_behalf_of](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-on_behalf_of) on the SetupIntent at the time of this confirmation.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/account"
          }
        ]
      }
    },
    "setup_intent": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/setup_intent"
        }
      ],
      "description": "ID of the SetupIntent that this attempt belongs to.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/setup_intent"
          }
        ]
      }
    },
    "attach_to_self": {
      "type": "boolean",
      "description": "If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer."
    },
    "payment_method": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_method"
        }
      ],
      "description": "ID of the payment method used with this SetupAttempt.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_method"
          }
        ]
      }
    },
    "flow_directions": {
      "type": "array",
      "items": {
        "enum": [
          "inbound",
          "outbound"
        ],
        "type": "string"
      },
      "nullable": true,
      "description": "Indicates the directions of money movement for which this payment method is intended to be used.\n\nInclude `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes."
    },
    "customer_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The value of [customer_account](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-customer_account) on the SetupIntent at the time of this confirmation."
    },
    "payment_method_details": {
      "$ref": "#/components/schemas/setup_attempt_payment_method_details"
    }
  },
  "description": "A SetupAttempt describes one attempted confirmation of a SetupIntent,\nwhether that confirmation is successful or unsuccessful. You can use\nSetupAttempts to inspect details of a specific attempt at setting up a\npayment method using a SetupIntent.",
  "x-resourceId": "setup_attempt",
  "x-expandableFields": [
    "application",
    "customer",
    "on_behalf_of",
    "payment_method",
    "payment_method_details",
    "setup_error",
    "setup_intent"
  ]
}

object setup_attempt_payment_method_details

{
  "type": "object",
  "title": "SetupAttemptPaymentMethodDetails",
  "required": [
    "type"
  ],
  "properties": {
    "upi": {
      "$ref": "#/components/schemas/setup_attempt_payment_method_details_upi"
    },
    "card": {
      "$ref": "#/components/schemas/setup_attempt_payment_method_details_card"
    },
    "link": {
      "$ref": "#/components/schemas/setup_attempt_payment_method_details_link"
    },
    "type": {
      "type": "string",
      "maxLength": 5000,
      "description": "The type of the payment method used in the SetupIntent (e.g., `card`). An additional hash is included on `payment_method_details` with a name matching this value. It contains confirmation-specific information for the payment method."
    },
    "ideal": {
      "$ref": "#/components/schemas/setup_attempt_payment_method_details_ideal"
    },
    "payto": {
      "$ref": "#/components/schemas/setup_attempt_payment_method_details_payto"
    },
    "boleto": {
      "$ref": "#/components/schemas/setup_attempt_payment_method_details_boleto"
    },
    "klarna": {
      "$ref": "#/components/schemas/setup_attempt_payment_method_details_klarna"
    },
    "paypal": {
      "$ref": "#/components/schemas/setup_attempt_payment_method_details_paypal"
    },
    "sofort": {
      "$ref": "#/components/schemas/setup_attempt_payment_method_details_sofort"
    },
    "cashapp": {
      "$ref": "#/components/schemas/setup_attempt_payment_method_details_cashapp"
    },
    "kr_card": {
      "$ref": "#/components/schemas/setup_attempt_payment_method_details_kr_card"
    },
    "kakao_pay": {
      "$ref": "#/components/schemas/setup_attempt_payment_method_details_kakao_pay"
    },
    "naver_pay": {
      "$ref": "#/components/schemas/setup_attempt_payment_method_details_naver_pay"
    },
    "acss_debit": {
      "$ref": "#/components/schemas/setup_attempt_payment_method_details_acss_debit"
    },
    "amazon_pay": {
      "$ref": "#/components/schemas/setup_attempt_payment_method_details_amazon_pay"
    },
    "bacs_debit": {
      "$ref": "#/components/schemas/setup_attempt_payment_method_details_bacs_debit"
    },
    "bancontact": {
      "$ref": "#/components/schemas/setup_attempt_payment_method_details_bancontact"
    },
    "sepa_debit": {
      "$ref": "#/components/schemas/setup_attempt_payment_method_details_sepa_debit"
    },
    "revolut_pay": {
      "$ref": "#/components/schemas/setup_attempt_payment_method_details_revolut_pay"
    },
    "card_present": {
      "$ref": "#/components/schemas/setup_attempt_payment_method_details_card_present"
    },
    "au_becs_debit": {
      "$ref": "#/components/schemas/setup_attempt_payment_method_details_au_becs_debit"
    },
    "nz_bank_account": {
      "$ref": "#/components/schemas/setup_attempt_payment_method_details_nz_bank_account"
    },
    "us_bank_account": {
      "$ref": "#/components/schemas/setup_attempt_payment_method_details_us_bank_account"
    }
  },
  "description": "",
  "x-expandableFields": [
    "acss_debit",
    "amazon_pay",
    "au_becs_debit",
    "bacs_debit",
    "bancontact",
    "boleto",
    "card",
    "card_present",
    "cashapp",
    "ideal",
    "kakao_pay",
    "klarna",
    "kr_card",
    "link",
    "naver_pay",
    "nz_bank_account",
    "paypal",
    "payto",
    "revolut_pay",
    "sepa_debit",
    "sofort",
    "upi",
    "us_bank_account"
  ]
}

object setup_attempt_payment_method_details_acss_debit

{
  "type": "object",
  "title": "setup_attempt_payment_method_details_acss_debit",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object setup_attempt_payment_method_details_amazon_pay

{
  "type": "object",
  "title": "setup_attempt_payment_method_details_amazon_pay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object setup_attempt_payment_method_details_au_becs_debit

{
  "type": "object",
  "title": "setup_attempt_payment_method_details_au_becs_debit",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object setup_attempt_payment_method_details_bacs_debit

{
  "type": "object",
  "title": "setup_attempt_payment_method_details_bacs_debit",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object setup_attempt_payment_method_details_bancontact

{
  "type": "object",
  "title": "setup_attempt_payment_method_details_bancontact",
  "properties": {
    "bic": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Bank Identifier Code of the bank associated with the bank account."
    },
    "bank_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Bank code of bank associated with the bank account."
    },
    "bank_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Name of the bank associated with the bank account."
    },
    "iban_last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last four characters of the IBAN."
    },
    "verified_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Owner's verified full name. Values are verified or provided by Bancontact directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated."
    },
    "preferred_language": {
      "enum": [
        "de",
        "en",
        "fr",
        "nl"
      ],
      "type": "string",
      "nullable": true,
      "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.\nCan be one of `en`, `de`, `fr`, or `nl`"
    },
    "generated_sepa_debit": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_method"
        }
      ],
      "nullable": true,
      "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_method"
          }
        ]
      }
    },
    "generated_sepa_debit_mandate": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/mandate"
        }
      ],
      "nullable": true,
      "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/mandate"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "generated_sepa_debit",
    "generated_sepa_debit_mandate"
  ]
}

object setup_attempt_payment_method_details_boleto

{
  "type": "object",
  "title": "setup_attempt_payment_method_details_boleto",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object setup_attempt_payment_method_details_card

{
  "type": "object",
  "title": "setup_attempt_payment_method_details_card",
  "properties": {
    "brand": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`."
    },
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The last four digits of the card."
    },
    "checks": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/setup_attempt_payment_method_details_card_checks"
        }
      ],
      "nullable": true,
      "description": "Check results by Card networks on Card address and CVC at the time of authorization"
    },
    "wallet": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/setup_attempt_payment_method_details_card_wallet"
        }
      ],
      "nullable": true,
      "description": "If this Card is part of a card wallet, this contains the details of the card wallet."
    },
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected."
    },
    "funding": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`."
    },
    "network": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`."
    },
    "exp_year": {
      "type": "integer",
      "nullable": true,
      "description": "Four-digit number representing the card's expiration year."
    },
    "exp_month": {
      "type": "integer",
      "nullable": true,
      "description": "Two-digit number representing the card's expiration month."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*"
    },
    "three_d_secure": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/three_d_secure_details"
        }
      ],
      "nullable": true,
      "description": "Populated if this authorization used 3D Secure authentication."
    }
  },
  "description": "",
  "x-expandableFields": [
    "checks",
    "three_d_secure",
    "wallet"
  ]
}

object setup_attempt_payment_method_details_card_checks

{
  "type": "object",
  "title": "setup_attempt_payment_method_details_card_checks",
  "properties": {
    "cvc_check": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`."
    },
    "address_line1_check": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`."
    },
    "address_postal_code_check": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object setup_attempt_payment_method_details_card_present

{
  "type": "object",
  "title": "setup_attempt_payment_method_details_card_present",
  "properties": {
    "offline": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_details_card_present_offline"
        }
      ],
      "nullable": true,
      "description": "Details about payments collected offline."
    },
    "generated_card": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_method"
        }
      ],
      "nullable": true,
      "description": "The ID of the Card PaymentMethod which was generated by this SetupAttempt.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_method"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "generated_card",
    "offline"
  ]
}

object setup_attempt_payment_method_details_card_wallet

{
  "type": "object",
  "title": "setup_attempt_payment_method_details_card_wallet",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "apple_pay",
        "google_pay",
        "link"
      ],
      "type": "string",
      "description": "The type of the card wallet, one of `apple_pay`, `google_pay`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type."
    },
    "apple_pay": {
      "$ref": "#/components/schemas/payment_method_details_card_wallet_apple_pay"
    },
    "google_pay": {
      "$ref": "#/components/schemas/payment_method_details_card_wallet_google_pay"
    }
  },
  "description": "",
  "x-expandableFields": [
    "apple_pay",
    "google_pay"
  ]
}

object setup_attempt_payment_method_details_cashapp

{
  "type": "object",
  "title": "setup_attempt_payment_method_details_cashapp",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object setup_attempt_payment_method_details_ideal

{
  "type": "object",
  "title": "setup_attempt_payment_method_details_ideal",
  "properties": {
    "bic": {
      "enum": [
        "ABNANL2A",
        "ADYBNL2A",
        "ASNBNL21",
        "BITSNL2A",
        "BUNQNL2A",
        "BUUTNL2A",
        "FNOMNL22",
        "FVLBNL22",
        "HANDNL2A",
        "INGBNL2A",
        "KNABNL2H",
        "MLLENL2A",
        "MOYONL21",
        "NNBANL2G",
        "NTSBDEB1",
        "RABONL2U",
        "RBRBNL21",
        "REVOIE23",
        "REVOLT21",
        "SNSBNL2A",
        "TRIONL2U"
      ],
      "type": "string",
      "nullable": true,
      "description": "The Bank Identifier Code of the customer's bank."
    },
    "bank": {
      "enum": [
        "abn_amro",
        "adyen",
        "asn_bank",
        "bunq",
        "buut",
        "finom",
        "handelsbanken",
        "ing",
        "knab",
        "mollie",
        "moneyou",
        "n26",
        "nn",
        "rabobank",
        "regiobank",
        "revolut",
        "sns_bank",
        "triodos_bank",
        "van_lanschot",
        "yoursafe"
      ],
      "type": "string",
      "nullable": true,
      "description": "The customer's bank. Can be one of `abn_amro`, `adyen`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`."
    },
    "iban_last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last four characters of the IBAN."
    },
    "verified_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Owner's verified full name. Values are verified or provided by iDEAL directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated."
    },
    "generated_sepa_debit": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_method"
        }
      ],
      "nullable": true,
      "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_method"
          }
        ]
      }
    },
    "generated_sepa_debit_mandate": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/mandate"
        }
      ],
      "nullable": true,
      "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/mandate"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "generated_sepa_debit",
    "generated_sepa_debit_mandate"
  ]
}

object setup_attempt_payment_method_details_kakao_pay

{
  "type": "object",
  "title": "setup_attempt_payment_method_details_kakao_pay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object setup_attempt_payment_method_details_klarna

{
  "type": "object",
  "title": "setup_attempt_payment_method_details_klarna",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object setup_attempt_payment_method_details_kr_card

{
  "type": "object",
  "title": "setup_attempt_payment_method_details_kr_card",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object setup_attempt_payment_method_details_link

{
  "type": "object",
  "title": "setup_attempt_payment_method_details_link",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object setup_attempt_payment_method_details_naver_pay

{
  "type": "object",
  "title": "setup_attempt_payment_method_details_naver_pay",
  "properties": {
    "buyer_id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Uniquely identifies this particular Naver Pay account. You can use this attribute to check whether two Naver Pay accounts are the same."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object setup_attempt_payment_method_details_nz_bank_account

{
  "type": "object",
  "title": "setup_attempt_payment_method_details_nz_bank_account",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object setup_attempt_payment_method_details_paypal

{
  "type": "object",
  "title": "setup_attempt_payment_method_details_paypal",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object setup_attempt_payment_method_details_payto

{
  "type": "object",
  "title": "setup_attempt_payment_method_details_payto",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object setup_attempt_payment_method_details_revolut_pay

{
  "type": "object",
  "title": "setup_attempt_payment_method_details_revolut_pay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object setup_attempt_payment_method_details_sepa_debit

{
  "type": "object",
  "title": "setup_attempt_payment_method_details_sepa_debit",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object setup_attempt_payment_method_details_sofort

{
  "type": "object",
  "title": "setup_attempt_payment_method_details_sofort",
  "properties": {
    "bic": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Bank Identifier Code of the bank associated with the bank account."
    },
    "bank_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Bank code of bank associated with the bank account."
    },
    "bank_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Name of the bank associated with the bank account."
    },
    "iban_last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Last four characters of the IBAN."
    },
    "verified_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Owner's verified full name. Values are verified or provided by Sofort directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated."
    },
    "preferred_language": {
      "enum": [
        "de",
        "en",
        "fr",
        "nl"
      ],
      "type": "string",
      "nullable": true,
      "description": "Preferred language of the Sofort authorization page that the customer is redirected to.\nCan be one of `en`, `de`, `fr`, or `nl`"
    },
    "generated_sepa_debit": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_method"
        }
      ],
      "nullable": true,
      "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_method"
          }
        ]
      }
    },
    "generated_sepa_debit_mandate": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/mandate"
        }
      ],
      "nullable": true,
      "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/mandate"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "generated_sepa_debit",
    "generated_sepa_debit_mandate"
  ]
}

object setup_attempt_payment_method_details_upi

{
  "type": "object",
  "title": "setup_attempt_payment_method_details_upi",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object setup_attempt_payment_method_details_us_bank_account

{
  "type": "object",
  "title": "setup_attempt_payment_method_details_us_bank_account",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object setup_intent

{
  "type": "object",
  "title": "SetupIntent",
  "required": [
    "created",
    "id",
    "livemode",
    "object",
    "payment_method_types",
    "status",
    "usage"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "usage": {
      "type": "string",
      "maxLength": 5000,
      "description": "Indicates how the payment method is intended to be used in the future.\n\nUse `on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`."
    },
    "object": {
      "enum": [
        "setup_intent"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "canceled",
        "processing",
        "requires_action",
        "requires_confirmation",
        "requires_payment_method",
        "succeeded"
      ],
      "type": "string",
      "description": "[Status](https://docs.stripe.com/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "mandate": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/mandate"
        }
      ],
      "nullable": true,
      "description": "ID of the multi use Mandate generated by the SetupIntent.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/mandate"
          }
        ]
      }
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        },
        {
          "$ref": "#/components/schemas/deleted_customer"
        }
      ],
      "nullable": true,
      "description": "ID of the Customer this SetupIntent belongs to, if one exists.\n\nIf present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          },
          {
            "$ref": "#/components/schemas/deleted_customer"
          }
        ]
      }
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "application": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/application"
        }
      ],
      "nullable": true,
      "description": "ID of the Connect application that created the SetupIntent.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/application"
          }
        ]
      }
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An arbitrary string attached to the object. Often useful for displaying to users."
    },
    "next_action": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/setup_intent_next_action"
        }
      ],
      "nullable": true,
      "description": "If present, this property tells you what actions you need to take in order for your customer to continue payment setup."
    },
    "on_behalf_of": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/account"
        }
      ],
      "nullable": true,
      "description": "The account (if any) for which the setup is intended.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/account"
          }
        ]
      }
    },
    "client_secret": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.\n\nThe client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret."
    },
    "attach_to_self": {
      "type": "boolean",
      "description": "If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer."
    },
    "latest_attempt": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/setup_attempt"
        }
      ],
      "nullable": true,
      "description": "The most recent SetupAttempt for this SetupIntent.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/setup_attempt"
          }
        ]
      }
    },
    "payment_method": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_method"
        }
      ],
      "nullable": true,
      "description": "ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_method"
          }
        ]
      }
    },
    "flow_directions": {
      "type": "array",
      "items": {
        "enum": [
          "inbound",
          "outbound"
        ],
        "type": "string"
      },
      "nullable": true,
      "description": "Indicates the directions of money movement for which this payment method is intended to be used.\n\nInclude `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes."
    },
    "customer_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the Account this SetupIntent belongs to, if one exists.\n\nIf present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent."
    },
    "last_setup_error": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/api_errors"
        }
      ],
      "nullable": true,
      "description": "The error encountered in the previous SetupIntent confirmation."
    },
    "single_use_mandate": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/mandate"
        }
      ],
      "nullable": true,
      "description": "ID of the single_use Mandate generated by the SetupIntent.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/mandate"
          }
        ]
      }
    },
    "cancellation_reason": {
      "enum": [
        "abandoned",
        "duplicate",
        "requested_by_customer"
      ],
      "type": "string",
      "nullable": true,
      "description": "Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`."
    },
    "payment_method_types": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type)."
    },
    "payment_method_options": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/setup_intent_payment_method_options"
        }
      ],
      "nullable": true,
      "description": "Payment method-specific configuration for this SetupIntent."
    },
    "automatic_payment_methods": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_flows_automatic_payment_methods_setup_intent"
        }
      ],
      "nullable": true,
      "description": "Settings for dynamic payment methods compatible with this Setup Intent"
    },
    "excluded_payment_method_types": {
      "type": "array",
      "items": {
        "enum": [
          "acss_debit",
          "affirm",
          "afterpay_clearpay",
          "alipay",
          "alma",
          "amazon_pay",
          "au_becs_debit",
          "bacs_debit",
          "bancontact",
          "billie",
          "blik",
          "boleto",
          "card",
          "cashapp",
          "crypto",
          "customer_balance",
          "eps",
          "fpx",
          "giropay",
          "grabpay",
          "ideal",
          "kakao_pay",
          "klarna",
          "konbini",
          "kr_card",
          "mb_way",
          "mobilepay",
          "multibanco",
          "naver_pay",
          "nz_bank_account",
          "oxxo",
          "p24",
          "pay_by_bank",
          "payco",
          "paynow",
          "paypal",
          "payto",
          "pix",
          "promptpay",
          "revolut_pay",
          "samsung_pay",
          "satispay",
          "sepa_debit",
          "sofort",
          "swish",
          "twint",
          "upi",
          "us_bank_account",
          "wechat_pay",
          "zip"
        ],
        "type": "string",
        "x-stripeBypassValidation": true
      },
      "nullable": true,
      "description": "Payment method types that are excluded from this SetupIntent."
    },
    "payment_method_configuration_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/payment_method_config_biz_payment_method_configuration_details"
        }
      ],
      "nullable": true,
      "description": "Information about the [payment method configuration](https://docs.stripe.com/api/payment_method_configurations) used for this Setup Intent."
    }
  },
  "description": "A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.\nFor example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment.\nLater, you can use [PaymentIntents](https://api.stripe.com#payment_intents) to drive the payment flow.\n\nCreate a SetupIntent when you're ready to collect your customer's payment credentials.\nDon't maintain long-lived, unconfirmed SetupIntents because they might not be valid.\nThe SetupIntent transitions through multiple [statuses](https://docs.stripe.com/payments/intents#intent-statuses) as it guides\nyou through the setup process.\n\nSuccessful SetupIntents result in payment credentials that are optimized for future payments.\nFor example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through\n[Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection\nto streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents).\nIf you use the SetupIntent with a [Customer](https://api.stripe.com#setup_intent_object-customer),\nit automatically attaches the resulting payment method to that Customer after successful setup.\nWe recommend using SetupIntents or [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) on\nPaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.\n\nBy using SetupIntents, you can reduce friction for your customers, even as regulations change over time.\n\nRelated guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents)",
  "x-resourceId": "setup_intent",
  "x-expandableFields": [
    "application",
    "automatic_payment_methods",
    "customer",
    "last_setup_error",
    "latest_attempt",
    "mandate",
    "next_action",
    "on_behalf_of",
    "payment_method",
    "payment_method_configuration_details",
    "payment_method_options",
    "single_use_mandate"
  ]
}

object setup_intent_next_action

{
  "type": "object",
  "title": "SetupIntentNextAction",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "type": "string",
      "maxLength": 5000,
      "description": "Type of the next action to perform. Refer to the other child attributes under `next_action` for available values. Examples include: `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`."
    },
    "use_stripe_sdk": {
      "type": "object",
      "description": "When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js."
    },
    "redirect_to_url": {
      "$ref": "#/components/schemas/setup_intent_next_action_redirect_to_url"
    },
    "verify_with_microdeposits": {
      "$ref": "#/components/schemas/setup_intent_next_action_verify_with_microdeposits"
    },
    "upi_handle_redirect_or_display_qr_code": {
      "$ref": "#/components/schemas/payment_intent_next_action_upi_handle_redirect_or_display_qr_code"
    },
    "cashapp_handle_redirect_or_display_qr_code": {
      "$ref": "#/components/schemas/payment_intent_next_action_cashapp_handle_redirect_or_display_qr_code"
    }
  },
  "description": "",
  "x-expandableFields": [
    "cashapp_handle_redirect_or_display_qr_code",
    "redirect_to_url",
    "upi_handle_redirect_or_display_qr_code",
    "verify_with_microdeposits"
  ]
}

object setup_intent_next_action_redirect_to_url

{
  "type": "object",
  "title": "SetupIntentNextActionRedirectToUrl",
  "properties": {
    "url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The URL you must redirect your customer to in order to authenticate."
    },
    "return_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object setup_intent_next_action_verify_with_microdeposits

{
  "type": "object",
  "title": "SetupIntentNextActionVerifyWithMicrodeposits",
  "required": [
    "arrival_date",
    "hosted_verification_url"
  ],
  "properties": {
    "arrival_date": {
      "type": "integer",
      "format": "unix-time",
      "description": "The timestamp when the microdeposits are expected to land."
    },
    "microdeposit_type": {
      "enum": [
        "amounts",
        "descriptor_code"
      ],
      "type": "string",
      "nullable": true,
      "description": "The type of the microdeposit sent to the customer. Used to distinguish between different verification methods."
    },
    "hosted_verification_url": {
      "type": "string",
      "maxLength": 5000,
      "description": "The URL for the hosted verification page, which allows customers to verify their bank account."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object setup_intent_payment_method_options

{
  "type": "object",
  "title": "SetupIntentPaymentMethodOptions",
  "properties": {
    "upi": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/setup_intent_payment_method_options_upi"
        },
        {
          "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "card": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/setup_intent_payment_method_options_card"
        },
        {
          "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "link": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/setup_intent_payment_method_options_link"
        },
        {
          "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "payto": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/setup_intent_payment_method_options_payto"
        },
        {
          "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "klarna": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/setup_intent_payment_method_options_klarna"
        },
        {
          "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "paypal": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/setup_intent_payment_method_options_paypal"
        },
        {
          "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "acss_debit": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/setup_intent_payment_method_options_acss_debit"
        },
        {
          "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "amazon_pay": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/setup_intent_payment_method_options_amazon_pay"
        },
        {
          "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "bacs_debit": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/setup_intent_payment_method_options_bacs_debit"
        },
        {
          "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "sepa_debit": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/setup_intent_payment_method_options_sepa_debit"
        },
        {
          "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "card_present": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/setup_intent_payment_method_options_card_present"
        },
        {
          "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
        }
      ]
    },
    "us_bank_account": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/setup_intent_payment_method_options_us_bank_account"
        },
        {
          "$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
        }
      ]
    }
  },
  "description": "",
  "x-expandableFields": [
    "acss_debit",
    "amazon_pay",
    "bacs_debit",
    "card",
    "card_present",
    "klarna",
    "link",
    "paypal",
    "payto",
    "sepa_debit",
    "upi",
    "us_bank_account"
  ]
}

object setup_intent_payment_method_options_acss_debit

{
  "type": "object",
  "title": "setup_intent_payment_method_options_acss_debit",
  "properties": {
    "currency": {
      "enum": [
        "cad",
        "usd"
      ],
      "type": "string",
      "nullable": true,
      "description": "Currency supported by the bank account"
    },
    "mandate_options": {
      "$ref": "#/components/schemas/setup_intent_payment_method_options_mandate_options_acss_debit"
    },
    "verification_method": {
      "enum": [
        "automatic",
        "instant",
        "microdeposits"
      ],
      "type": "string",
      "description": "Bank account verification method. The default value is `automatic`.",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": [
    "mandate_options"
  ]
}

object setup_intent_payment_method_options_amazon_pay

{
  "type": "object",
  "title": "setup_intent_payment_method_options_amazon_pay",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object setup_intent_payment_method_options_bacs_debit

{
  "type": "object",
  "title": "setup_intent_payment_method_options_bacs_debit",
  "properties": {
    "mandate_options": {
      "$ref": "#/components/schemas/setup_intent_payment_method_options_mandate_options_bacs_debit"
    }
  },
  "description": "",
  "x-expandableFields": [
    "mandate_options"
  ]
}

object setup_intent_payment_method_options_card

{
  "type": "object",
  "title": "setup_intent_payment_method_options_card",
  "properties": {
    "network": {
      "enum": [
        "amex",
        "cartes_bancaires",
        "diners",
        "discover",
        "eftpos_au",
        "girocard",
        "interac",
        "jcb",
        "link",
        "mastercard",
        "unionpay",
        "unknown",
        "visa"
      ],
      "type": "string",
      "nullable": true,
      "description": "Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the setup intent. Can be only set confirm-time."
    },
    "mandate_options": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/setup_intent_payment_method_options_card_mandate_options"
        }
      ],
      "nullable": true,
      "description": "Configuration options for setting up an eMandate for cards issued in India."
    },
    "request_three_d_secure": {
      "enum": [
        "any",
        "automatic",
        "challenge"
      ],
      "type": "string",
      "nullable": true,
      "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://docs.stripe.com/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": [
    "mandate_options"
  ]
}

object setup_intent_payment_method_options_card_mandate_options

{
  "type": "object",
  "title": "setup_intent_payment_method_options_card_mandate_options",
  "required": [
    "amount",
    "amount_type",
    "currency",
    "interval",
    "reference",
    "start_date"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "Amount to be charged for future payments, specified in the presentment currency."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "end_date": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date."
    },
    "interval": {
      "enum": [
        "day",
        "month",
        "sporadic",
        "week",
        "year"
      ],
      "type": "string",
      "description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`."
    },
    "reference": {
      "type": "string",
      "maxLength": 80,
      "description": "Unique identifier for the mandate or subscription."
    },
    "start_date": {
      "type": "integer",
      "format": "unix-time",
      "description": "Start date of the mandate or subscription. Start date should not be lesser than yesterday."
    },
    "amount_type": {
      "enum": [
        "fixed",
        "maximum"
      ],
      "type": "string",
      "description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 200,
      "description": "A description of the mandate or subscription that is meant to be displayed to the customer."
    },
    "interval_count": {
      "type": "integer",
      "nullable": true,
      "description": "The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`."
    },
    "supported_types": {
      "type": "array",
      "items": {
        "enum": [
          "india"
        ],
        "type": "string"
      },
      "nullable": true,
      "description": "Specifies the type of mandates supported. Possible values are `india`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object setup_intent_payment_method_options_card_present

{
  "type": "object",
  "title": "setup_intent_payment_method_options_card_present",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object setup_intent_payment_method_options_klarna

{
  "type": "object",
  "title": "setup_intent_payment_method_options_klarna",
  "properties": {
    "currency": {
      "type": "string",
      "format": "currency",
      "nullable": true,
      "description": "The currency of the setup intent. Three letter ISO currency code."
    },
    "preferred_locale": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Preferred locale of the Klarna checkout page that the customer is redirected to."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object setup_intent_payment_method_options_link

{
  "type": "object",
  "title": "setup_intent_payment_method_options_link",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object setup_intent_payment_method_options_mandate_options_acss_debit

{
  "type": "object",
  "title": "setup_intent_payment_method_options_mandate_options_acss_debit",
  "properties": {
    "default_for": {
      "type": "array",
      "items": {
        "enum": [
          "invoice",
          "subscription"
        ],
        "type": "string"
      },
      "description": "List of Stripe products where this mandate can be selected automatically."
    },
    "payment_schedule": {
      "enum": [
        "combined",
        "interval",
        "sporadic"
      ],
      "type": "string",
      "nullable": true,
      "description": "Payment schedule for the mandate."
    },
    "transaction_type": {
      "enum": [
        "business",
        "personal"
      ],
      "type": "string",
      "nullable": true,
      "description": "Transaction type of the mandate."
    },
    "custom_mandate_url": {
      "type": "string",
      "maxLength": 5000,
      "description": "A URL for custom mandate text"
    },
    "interval_description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object setup_intent_payment_method_options_mandate_options_bacs_debit

{
  "type": "object",
  "title": "setup_intent_payment_method_options_mandate_options_bacs_debit",
  "properties": {
    "reference_prefix": {
      "type": "string",
      "maxLength": 5000,
      "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object setup_intent_payment_method_options_mandate_options_payto

{
  "type": "object",
  "title": "setup_intent_payment_method_options_mandate_options_payto",
  "properties": {
    "amount": {
      "type": "integer",
      "nullable": true,
      "description": "Amount that will be collected. It is required when `amount_type` is `fixed`."
    },
    "purpose": {
      "enum": [
        "dependant_support",
        "government",
        "loan",
        "mortgage",
        "other",
        "pension",
        "personal",
        "retail",
        "salary",
        "tax",
        "utility"
      ],
      "type": "string",
      "nullable": true,
      "description": "The purpose for which payments are made. Has a default value based on your merchant category code."
    },
    "end_date": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date."
    },
    "start_date": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time."
    },
    "amount_type": {
      "enum": [
        "fixed",
        "maximum"
      ],
      "type": "string",
      "nullable": true,
      "description": "The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. Defaults to `maximum`."
    },
    "payment_schedule": {
      "enum": [
        "adhoc",
        "annual",
        "daily",
        "fortnightly",
        "monthly",
        "quarterly",
        "semi_annual",
        "weekly"
      ],
      "type": "string",
      "nullable": true,
      "description": "The periodicity at which payments will be collected. Defaults to `adhoc`."
    },
    "payments_per_period": {
      "type": "integer",
      "nullable": true,
      "description": "The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object setup_intent_payment_method_options_mandate_options_sepa_debit

{
  "type": "object",
  "title": "setup_intent_payment_method_options_mandate_options_sepa_debit",
  "properties": {
    "reference_prefix": {
      "type": "string",
      "maxLength": 5000,
      "description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object setup_intent_payment_method_options_paypal

{
  "type": "object",
  "title": "setup_intent_payment_method_options_paypal",
  "properties": {
    "billing_agreement_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object setup_intent_payment_method_options_payto

{
  "type": "object",
  "title": "setup_intent_payment_method_options_payto",
  "properties": {
    "mandate_options": {
      "$ref": "#/components/schemas/setup_intent_payment_method_options_mandate_options_payto"
    }
  },
  "description": "",
  "x-expandableFields": [
    "mandate_options"
  ]
}

object setup_intent_payment_method_options_sepa_debit

{
  "type": "object",
  "title": "setup_intent_payment_method_options_sepa_debit",
  "properties": {
    "mandate_options": {
      "$ref": "#/components/schemas/setup_intent_payment_method_options_mandate_options_sepa_debit"
    }
  },
  "description": "",
  "x-expandableFields": [
    "mandate_options"
  ]
}

object setup_intent_payment_method_options_upi

{
  "type": "object",
  "title": "setup_intent_payment_method_options_upi",
  "properties": {
    "mandate_options": {
      "$ref": "#/components/schemas/payment_method_options_mandate_options_upi"
    }
  },
  "description": "",
  "x-expandableFields": [
    "mandate_options"
  ]
}

object setup_intent_payment_method_options_us_bank_account

{
  "type": "object",
  "title": "setup_intent_payment_method_options_us_bank_account",
  "properties": {
    "mandate_options": {
      "$ref": "#/components/schemas/payment_method_options_us_bank_account_mandate_options"
    },
    "verification_method": {
      "enum": [
        "automatic",
        "instant",
        "microdeposits"
      ],
      "type": "string",
      "description": "Bank account verification method. The default value is `automatic`.",
      "x-stripeBypassValidation": true
    },
    "financial_connections": {
      "$ref": "#/components/schemas/linked_account_options_common"
    }
  },
  "description": "",
  "x-expandableFields": [
    "financial_connections",
    "mandate_options"
  ]
}

object setup_intent_type_specific_payment_method_options_client

{
  "type": "object",
  "title": "SetupIntentTypeSpecificPaymentMethodOptionsClient",
  "properties": {
    "mandate_options": {
      "$ref": "#/components/schemas/setup_intent_payment_method_options_mandate_options_payto"
    },
    "verification_method": {
      "enum": [
        "automatic",
        "instant",
        "microdeposits"
      ],
      "type": "string",
      "description": "Bank account verification method. The default value is `automatic`.",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": [
    "mandate_options"
  ]
}

object shipping

{
  "type": "object",
  "title": "Shipping",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 5000,
      "description": "Recipient name."
    },
    "phone": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Recipient phone (including extension)."
    },
    "address": {
      "$ref": "#/components/schemas/address"
    },
    "carrier": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc."
    },
    "tracking_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas."
    }
  },
  "description": "",
  "x-expandableFields": [
    "address"
  ]
}

object shipping_rate

{
  "type": "object",
  "title": "ShippingRate",
  "required": [
    "active",
    "created",
    "id",
    "livemode",
    "metadata",
    "object",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "type": {
      "enum": [
        "fixed_amount"
      ],
      "type": "string",
      "description": "The type of calculation to use on the shipping rate."
    },
    "active": {
      "type": "boolean",
      "description": "Whether the shipping rate can be used for new purchases. Defaults to `true`."
    },
    "object": {
      "enum": [
        "shipping_rate"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "tax_code": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/tax_code"
        }
      ],
      "nullable": true,
      "description": "A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/tax_code"
          }
        ]
      }
    },
    "display_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions."
    },
    "fixed_amount": {
      "$ref": "#/components/schemas/shipping_rate_fixed_amount"
    },
    "tax_behavior": {
      "enum": [
        "exclusive",
        "inclusive",
        "unspecified"
      ],
      "type": "string",
      "nullable": true,
      "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`."
    },
    "delivery_estimate": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/shipping_rate_delivery_estimate"
        }
      ],
      "nullable": true,
      "description": "The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions."
    }
  },
  "description": "Shipping rates describe the price of shipping presented to your customers and\napplied to a purchase. For more information, see [Charge for shipping](https://docs.stripe.com/payments/during-payment/charge-shipping).",
  "x-resourceId": "shipping_rate",
  "x-expandableFields": [
    "delivery_estimate",
    "fixed_amount",
    "tax_code"
  ]
}

object shipping_rate_currency_option

{
  "type": "object",
  "title": "ShippingRateCurrencyOption",
  "required": [
    "amount",
    "tax_behavior"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "A non-negative integer in cents representing how much to charge."
    },
    "tax_behavior": {
      "enum": [
        "exclusive",
        "inclusive",
        "unspecified"
      ],
      "type": "string",
      "description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object shipping_rate_delivery_estimate

{
  "type": "object",
  "title": "ShippingRateDeliveryEstimate",
  "properties": {
    "maximum": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/shipping_rate_delivery_estimate_bound"
        }
      ],
      "nullable": true,
      "description": "The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite."
    },
    "minimum": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/shipping_rate_delivery_estimate_bound"
        }
      ],
      "nullable": true,
      "description": "The lower bound of the estimated range. If empty, represents no lower bound."
    }
  },
  "description": "",
  "x-expandableFields": [
    "maximum",
    "minimum"
  ]
}

object shipping_rate_delivery_estimate_bound

{
  "type": "object",
  "title": "ShippingRateDeliveryEstimateBound",
  "required": [
    "unit",
    "value"
  ],
  "properties": {
    "unit": {
      "enum": [
        "business_day",
        "day",
        "hour",
        "month",
        "week"
      ],
      "type": "string",
      "description": "A unit of time."
    },
    "value": {
      "type": "integer",
      "description": "Must be greater than 0."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object shipping_rate_fixed_amount

{
  "type": "object",
  "title": "ShippingRateFixedAmount",
  "required": [
    "amount",
    "currency"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "A non-negative integer in cents representing how much to charge."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "currency_options": {
      "type": "object",
      "description": "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).",
      "additionalProperties": {
        "$ref": "#/components/schemas/shipping_rate_currency_option"
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "currency_options"
  ]
}

object sigma.sigma_api_query

{
  "type": "object",
  "title": "SigmaSigmaResourcesSigmaAPIQuery",
  "required": [
    "created",
    "id",
    "livemode",
    "name",
    "object",
    "sql"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "sql": {
      "type": "string",
      "maxLength": 5000,
      "description": "The sql statement for the query."
    },
    "name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The name of the query."
    },
    "object": {
      "enum": [
        "sigma.sigma_api_query"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    }
  },
  "description": "A saved query object represents a query that can be executed for a run.",
  "x-resourceId": "sigma.sigma_api_query",
  "x-expandableFields": []
}

object sigma_scheduled_query_run_error

{
  "type": "object",
  "title": "SigmaScheduledQueryRunError",
  "required": [
    "message"
  ],
  "properties": {
    "message": {
      "type": "string",
      "maxLength": 5000,
      "description": "Information about the run failure."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object source

{
  "type": "object",
  "title": "Source",
  "required": [
    "client_secret",
    "created",
    "flow",
    "id",
    "livemode",
    "object",
    "status",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "eps": {
      "$ref": "#/components/schemas/source_type_eps"
    },
    "p24": {
      "$ref": "#/components/schemas/source_type_p24"
    },
    "card": {
      "$ref": "#/components/schemas/source_type_card"
    },
    "flow": {
      "type": "string",
      "maxLength": 5000,
      "description": "The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`."
    },
    "type": {
      "enum": [
        "ach_credit_transfer",
        "ach_debit",
        "acss_debit",
        "alipay",
        "au_becs_debit",
        "bancontact",
        "card",
        "card_present",
        "eps",
        "giropay",
        "ideal",
        "klarna",
        "multibanco",
        "p24",
        "sepa_debit",
        "sofort",
        "three_d_secure",
        "wechat"
      ],
      "type": "string",
      "description": "The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://docs.stripe.com/sources) used.",
      "x-stripeBypassValidation": true
    },
    "ideal": {
      "$ref": "#/components/schemas/source_type_ideal"
    },
    "owner": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/source_owner"
        }
      ],
      "nullable": true,
      "description": "Information about the owner of the payment instrument that may be used or required by particular source types."
    },
    "usage": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned."
    },
    "alipay": {
      "$ref": "#/components/schemas/source_type_alipay"
    },
    "amount": {
      "type": "integer",
      "nullable": true,
      "description": "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources."
    },
    "klarna": {
      "$ref": "#/components/schemas/source_type_klarna"
    },
    "object": {
      "enum": [
        "source"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "sofort": {
      "$ref": "#/components/schemas/source_type_sofort"
    },
    "status": {
      "type": "string",
      "maxLength": 5000,
      "description": "The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge."
    },
    "wechat": {
      "$ref": "#/components/schemas/source_type_wechat"
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "giropay": {
      "$ref": "#/components/schemas/source_type_giropay"
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "nullable": true,
      "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources."
    },
    "customer": {
      "type": "string",
      "maxLength": 5000,
      "description": "The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "receiver": {
      "$ref": "#/components/schemas/source_receiver_flow"
    },
    "redirect": {
      "$ref": "#/components/schemas/source_redirect_flow"
    },
    "ach_debit": {
      "$ref": "#/components/schemas/source_type_ach_debit"
    },
    "acss_debit": {
      "$ref": "#/components/schemas/source_type_acss_debit"
    },
    "bancontact": {
      "$ref": "#/components/schemas/source_type_bancontact"
    },
    "multibanco": {
      "$ref": "#/components/schemas/source_type_multibanco"
    },
    "sepa_debit": {
      "$ref": "#/components/schemas/source_type_sepa_debit"
    },
    "card_present": {
      "$ref": "#/components/schemas/source_type_card_present"
    },
    "source_order": {
      "$ref": "#/components/schemas/source_order"
    },
    "au_becs_debit": {
      "$ref": "#/components/schemas/source_type_au_becs_debit"
    },
    "client_secret": {
      "type": "string",
      "maxLength": 5000,
      "description": "The client secret of the source. Used for client-side retrieval using a publishable key."
    },
    "three_d_secure": {
      "$ref": "#/components/schemas/source_type_three_d_secure"
    },
    "allow_redisplay": {
      "enum": [
        "always",
        "limited",
        "unspecified"
      ],
      "type": "string",
      "nullable": true,
      "description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”."
    },
    "code_verification": {
      "$ref": "#/components/schemas/source_code_verification_flow"
    },
    "ach_credit_transfer": {
      "$ref": "#/components/schemas/source_type_ach_credit_transfer"
    },
    "statement_descriptor": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Extra information about a source. This will appear on your customer's statement every time you charge the source."
    }
  },
  "description": "`Source` objects allow you to accept a variety of payment methods. They\nrepresent a customer's payment instrument, and can be used with the Stripe API\njust like a `Card` object: once chargeable, they can be charged, or can be\nattached to customers.\n\nStripe doesn't recommend using the deprecated [Sources API](https://docs.stripe.com/api/sources).\nWe recommend that you adopt the [PaymentMethods API](https://docs.stripe.com/api/payment_methods).\nThis newer API provides access to our latest features and payment method types.\n\nRelated guides: [Sources API](https://docs.stripe.com/sources) and [Sources & Customers](https://docs.stripe.com/sources/customers).",
  "x-resourceId": "source",
  "x-expandableFields": [
    "code_verification",
    "owner",
    "receiver",
    "redirect",
    "source_order"
  ]
}

object source_code_verification_flow

{
  "type": "object",
  "title": "SourceCodeVerificationFlow",
  "required": [
    "attempts_remaining",
    "status"
  ],
  "properties": {
    "status": {
      "type": "string",
      "maxLength": 5000,
      "description": "The status of the code verification, either `pending` (awaiting verification, `attempts_remaining` should be greater than 0), `succeeded` (successful verification) or `failed` (failed verification, cannot be verified anymore as `attempts_remaining` should be 0)."
    },
    "attempts_remaining": {
      "type": "integer",
      "description": "The number of attempts remaining to authenticate the source object with a verification code."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object source_mandate_notification

{
  "type": "object",
  "title": "SourceMandateNotification",
  "required": [
    "created",
    "id",
    "livemode",
    "object",
    "reason",
    "source",
    "status",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "type": {
      "type": "string",
      "maxLength": 5000,
      "description": "The type of source this mandate notification is attached to. Should be the source type identifier code for the payment method, such as `three_d_secure`."
    },
    "amount": {
      "type": "integer",
      "nullable": true,
      "description": "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount associated with the mandate notification. The amount is expressed in the currency of the underlying source. Required if the notification type is `debit_initiated`."
    },
    "object": {
      "enum": [
        "source_mandate_notification"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "reason": {
      "type": "string",
      "maxLength": 5000,
      "description": "The reason of the mandate notification. Valid reasons are `mandate_confirmed` or `debit_initiated`."
    },
    "source": {
      "$ref": "#/components/schemas/source"
    },
    "status": {
      "type": "string",
      "maxLength": 5000,
      "description": "The status of the mandate notification. Valid statuses are `pending` or `submitted`."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "acss_debit": {
      "$ref": "#/components/schemas/source_mandate_notification_acss_debit_data"
    },
    "bacs_debit": {
      "$ref": "#/components/schemas/source_mandate_notification_bacs_debit_data"
    },
    "sepa_debit": {
      "$ref": "#/components/schemas/source_mandate_notification_sepa_debit_data"
    }
  },
  "description": "Source mandate notifications should be created when a notification related to\na source mandate must be sent to the payer. They will trigger a webhook or\ndeliver an email to the customer.",
  "x-resourceId": "source_mandate_notification",
  "x-expandableFields": [
    "acss_debit",
    "bacs_debit",
    "sepa_debit",
    "source"
  ]
}

object source_mandate_notification_acss_debit_data

{
  "type": "object",
  "title": "SourceMandateNotificationAcssDebitData",
  "properties": {
    "statement_descriptor": {
      "type": "string",
      "maxLength": 5000,
      "description": "The statement descriptor associate with the debit."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object source_mandate_notification_bacs_debit_data

{
  "type": "object",
  "title": "SourceMandateNotificationBacsDebitData",
  "properties": {
    "last4": {
      "type": "string",
      "maxLength": 5000,
      "description": "Last 4 digits of the account number associated with the debit."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object source_mandate_notification_sepa_debit_data

{
  "type": "object",
  "title": "SourceMandateNotificationSepaDebitData",
  "properties": {
    "last4": {
      "type": "string",
      "maxLength": 5000,
      "description": "Last 4 digits of the account number associated with the debit."
    },
    "mandate_reference": {
      "type": "string",
      "maxLength": 5000,
      "description": "Mandate reference associated with the debit."
    },
    "creditor_identifier": {
      "type": "string",
      "maxLength": 5000,
      "description": "SEPA creditor ID."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object source_order

{
  "type": "object",
  "title": "SourceOrder",
  "required": [
    "amount",
    "currency"
  ],
  "properties": {
    "email": {
      "type": "string",
      "maxLength": 5000,
      "description": "The email address of the customer placing the order."
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/source_order_item"
      },
      "nullable": true,
      "description": "List of items constituting the order."
    },
    "amount": {
      "type": "integer",
      "description": "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "shipping": {
      "$ref": "#/components/schemas/shipping"
    }
  },
  "description": "",
  "x-expandableFields": [
    "items",
    "shipping"
  ]
}

object source_order_item

{
  "type": "object",
  "title": "SourceOrderItem",
  "properties": {
    "type": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The type of this order item. Must be `sku`, `tax`, or `shipping`."
    },
    "amount": {
      "type": "integer",
      "nullable": true,
      "description": "The amount (price) for this order item."
    },
    "parent": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU)."
    },
    "currency": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "This currency of this order item. Required when `amount` is present."
    },
    "quantity": {
      "type": "integer",
      "description": "The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Human-readable description for this order item."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object source_owner

{
  "type": "object",
  "title": "SourceOwner",
  "properties": {
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Owner's full name."
    },
    "email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Owner's email address."
    },
    "phone": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Owner's phone number (including extension)."
    },
    "address": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/address"
        }
      ],
      "nullable": true,
      "description": "Owner's address."
    },
    "verified_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated."
    },
    "verified_email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated."
    },
    "verified_phone": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated."
    },
    "verified_address": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/address"
        }
      ],
      "nullable": true,
      "description": "Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated."
    }
  },
  "description": "",
  "x-expandableFields": [
    "address",
    "verified_address"
  ]
}

object source_receiver_flow

{
  "type": "object",
  "title": "SourceReceiverFlow",
  "required": [
    "amount_charged",
    "amount_received",
    "amount_returned",
    "refund_attributes_method",
    "refund_attributes_status"
  ],
  "properties": {
    "address": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The address of the receiver source. This is the value that should be communicated to the customer to send their funds to."
    },
    "amount_charged": {
      "type": "integer",
      "description": "The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency."
    },
    "amount_received": {
      "type": "integer",
      "description": "The total amount received by the receiver source. `amount_received = amount_returned + amount_charged` should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency."
    },
    "amount_returned": {
      "type": "integer",
      "description": "The total amount that was returned to the customer. The amount returned is expressed in the source's currency."
    },
    "refund_attributes_method": {
      "type": "string",
      "maxLength": 5000,
      "description": "Type of refund attribute method, one of `email`, `manual`, or `none`."
    },
    "refund_attributes_status": {
      "type": "string",
      "maxLength": 5000,
      "description": "Type of refund attribute status, one of `missing`, `requested`, or `available`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object source_redirect_flow

{
  "type": "object",
  "title": "SourceRedirectFlow",
  "required": [
    "return_url",
    "status",
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 2048,
      "description": "The URL provided to you to redirect a customer to as part of a `redirect` authentication flow."
    },
    "status": {
      "type": "string",
      "maxLength": 5000,
      "description": "The status of the redirect, either `pending` (ready to be used by your customer to authenticate the transaction), `succeeded` (successful authentication, cannot be reused) or `not_required` (redirect should not be used) or `failed` (failed authentication, cannot be reused)."
    },
    "return_url": {
      "type": "string",
      "maxLength": 5000,
      "description": "The URL you provide to redirect the customer to after they authenticated their payment."
    },
    "failure_reason": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The failure reason for the redirect, either `user_abort` (the customer aborted or dropped out of the redirect flow), `declined` (the authentication failed or the transaction was declined), or `processing_error` (the redirect failed due to a technical error). Present only if the redirect status is `failed`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object source_transaction

{
  "type": "object",
  "title": "SourceTransaction",
  "required": [
    "amount",
    "created",
    "currency",
    "id",
    "livemode",
    "object",
    "source",
    "status",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "type": {
      "enum": [
        "ach_credit_transfer",
        "ach_debit",
        "alipay",
        "bancontact",
        "card",
        "card_present",
        "eps",
        "giropay",
        "ideal",
        "klarna",
        "multibanco",
        "p24",
        "sepa_debit",
        "sofort",
        "three_d_secure",
        "wechat"
      ],
      "type": "string",
      "description": "The type of source this transaction is attached to."
    },
    "amount": {
      "type": "integer",
      "description": "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount your customer has pushed to the receiver."
    },
    "object": {
      "enum": [
        "source_transaction"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "source": {
      "type": "string",
      "maxLength": 5000,
      "description": "The ID of the source this transaction is attached to."
    },
    "status": {
      "type": "string",
      "maxLength": 5000,
      "description": "The status of the transaction, one of `succeeded`, `pending`, or `failed`."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "paper_check": {
      "$ref": "#/components/schemas/source_transaction_paper_check_data"
    },
    "ach_credit_transfer": {
      "$ref": "#/components/schemas/source_transaction_ach_credit_transfer_data"
    },
    "chf_credit_transfer": {
      "$ref": "#/components/schemas/source_transaction_chf_credit_transfer_data"
    },
    "gbp_credit_transfer": {
      "$ref": "#/components/schemas/source_transaction_gbp_credit_transfer_data"
    },
    "sepa_credit_transfer": {
      "$ref": "#/components/schemas/source_transaction_sepa_credit_transfer_data"
    }
  },
  "description": "Some payment methods have no required amount that a customer must send.\nCustomers can be instructed to send any amount, and it can be made up of\nmultiple transactions. As such, sources can have multiple associated\ntransactions.",
  "x-resourceId": "source_transaction",
  "x-expandableFields": [
    "ach_credit_transfer",
    "chf_credit_transfer",
    "gbp_credit_transfer",
    "paper_check",
    "sepa_credit_transfer"
  ]
}

object source_transaction_ach_credit_transfer_data

{
  "type": "object",
  "title": "SourceTransactionAchCreditTransferData",
  "properties": {
    "last4": {
      "type": "string",
      "maxLength": 5000,
      "description": "Last 4 digits of the account number associated with the transfer."
    },
    "fingerprint": {
      "type": "string",
      "maxLength": 5000,
      "description": "Bank account fingerprint associated with the transfer."
    },
    "customer_data": {
      "type": "string",
      "maxLength": 5000,
      "description": "Customer data associated with the transfer."
    },
    "routing_number": {
      "type": "string",
      "maxLength": 5000,
      "description": "Routing number associated with the transfer."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object source_transaction_chf_credit_transfer_data

{
  "type": "object",
  "title": "SourceTransactionChfCreditTransferData",
  "properties": {
    "reference": {
      "type": "string",
      "maxLength": 5000,
      "description": "Reference associated with the transfer."
    },
    "sender_iban": {
      "type": "string",
      "maxLength": 5000,
      "description": "Sender's bank account IBAN."
    },
    "sender_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "Sender's name."
    },
    "sender_address_line1": {
      "type": "string",
      "maxLength": 5000,
      "description": "Sender's line 1 address."
    },
    "sender_address_country": {
      "type": "string",
      "maxLength": 5000,
      "description": "Sender's country address."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object source_transaction_gbp_credit_transfer_data

{
  "type": "object",
  "title": "SourceTransactionGbpCreditTransferData",
  "properties": {
    "last4": {
      "type": "string",
      "maxLength": 5000,
      "description": "Last 4 digits of sender account number associated with the transfer."
    },
    "reference": {
      "type": "string",
      "maxLength": 5000,
      "description": "Sender entered arbitrary information about the transfer."
    },
    "fingerprint": {
      "type": "string",
      "maxLength": 5000,
      "description": "Bank account fingerprint associated with the Stripe owned bank account receiving the transfer."
    },
    "sender_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "Sender name associated with the transfer."
    },
    "funding_method": {
      "type": "string",
      "maxLength": 5000,
      "description": "The credit transfer rails the sender used to push this transfer. The possible rails are: Faster Payments, BACS, CHAPS, and wire transfers. Currently only Faster Payments is supported."
    },
    "sender_sort_code": {
      "type": "string",
      "maxLength": 5000,
      "description": "Sender sort code associated with the transfer."
    },
    "sender_account_number": {
      "type": "string",
      "maxLength": 5000,
      "description": "Sender account number associated with the transfer."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object source_transaction_paper_check_data

{
  "type": "object",
  "title": "SourceTransactionPaperCheckData",
  "properties": {
    "invoices": {
      "type": "string",
      "maxLength": 5000,
      "description": "Comma-separated list of invoice IDs associated with the paper check."
    },
    "available_at": {
      "type": "string",
      "maxLength": 5000,
      "description": "Time at which the deposited funds will be available for use. Measured in seconds since the Unix epoch."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object source_transaction_sepa_credit_transfer_data

{
  "type": "object",
  "title": "SourceTransactionSepaCreditTransferData",
  "properties": {
    "reference": {
      "type": "string",
      "maxLength": 5000,
      "description": "Reference associated with the transfer."
    },
    "sender_iban": {
      "type": "string",
      "maxLength": 5000,
      "description": "Sender's bank account IBAN."
    },
    "sender_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "Sender's name."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object source_type_ach_credit_transfer

{
  "type": "object",
  "properties": {
    "bank_name": {
      "type": "string",
      "nullable": true
    },
    "swift_code": {
      "type": "string",
      "nullable": true
    },
    "fingerprint": {
      "type": "string",
      "nullable": true
    },
    "account_number": {
      "type": "string",
      "nullable": true
    },
    "routing_number": {
      "type": "string",
      "nullable": true
    },
    "refund_routing_number": {
      "type": "string",
      "nullable": true
    },
    "refund_account_holder_name": {
      "type": "string",
      "nullable": true
    },
    "refund_account_holder_type": {
      "type": "string",
      "nullable": true
    }
  }
}

object source_type_ach_debit

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "nullable": true
    },
    "last4": {
      "type": "string",
      "nullable": true
    },
    "country": {
      "type": "string",
      "nullable": true
    },
    "bank_name": {
      "type": "string",
      "nullable": true
    },
    "fingerprint": {
      "type": "string",
      "nullable": true
    },
    "routing_number": {
      "type": "string",
      "nullable": true
    }
  }
}

object source_type_acss_debit

{
  "type": "object",
  "properties": {
    "last4": {
      "type": "string",
      "nullable": true
    },
    "country": {
      "type": "string",
      "nullable": true
    },
    "category": {
      "type": "string",
      "nullable": true
    },
    "bank_name": {
      "type": "string",
      "nullable": true
    },
    "fingerprint": {
      "type": "string",
      "nullable": true
    },
    "routing_number": {
      "type": "string",
      "nullable": true
    },
    "bank_address_city": {
      "type": "string",
      "nullable": true
    },
    "bank_address_line_1": {
      "type": "string",
      "nullable": true
    },
    "bank_address_line_2": {
      "type": "string",
      "nullable": true
    },
    "bank_address_postal_code": {
      "type": "string",
      "nullable": true
    }
  }
}

object source_type_alipay

{
  "type": "object",
  "properties": {
    "native_url": {
      "type": "string",
      "nullable": true
    },
    "data_string": {
      "type": "string",
      "nullable": true
    },
    "statement_descriptor": {
      "type": "string",
      "nullable": true
    }
  }
}

object source_type_au_becs_debit

{
  "type": "object",
  "properties": {
    "last4": {
      "type": "string",
      "nullable": true
    },
    "bsb_number": {
      "type": "string",
      "nullable": true
    },
    "fingerprint": {
      "type": "string",
      "nullable": true
    }
  }
}

object source_type_bancontact

{
  "type": "object",
  "properties": {
    "bic": {
      "type": "string",
      "nullable": true
    },
    "bank_code": {
      "type": "string",
      "nullable": true
    },
    "bank_name": {
      "type": "string",
      "nullable": true
    },
    "iban_last4": {
      "type": "string",
      "nullable": true
    },
    "preferred_language": {
      "type": "string",
      "nullable": true
    },
    "statement_descriptor": {
      "type": "string",
      "nullable": true
    }
  }
}

object source_type_card

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "nullable": true
    },
    "brand": {
      "type": "string",
      "nullable": true
    },
    "last4": {
      "type": "string",
      "nullable": true
    },
    "country": {
      "type": "string",
      "nullable": true
    },
    "funding": {
      "type": "string",
      "nullable": true
    },
    "exp_year": {
      "type": "integer",
      "nullable": true
    },
    "cvc_check": {
      "type": "string",
      "nullable": true
    },
    "exp_month": {
      "type": "integer",
      "nullable": true
    },
    "fingerprint": {
      "type": "string"
    },
    "dynamic_last4": {
      "type": "string",
      "nullable": true
    },
    "three_d_secure": {
      "type": "string"
    },
    "address_zip_check": {
      "type": "string",
      "nullable": true
    },
    "address_line1_check": {
      "type": "string",
      "nullable": true
    },
    "tokenization_method": {
      "type": "string",
      "nullable": true
    }
  }
}

object source_type_card_present

{
  "type": "object",
  "properties": {
    "brand": {
      "type": "string",
      "nullable": true
    },
    "last4": {
      "type": "string",
      "nullable": true
    },
    "reader": {
      "type": "string",
      "nullable": true
    },
    "country": {
      "type": "string",
      "nullable": true
    },
    "funding": {
      "type": "string",
      "nullable": true
    },
    "cvm_type": {
      "type": "string"
    },
    "exp_year": {
      "type": "integer",
      "nullable": true
    },
    "data_type": {
      "type": "string",
      "nullable": true
    },
    "exp_month": {
      "type": "integer",
      "nullable": true
    },
    "fingerprint": {
      "type": "string"
    },
    "read_method": {
      "type": "string",
      "nullable": true
    },
    "emv_auth_data": {
      "type": "string"
    },
    "pos_device_id": {
      "type": "string",
      "nullable": true
    },
    "pos_entry_mode": {
      "type": "string"
    },
    "authorization_code": {
      "type": "string",
      "nullable": true
    },
    "dedicated_file_name": {
      "type": "string"
    },
    "application_cryptogram": {
      "type": "string"
    },
    "application_preferred_name": {
      "type": "string"
    },
    "authorization_response_code": {
      "type": "string"
    },
    "evidence_customer_signature": {
      "type": "string",
      "nullable": true
    },
    "terminal_verification_results": {
      "type": "string"
    },
    "transaction_status_information": {
      "type": "string"
    },
    "evidence_transaction_certificate": {
      "type": "string",
      "nullable": true
    }
  }
}

object source_type_eps

{
  "type": "object",
  "properties": {
    "reference": {
      "type": "string",
      "nullable": true
    },
    "statement_descriptor": {
      "type": "string",
      "nullable": true
    }
  }
}

object source_type_giropay

{
  "type": "object",
  "properties": {
    "bic": {
      "type": "string",
      "nullable": true
    },
    "bank_code": {
      "type": "string",
      "nullable": true
    },
    "bank_name": {
      "type": "string",
      "nullable": true
    },
    "statement_descriptor": {
      "type": "string",
      "nullable": true
    }
  }
}

object source_type_ideal

{
  "type": "object",
  "properties": {
    "bic": {
      "type": "string",
      "nullable": true
    },
    "bank": {
      "type": "string",
      "nullable": true
    },
    "iban_last4": {
      "type": "string",
      "nullable": true
    },
    "statement_descriptor": {
      "type": "string",
      "nullable": true
    }
  }
}

object source_type_klarna

{
  "type": "object",
  "properties": {
    "locale": {
      "type": "string"
    },
    "logo_url": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "first_name": {
      "type": "string"
    },
    "page_title": {
      "type": "string"
    },
    "client_token": {
      "type": "string",
      "nullable": true
    },
    "pay_now_name": {
      "type": "string"
    },
    "redirect_url": {
      "type": "string"
    },
    "purchase_type": {
      "type": "string"
    },
    "pay_later_name": {
      "type": "string"
    },
    "shipping_delay": {
      "type": "integer"
    },
    "purchase_country": {
      "type": "string"
    },
    "pay_over_time_name": {
      "type": "string"
    },
    "shipping_last_name": {
      "type": "string"
    },
    "shipping_first_name": {
      "type": "string"
    },
    "background_image_url": {
      "type": "string"
    },
    "pay_now_redirect_url": {
      "type": "string"
    },
    "pay_later_redirect_url": {
      "type": "string"
    },
    "payment_method_categories": {
      "type": "string"
    },
    "pay_over_time_redirect_url": {
      "type": "string"
    },
    "pay_now_asset_urls_standard": {
      "type": "string"
    },
    "pay_later_asset_urls_standard": {
      "type": "string"
    },
    "pay_now_asset_urls_descriptive": {
      "type": "string"
    },
    "pay_later_asset_urls_descriptive": {
      "type": "string"
    },
    "pay_over_time_asset_urls_standard": {
      "type": "string"
    },
    "pay_over_time_asset_urls_descriptive": {
      "type": "string"
    }
  }
}

object source_type_multibanco

{
  "type": "object",
  "properties": {
    "entity": {
      "type": "string",
      "nullable": true
    },
    "reference": {
      "type": "string",
      "nullable": true
    },
    "refund_iban": {
      "type": "string",
      "nullable": true
    },
    "refund_account_holder_name": {
      "type": "string",
      "nullable": true
    },
    "refund_account_holder_address_city": {
      "type": "string",
      "nullable": true
    },
    "refund_account_holder_address_line1": {
      "type": "string",
      "nullable": true
    },
    "refund_account_holder_address_line2": {
      "type": "string",
      "nullable": true
    },
    "refund_account_holder_address_state": {
      "type": "string",
      "nullable": true
    },
    "refund_account_holder_address_country": {
      "type": "string",
      "nullable": true
    },
    "refund_account_holder_address_postal_code": {
      "type": "string",
      "nullable": true
    }
  }
}

object source_type_p24

{
  "type": "object",
  "properties": {
    "reference": {
      "type": "string",
      "nullable": true
    }
  }
}

object source_type_sepa_debit

{
  "type": "object",
  "properties": {
    "last4": {
      "type": "string",
      "nullable": true
    },
    "country": {
      "type": "string",
      "nullable": true
    },
    "bank_code": {
      "type": "string",
      "nullable": true
    },
    "branch_code": {
      "type": "string",
      "nullable": true
    },
    "fingerprint": {
      "type": "string",
      "nullable": true
    },
    "mandate_url": {
      "type": "string",
      "nullable": true
    },
    "mandate_reference": {
      "type": "string",
      "nullable": true
    }
  }
}

object source_type_sofort

{
  "type": "object",
  "properties": {
    "bic": {
      "type": "string",
      "nullable": true
    },
    "country": {
      "type": "string",
      "nullable": true
    },
    "bank_code": {
      "type": "string",
      "nullable": true
    },
    "bank_name": {
      "type": "string",
      "nullable": true
    },
    "iban_last4": {
      "type": "string",
      "nullable": true
    },
    "preferred_language": {
      "type": "string",
      "nullable": true
    },
    "statement_descriptor": {
      "type": "string",
      "nullable": true
    }
  }
}

object source_type_three_d_secure

{
  "type": "object",
  "properties": {
    "card": {
      "type": "string",
      "nullable": true
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "brand": {
      "type": "string",
      "nullable": true
    },
    "last4": {
      "type": "string",
      "nullable": true
    },
    "country": {
      "type": "string",
      "nullable": true
    },
    "funding": {
      "type": "string",
      "nullable": true
    },
    "customer": {
      "type": "string",
      "nullable": true
    },
    "exp_year": {
      "type": "integer",
      "nullable": true
    },
    "cvc_check": {
      "type": "string",
      "nullable": true
    },
    "exp_month": {
      "type": "integer",
      "nullable": true
    },
    "fingerprint": {
      "type": "string"
    },
    "authenticated": {
      "type": "boolean",
      "nullable": true
    },
    "dynamic_last4": {
      "type": "string",
      "nullable": true
    },
    "three_d_secure": {
      "type": "string"
    },
    "address_zip_check": {
      "type": "string",
      "nullable": true
    },
    "address_line1_check": {
      "type": "string",
      "nullable": true
    },
    "tokenization_method": {
      "type": "string",
      "nullable": true
    }
  }
}

object source_type_wechat

{
  "type": "object",
  "properties": {
    "prepay_id": {
      "type": "string"
    },
    "qr_code_url": {
      "type": "string",
      "nullable": true
    },
    "statement_descriptor": {
      "type": "string"
    }
  }
}

object stackable_discount_with_discount_settings

{
  "type": "object",
  "title": "StackableDiscountWithDiscountSettings",
  "properties": {
    "coupon": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/coupon"
        }
      ],
      "nullable": true,
      "description": "ID of the coupon to create a new discount for.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/coupon"
          }
        ]
      }
    },
    "discount": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/discount"
        }
      ],
      "nullable": true,
      "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/discount"
          }
        ]
      }
    },
    "promotion_code": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/promotion_code"
        }
      ],
      "nullable": true,
      "description": "ID of the promotion code to create a new discount for.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/promotion_code"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "coupon",
    "discount",
    "promotion_code"
  ]
}

object stackable_discount_with_discount_settings_and_discount_end

{
  "type": "object",
  "title": "StackableDiscountWithDiscountSettingsAndDiscountEnd",
  "properties": {
    "coupon": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/coupon"
        }
      ],
      "nullable": true,
      "description": "ID of the coupon to create a new discount for.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/coupon"
          }
        ]
      }
    },
    "discount": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/discount"
        }
      ],
      "nullable": true,
      "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/discount"
          }
        ]
      }
    },
    "promotion_code": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/promotion_code"
        }
      ],
      "nullable": true,
      "description": "ID of the promotion code to create a new discount for.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/promotion_code"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "coupon",
    "discount",
    "promotion_code"
  ]
}

object subscription

{
  "type": "object",
  "title": "Subscription",
  "required": [
    "automatic_tax",
    "billing_cycle_anchor",
    "billing_mode",
    "cancel_at_period_end",
    "collection_method",
    "created",
    "currency",
    "customer",
    "discounts",
    "id",
    "invoice_settings",
    "items",
    "livemode",
    "metadata",
    "object",
    "start_date",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "items": {
      "type": "object",
      "title": "SubscriptionItemList",
      "required": [
        "data",
        "has_more",
        "object",
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "maxLength": 5000,
          "description": "The URL where this list can be accessed."
        },
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/subscription_item"
          },
          "description": "Details about each object."
        },
        "object": {
          "enum": [
            "list"
          ],
          "type": "string",
          "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
        },
        "has_more": {
          "type": "boolean",
          "description": "True if this list has another page of items after this one that can be fetched."
        }
      },
      "description": "List of subscription items, each with an attached price.",
      "x-expandableFields": [
        "data"
      ]
    },
    "object": {
      "enum": [
        "subscription"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "active",
        "canceled",
        "incomplete",
        "incomplete_expired",
        "past_due",
        "paused",
        "trialing",
        "unpaid"
      ],
      "type": "string",
      "description": "Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, `unpaid`, or `paused`. \n\nFor `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` status. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal status, the open invoice will be voided and no further invoices will be generated. \n\nA subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over. \n\nA subscription can only enter a `paused` status [when a trial ends without a payment method](https://docs.stripe.com/billing/subscriptions/trials#create-free-trials-without-payment). A `paused` subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The `paused` status is different from [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment), which still generates invoices and leaves the subscription's status unchanged. \n\nIf subscription `collection_method=charge_automatically`, it becomes `past_due` when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become `canceled` or `unpaid` (depending on your subscriptions settings). \n\nIf subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        },
        {
          "$ref": "#/components/schemas/deleted_customer"
        }
      ],
      "description": "ID of the customer who owns the subscription.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          },
          {
            "$ref": "#/components/schemas/deleted_customer"
          }
        ]
      }
    },
    "ended_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "If the subscription has ended, the date the subscription ended."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "schedule": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/subscription_schedule"
        }
      ],
      "nullable": true,
      "description": "The schedule attached to the subscription",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/subscription_schedule"
          }
        ]
      }
    },
    "cancel_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "A date in the future at which the subscription will automatically get canceled"
    },
    "discounts": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 5000
          },
          {
            "$ref": "#/components/schemas/discount"
          }
        ],
        "x-expansionResources": {
          "oneOf": [
            {
              "$ref": "#/components/schemas/discount"
            }
          ]
        }
      },
      "description": "The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount."
    },
    "trial_end": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "If the subscription has a trial, the end of that trial."
    },
    "start_date": {
      "type": "integer",
      "format": "unix-time",
      "description": "Date when the subscription was first created. The date might differ from the `created` date due to backdating."
    },
    "test_clock": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/test_helpers.test_clock"
        }
      ],
      "nullable": true,
      "description": "ID of the test clock this subscription belongs to.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/test_helpers.test_clock"
          }
        ]
      }
    },
    "application": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/application"
        },
        {
          "$ref": "#/components/schemas/deleted_application"
        }
      ],
      "nullable": true,
      "description": "ID of the Connect Application that created the subscription.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/application"
          },
          {
            "$ref": "#/components/schemas/deleted_application"
          }
        ]
      }
    },
    "canceled_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 500,
      "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs."
    },
    "trial_start": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "If the subscription has a trial, the beginning of that trial."
    },
    "billing_mode": {
      "$ref": "#/components/schemas/subscriptions_resource_billing_mode"
    },
    "on_behalf_of": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/account"
        }
      ],
      "nullable": true,
      "description": "The account (if any) the charge was made on behalf of for charges associated with this subscription. See the [Connect documentation](https://docs.stripe.com/connect/subscriptions#on-behalf-of) for details.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/account"
          }
        ]
      }
    },
    "automatic_tax": {
      "$ref": "#/components/schemas/subscription_automatic_tax"
    },
    "transfer_data": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/subscription_transfer_data"
        }
      ],
      "nullable": true,
      "description": "The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices."
    },
    "days_until_due": {
      "type": "integer",
      "nullable": true,
      "description": "Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`."
    },
    "default_source": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/bank_account"
        },
        {
          "$ref": "#/components/schemas/card"
        },
        {
          "$ref": "#/components/schemas/source"
        }
      ],
      "nullable": true,
      "description": "ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/bank_account"
          },
          {
            "$ref": "#/components/schemas/card"
          },
          {
            "$ref": "#/components/schemas/source"
          }
        ]
      },
      "x-stripeBypassValidation": true
    },
    "latest_invoice": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/invoice"
        }
      ],
      "nullable": true,
      "description": "The most recent invoice this subscription has generated over its lifecycle (for example, when it cycles or is updated).",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/invoice"
          }
        ]
      }
    },
    "pending_update": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/subscriptions_resource_pending_update"
        }
      ],
      "nullable": true,
      "description": "If specified, [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid."
    },
    "trial_settings": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/subscriptions_resource_trial_settings_trial_settings"
        }
      ],
      "nullable": true,
      "description": "Settings related to subscription trials."
    },
    "customer_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the account representing the customer who owns the subscription."
    },
    "invoice_settings": {
      "$ref": "#/components/schemas/subscriptions_resource_subscription_invoice_settings"
    },
    "pause_collection": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/subscriptions_resource_pause_collection"
        }
      ],
      "nullable": true,
      "description": "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment)."
    },
    "payment_settings": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/subscriptions_resource_payment_settings"
        }
      ],
      "nullable": true,
      "description": "Payment settings passed on to invoices created by the subscription."
    },
    "collection_method": {
      "enum": [
        "charge_automatically",
        "send_invoice"
      ],
      "type": "string",
      "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`."
    },
    "default_tax_rates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/tax_rate"
      },
      "nullable": true,
      "description": "The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription."
    },
    "billing_thresholds": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/subscription_billing_thresholds"
        }
      ],
      "nullable": true,
      "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period"
    },
    "presentment_details": {
      "$ref": "#/components/schemas/subscriptions_resource_subscription_presentment_details"
    },
    "billing_cycle_anchor": {
      "type": "integer",
      "format": "unix-time",
      "description": "The reference point that aligns future [billing cycle](https://docs.stripe.com/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format."
    },
    "cancel_at_period_end": {
      "type": "boolean",
      "description": "Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period."
    },
    "cancellation_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/cancellation_details"
        }
      ],
      "nullable": true,
      "description": "Details about why this subscription was cancelled"
    },
    "pending_setup_intent": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/setup_intent"
        }
      ],
      "nullable": true,
      "description": "You can use this [SetupIntent](https://docs.stripe.com/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication#scenario-2).",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/setup_intent"
          }
        ]
      }
    },
    "default_payment_method": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_method"
        }
      ],
      "nullable": true,
      "description": "ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_method"
          }
        ]
      }
    },
    "application_fee_percent": {
      "type": "number",
      "nullable": true,
      "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account."
    },
    "billing_cycle_anchor_config": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/subscriptions_resource_billing_cycle_anchor_config"
        }
      ],
      "nullable": true,
      "description": "The fixed values used to calculate the `billing_cycle_anchor`."
    },
    "pending_invoice_item_interval": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/subscription_pending_invoice_item_interval"
        }
      ],
      "nullable": true,
      "description": "Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](/api/invoices/create) for the given subscription at the specified interval."
    },
    "next_pending_invoice_item_invoice": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`."
    }
  },
  "description": "Subscriptions allow you to charge a customer on a recurring basis.\n\nRelated guide: [Creating subscriptions](https://docs.stripe.com/billing/subscriptions/creating)",
  "x-resourceId": "subscription",
  "x-expandableFields": [
    "application",
    "automatic_tax",
    "billing_cycle_anchor_config",
    "billing_mode",
    "billing_thresholds",
    "cancellation_details",
    "customer",
    "default_payment_method",
    "default_source",
    "default_tax_rates",
    "discounts",
    "invoice_settings",
    "items",
    "latest_invoice",
    "on_behalf_of",
    "pause_collection",
    "payment_settings",
    "pending_invoice_item_interval",
    "pending_setup_intent",
    "pending_update",
    "presentment_details",
    "schedule",
    "test_clock",
    "transfer_data",
    "trial_settings"
  ]
}

object subscription_automatic_tax

{
  "type": "object",
  "title": "SubscriptionAutomaticTax",
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Whether Stripe automatically computes tax on this subscription."
    },
    "liability": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/connect_account_reference"
        }
      ],
      "nullable": true,
      "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account."
    },
    "disabled_reason": {
      "enum": [
        "requires_location_inputs"
      ],
      "type": "string",
      "nullable": true,
      "description": "If Stripe disabled automatic tax, this enum describes why."
    }
  },
  "description": "",
  "x-expandableFields": [
    "liability"
  ]
}

object subscription_billing_thresholds

{
  "type": "object",
  "title": "SubscriptionBillingThresholds",
  "properties": {
    "amount_gte": {
      "type": "integer",
      "nullable": true,
      "description": "Monetary threshold that triggers the subscription to create an invoice"
    },
    "reset_billing_cycle_anchor": {
      "type": "boolean",
      "nullable": true,
      "description": "Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object subscription_item

{
  "type": "object",
  "title": "SubscriptionItem",
  "required": [
    "created",
    "current_period_end",
    "current_period_start",
    "discounts",
    "id",
    "metadata",
    "object",
    "price",
    "subscription"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "price": {
      "$ref": "#/components/schemas/price"
    },
    "object": {
      "enum": [
        "subscription_item"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "quantity": {
      "type": "integer",
      "description": "The [quantity](https://docs.stripe.com/subscriptions/quantities) of the plan to which the customer should be subscribed."
    },
    "discounts": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 5000
          },
          {
            "$ref": "#/components/schemas/discount"
          }
        ],
        "x-expansionResources": {
          "oneOf": [
            {
              "$ref": "#/components/schemas/discount"
            }
          ]
        }
      },
      "description": "The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount."
    },
    "tax_rates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/tax_rate"
      },
      "nullable": true,
      "description": "The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`."
    },
    "subscription": {
      "type": "string",
      "maxLength": 5000,
      "description": "The `subscription` this `subscription_item` belongs to."
    },
    "billing_thresholds": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/subscription_item_billing_thresholds"
        }
      ],
      "nullable": true,
      "description": "Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period"
    },
    "current_period_end": {
      "type": "integer",
      "format": "unix-time",
      "description": "The end time of this subscription item's current billing period."
    },
    "current_period_start": {
      "type": "integer",
      "format": "unix-time",
      "description": "The start time of this subscription item's current billing period."
    }
  },
  "description": "Subscription items allow you to create customer subscriptions with more than\none plan, making it easy to represent complex billing relationships.",
  "x-resourceId": "subscription_item",
  "x-expandableFields": [
    "billing_thresholds",
    "discounts",
    "price",
    "tax_rates"
  ]
}

object subscription_item_billing_thresholds

{
  "type": "object",
  "title": "SubscriptionItemBillingThresholds",
  "properties": {
    "usage_gte": {
      "type": "integer",
      "nullable": true,
      "description": "Usage threshold that triggers the subscription to create an invoice"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object subscription_payment_method_options_card

{
  "type": "object",
  "title": "subscription_payment_method_options_card",
  "properties": {
    "network": {
      "enum": [
        "amex",
        "cartes_bancaires",
        "diners",
        "discover",
        "eftpos_au",
        "girocard",
        "interac",
        "jcb",
        "link",
        "mastercard",
        "unionpay",
        "unknown",
        "visa"
      ],
      "type": "string",
      "nullable": true,
      "description": "Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time."
    },
    "mandate_options": {
      "$ref": "#/components/schemas/invoice_mandate_options_card"
    },
    "request_three_d_secure": {
      "enum": [
        "any",
        "automatic",
        "challenge"
      ],
      "type": "string",
      "nullable": true,
      "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://docs.stripe.com/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine."
    }
  },
  "description": "",
  "x-expandableFields": [
    "mandate_options"
  ]
}

object subscription_pending_invoice_item_interval

{
  "type": "object",
  "title": "SubscriptionPendingInvoiceItemInterval",
  "required": [
    "interval",
    "interval_count"
  ],
  "properties": {
    "interval": {
      "enum": [
        "day",
        "month",
        "week",
        "year"
      ],
      "type": "string",
      "description": "Specifies invoicing frequency. Either `day`, `week`, `month` or `year`."
    },
    "interval_count": {
      "type": "integer",
      "description": "The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object subscription_schedule

{
  "type": "object",
  "title": "SubscriptionSchedule",
  "required": [
    "billing_mode",
    "created",
    "customer",
    "default_settings",
    "end_behavior",
    "id",
    "livemode",
    "object",
    "phases",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "subscription_schedule"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "phases": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/subscription_schedule_phase_configuration"
      },
      "description": "Configuration for the subscription schedule's phases."
    },
    "status": {
      "enum": [
        "active",
        "canceled",
        "completed",
        "not_started",
        "released"
      ],
      "type": "string",
      "description": "The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://docs.stripe.com/billing/subscriptions/subscription-schedules)."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        },
        {
          "$ref": "#/components/schemas/deleted_customer"
        }
      ],
      "description": "ID of the customer who owns the subscription schedule.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          },
          {
            "$ref": "#/components/schemas/deleted_customer"
          }
        ]
      }
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "test_clock": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/test_helpers.test_clock"
        }
      ],
      "nullable": true,
      "description": "ID of the test clock this subscription schedule belongs to.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/test_helpers.test_clock"
          }
        ]
      }
    },
    "application": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/application"
        },
        {
          "$ref": "#/components/schemas/deleted_application"
        }
      ],
      "nullable": true,
      "description": "ID of the Connect Application that created the schedule.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/application"
          },
          {
            "$ref": "#/components/schemas/deleted_application"
          }
        ]
      }
    },
    "canceled_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch."
    },
    "released_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Time at which the subscription schedule was released. Measured in seconds since the Unix epoch."
    },
    "billing_mode": {
      "$ref": "#/components/schemas/subscriptions_resource_billing_mode"
    },
    "completed_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch."
    },
    "end_behavior": {
      "enum": [
        "cancel",
        "none",
        "release",
        "renew"
      ],
      "type": "string",
      "description": "Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription."
    },
    "subscription": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/subscription"
        }
      ],
      "nullable": true,
      "description": "ID of the subscription managed by the subscription schedule.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/subscription"
          }
        ]
      }
    },
    "current_phase": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/subscription_schedule_current_phase"
        }
      ],
      "nullable": true,
      "description": "Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`."
    },
    "customer_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the account who owns the subscription schedule."
    },
    "default_settings": {
      "$ref": "#/components/schemas/subscription_schedules_resource_default_settings"
    },
    "released_subscription": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the subscription once managed by the subscription schedule (if it is released)."
    }
  },
  "description": "A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.\n\nRelated guide: [Subscription schedules](https://docs.stripe.com/billing/subscriptions/subscription-schedules)",
  "x-resourceId": "subscription_schedule",
  "x-expandableFields": [
    "application",
    "billing_mode",
    "current_phase",
    "customer",
    "default_settings",
    "phases",
    "subscription",
    "test_clock"
  ]
}

object subscription_schedule_add_invoice_item

{
  "type": "object",
  "title": "SubscriptionScheduleAddInvoiceItem",
  "required": [
    "discounts",
    "period",
    "price"
  ],
  "properties": {
    "price": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/price"
        },
        {
          "$ref": "#/components/schemas/deleted_price"
        }
      ],
      "description": "ID of the price used to generate the invoice item.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/price"
          },
          {
            "$ref": "#/components/schemas/deleted_price"
          }
        ]
      }
    },
    "period": {
      "$ref": "#/components/schemas/subscription_schedule_add_invoice_item_period"
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "quantity": {
      "type": "integer",
      "nullable": true,
      "description": "The quantity of the invoice item."
    },
    "discounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/discounts_resource_stackable_discount_with_discount_end"
      },
      "description": "The stackable discounts that will be applied to the item."
    },
    "tax_rates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/tax_rate"
      },
      "nullable": true,
      "description": "The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item."
    }
  },
  "description": "An Add Invoice Item describes the prices and quantities that will be added as pending invoice items when entering a phase.",
  "x-expandableFields": [
    "discounts",
    "period",
    "price",
    "tax_rates"
  ]
}

object subscription_schedule_add_invoice_item_period

{
  "type": "object",
  "title": "SubscriptionScheduleAddInvoiceItemPeriod",
  "required": [
    "end",
    "start"
  ],
  "properties": {
    "end": {
      "$ref": "#/components/schemas/subscription_schedules_resource_invoice_item_period_resource_period_end"
    },
    "start": {
      "$ref": "#/components/schemas/subscription_schedules_resource_invoice_item_period_resource_period_start"
    }
  },
  "description": "",
  "x-expandableFields": [
    "end",
    "start"
  ]
}

object subscription_schedule_configuration_item

{
  "type": "object",
  "title": "SubscriptionScheduleConfigurationItem",
  "required": [
    "discounts",
    "price"
  ],
  "properties": {
    "price": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/price"
        },
        {
          "$ref": "#/components/schemas/deleted_price"
        }
      ],
      "description": "ID of the price to which the customer should be subscribed.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/price"
          },
          {
            "$ref": "#/components/schemas/deleted_price"
          }
        ]
      }
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "quantity": {
      "type": "integer",
      "description": "Quantity of the plan to which the customer should be subscribed."
    },
    "discounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/stackable_discount_with_discount_settings"
      },
      "description": "The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount."
    },
    "tax_rates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/tax_rate"
      },
      "nullable": true,
      "description": "The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`."
    },
    "billing_thresholds": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/subscription_item_billing_thresholds"
        }
      ],
      "nullable": true,
      "description": "Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period"
    }
  },
  "description": "A phase item describes the price and quantity of a phase.",
  "x-expandableFields": [
    "billing_thresholds",
    "discounts",
    "price",
    "tax_rates"
  ]
}

object subscription_schedule_current_phase

{
  "type": "object",
  "title": "SubscriptionScheduleCurrentPhase",
  "required": [
    "end_date",
    "start_date"
  ],
  "properties": {
    "end_date": {
      "type": "integer",
      "format": "unix-time",
      "description": "The end of this phase of the subscription schedule."
    },
    "start_date": {
      "type": "integer",
      "format": "unix-time",
      "description": "The start of this phase of the subscription schedule."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object subscription_schedule_phase_configuration

{
  "type": "object",
  "title": "SubscriptionSchedulePhaseConfiguration",
  "required": [
    "add_invoice_items",
    "currency",
    "discounts",
    "end_date",
    "items",
    "proration_behavior",
    "start_date"
  ],
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/subscription_schedule_configuration_item"
      },
      "description": "Subscription items to configure the subscription to during this phase of the subscription schedule."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "end_date": {
      "type": "integer",
      "format": "unix-time",
      "description": "The end of this phase of the subscription schedule."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "discounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/stackable_discount_with_discount_settings_and_discount_end"
      },
      "description": "The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts."
    },
    "trial_end": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "When the trial ends within the phase."
    },
    "start_date": {
      "type": "integer",
      "format": "unix-time",
      "description": "The start of this phase of the subscription schedule."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs."
    },
    "on_behalf_of": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/account"
        }
      ],
      "nullable": true,
      "description": "The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/account"
          }
        ]
      }
    },
    "automatic_tax": {
      "$ref": "#/components/schemas/schedules_phase_automatic_tax"
    },
    "transfer_data": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/subscription_transfer_data"
        }
      ],
      "nullable": true,
      "description": "The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices."
    },
    "invoice_settings": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/invoice_setting_subscription_schedule_phase_setting"
        }
      ],
      "nullable": true,
      "description": "The invoice settings applicable during this phase."
    },
    "add_invoice_items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/subscription_schedule_add_invoice_item"
      },
      "description": "A list of prices and quantities that will generate invoice items appended to the next invoice for this phase."
    },
    "collection_method": {
      "enum": [
        "charge_automatically",
        "send_invoice"
      ],
      "type": "string",
      "nullable": true,
      "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`."
    },
    "default_tax_rates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/tax_rate"
      },
      "nullable": true,
      "description": "The default tax rates to apply to the subscription during this phase of the subscription schedule."
    },
    "billing_thresholds": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/subscription_billing_thresholds"
        }
      ],
      "nullable": true,
      "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period"
    },
    "proration_behavior": {
      "enum": [
        "always_invoice",
        "create_prorations",
        "none"
      ],
      "type": "string",
      "description": "When transitioning phases, controls how prorations are handled (if any). Possible values are `create_prorations`, `none`, and `always_invoice`."
    },
    "billing_cycle_anchor": {
      "enum": [
        "automatic",
        "phase_start"
      ],
      "type": "string",
      "nullable": true,
      "description": "Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle)."
    },
    "default_payment_method": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_method"
        }
      ],
      "nullable": true,
      "description": "ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_method"
          }
        ]
      }
    },
    "application_fee_percent": {
      "type": "number",
      "nullable": true,
      "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule."
    }
  },
  "description": "A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period.",
  "x-expandableFields": [
    "add_invoice_items",
    "automatic_tax",
    "billing_thresholds",
    "default_payment_method",
    "default_tax_rates",
    "discounts",
    "invoice_settings",
    "items",
    "on_behalf_of",
    "transfer_data"
  ]
}

object subscription_schedules_resource_default_settings

{
  "type": "object",
  "title": "SubscriptionSchedulesResourceDefaultSettings",
  "required": [
    "billing_cycle_anchor",
    "invoice_settings"
  ],
  "properties": {
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs."
    },
    "on_behalf_of": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/account"
        }
      ],
      "nullable": true,
      "description": "The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/account"
          }
        ]
      }
    },
    "automatic_tax": {
      "$ref": "#/components/schemas/subscription_schedules_resource_default_settings_automatic_tax"
    },
    "transfer_data": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/subscription_transfer_data"
        }
      ],
      "nullable": true,
      "description": "The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices."
    },
    "invoice_settings": {
      "$ref": "#/components/schemas/invoice_setting_subscription_schedule_setting"
    },
    "collection_method": {
      "enum": [
        "charge_automatically",
        "send_invoice"
      ],
      "type": "string",
      "nullable": true,
      "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`."
    },
    "billing_thresholds": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/subscription_billing_thresholds"
        }
      ],
      "nullable": true,
      "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period"
    },
    "billing_cycle_anchor": {
      "enum": [
        "automatic",
        "phase_start"
      ],
      "type": "string",
      "description": "Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle)."
    },
    "default_payment_method": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_method"
        }
      ],
      "nullable": true,
      "description": "ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_method"
          }
        ]
      }
    },
    "application_fee_percent": {
      "type": "number",
      "nullable": true,
      "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule."
    }
  },
  "description": "",
  "x-expandableFields": [
    "automatic_tax",
    "billing_thresholds",
    "default_payment_method",
    "invoice_settings",
    "on_behalf_of",
    "transfer_data"
  ]
}

object subscription_schedules_resource_default_settings_automatic_tax

{
  "type": "object",
  "title": "SubscriptionSchedulesResourceDefaultSettingsAutomaticTax",
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Whether Stripe automatically computes tax on invoices created during this phase."
    },
    "liability": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/connect_account_reference"
        }
      ],
      "nullable": true,
      "description": "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account."
    },
    "disabled_reason": {
      "enum": [
        "requires_location_inputs"
      ],
      "type": "string",
      "nullable": true,
      "description": "If Stripe disabled automatic tax, this enum describes why."
    }
  },
  "description": "",
  "x-expandableFields": [
    "liability"
  ]
}

object subscription_schedules_resource_invoice_item_period_resource_period_end

{
  "type": "object",
  "title": "SubscriptionSchedulesResourceInvoiceItemPeriodResourcePeriodEnd",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "min_item_period_end",
        "phase_end",
        "timestamp"
      ],
      "type": "string",
      "description": "Select how to calculate the end of the invoice item period.",
      "x-stripeBypassValidation": true
    },
    "timestamp": {
      "type": "integer",
      "format": "unix-time",
      "description": "A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object subscription_schedules_resource_invoice_item_period_resource_period_start

{
  "type": "object",
  "title": "SubscriptionSchedulesResourceInvoiceItemPeriodResourcePeriodStart",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "max_item_period_start",
        "phase_start",
        "timestamp"
      ],
      "type": "string",
      "description": "Select how to calculate the start of the invoice item period.",
      "x-stripeBypassValidation": true
    },
    "timestamp": {
      "type": "integer",
      "format": "unix-time",
      "description": "A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object subscription_transfer_data

{
  "type": "object",
  "title": "SubscriptionTransferData",
  "required": [
    "destination"
  ],
  "properties": {
    "destination": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/account"
        }
      ],
      "description": "The account where funds from the payment will be transferred to upon payment success.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/account"
          }
        ]
      }
    },
    "amount_percent": {
      "type": "number",
      "nullable": true,
      "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination."
    }
  },
  "description": "",
  "x-expandableFields": [
    "destination"
  ]
}

object subscriptions_resource_billing_cycle_anchor_config

{
  "type": "object",
  "title": "SubscriptionsResourceBillingCycleAnchorConfig",
  "required": [
    "day_of_month"
  ],
  "properties": {
    "hour": {
      "type": "integer",
      "nullable": true,
      "description": "The hour of the day of the billing_cycle_anchor."
    },
    "month": {
      "type": "integer",
      "nullable": true,
      "description": "The month to start full cycle billing periods."
    },
    "minute": {
      "type": "integer",
      "nullable": true,
      "description": "The minute of the hour of the billing_cycle_anchor."
    },
    "second": {
      "type": "integer",
      "nullable": true,
      "description": "The second of the minute of the billing_cycle_anchor."
    },
    "day_of_month": {
      "type": "integer",
      "description": "The day of the month of the billing_cycle_anchor."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object subscriptions_resource_billing_mode

{
  "type": "object",
  "title": "SubscriptionsResourceBillingMode",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "classic",
        "flexible"
      ],
      "type": "string",
      "description": "Controls how prorations and invoices for subscriptions are calculated and orchestrated."
    },
    "flexible": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/subscriptions_resource_billing_mode_flexible"
        }
      ],
      "nullable": true,
      "description": "Configure behavior for flexible billing mode"
    },
    "updated_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "Details on when the current billing_mode was adopted."
    }
  },
  "description": "The billing mode of the subscription.",
  "x-expandableFields": [
    "flexible"
  ]
}

object subscriptions_resource_billing_mode_flexible

{
  "type": "object",
  "title": "SubscriptionsResourceBillingModeFlexible",
  "properties": {
    "proration_discounts": {
      "enum": [
        "included",
        "itemized"
      ],
      "type": "string",
      "description": "Controls how invoices and invoice items display proration amounts and discount amounts."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object subscriptions_resource_pause_collection

{
  "type": "object",
  "title": "SubscriptionsResourcePauseCollection",
  "required": [
    "behavior"
  ],
  "properties": {
    "behavior": {
      "enum": [
        "keep_as_draft",
        "mark_uncollectible",
        "void"
      ],
      "type": "string",
      "description": "The payment collection behavior for this subscription while paused.",
      "x-stripeBypassValidation": true
    },
    "resumes_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The time after which the subscription will resume collecting payments."
    }
  },
  "description": "The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription\nshould be paused.",
  "x-expandableFields": []
}

object subscriptions_resource_payment_method_options

{
  "type": "object",
  "title": "SubscriptionsResourcePaymentMethodOptions",
  "properties": {
    "card": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/subscription_payment_method_options_card"
        }
      ],
      "nullable": true,
      "description": "This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription."
    },
    "payto": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/invoice_payment_method_options_payto"
        }
      ],
      "nullable": true,
      "description": "This sub-hash contains details about the PayTo payment method options to pass to invoices created by the subscription."
    },
    "konbini": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/invoice_payment_method_options_konbini"
        }
      ],
      "nullable": true,
      "description": "This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription."
    },
    "acss_debit": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/invoice_payment_method_options_acss_debit"
        }
      ],
      "nullable": true,
      "description": "This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription."
    },
    "bancontact": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/invoice_payment_method_options_bancontact"
        }
      ],
      "nullable": true,
      "description": "This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription."
    },
    "sepa_debit": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/invoice_payment_method_options_sepa_debit"
        }
      ],
      "nullable": true,
      "description": "This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription."
    },
    "us_bank_account": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/invoice_payment_method_options_us_bank_account"
        }
      ],
      "nullable": true,
      "description": "This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription."
    },
    "customer_balance": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/invoice_payment_method_options_customer_balance"
        }
      ],
      "nullable": true,
      "description": "This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription."
    }
  },
  "description": "",
  "x-expandableFields": [
    "acss_debit",
    "bancontact",
    "card",
    "customer_balance",
    "konbini",
    "payto",
    "sepa_debit",
    "us_bank_account"
  ]
}

object subscriptions_resource_payment_settings

{
  "type": "object",
  "title": "SubscriptionsResourcePaymentSettings",
  "properties": {
    "payment_method_types": {
      "type": "array",
      "items": {
        "enum": [
          "ach_credit_transfer",
          "ach_debit",
          "acss_debit",
          "affirm",
          "amazon_pay",
          "au_becs_debit",
          "bacs_debit",
          "bancontact",
          "boleto",
          "card",
          "cashapp",
          "crypto",
          "custom",
          "customer_balance",
          "eps",
          "fpx",
          "giropay",
          "grabpay",
          "ideal",
          "jp_credit_transfer",
          "kakao_pay",
          "klarna",
          "konbini",
          "kr_card",
          "link",
          "multibanco",
          "naver_pay",
          "nz_bank_account",
          "p24",
          "pay_by_bank",
          "payco",
          "paynow",
          "paypal",
          "payto",
          "promptpay",
          "revolut_pay",
          "sepa_credit_transfer",
          "sepa_debit",
          "sofort",
          "swish",
          "us_bank_account",
          "wechat_pay"
        ],
        "type": "string",
        "x-stripeBypassValidation": true
      },
      "nullable": true,
      "description": "The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice)."
    },
    "payment_method_options": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/subscriptions_resource_payment_method_options"
        }
      ],
      "nullable": true,
      "description": "Payment-method-specific configuration to provide to invoices created by the subscription."
    },
    "save_default_payment_method": {
      "enum": [
        "off",
        "on_subscription"
      ],
      "type": "string",
      "nullable": true,
      "description": "Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off`."
    }
  },
  "description": "",
  "x-expandableFields": [
    "payment_method_options"
  ]
}

object subscriptions_resource_pending_update

{
  "type": "object",
  "title": "SubscriptionsResourcePendingUpdate",
  "required": [
    "expires_at"
  ],
  "properties": {
    "trial_end": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied."
    },
    "expires_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "The point after which the changes reflected by this update will be discarded and no longer applied."
    },
    "trial_from_plan": {
      "type": "boolean",
      "nullable": true,
      "description": "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more."
    },
    "subscription_items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/subscription_item"
      },
      "nullable": true,
      "description": "List of subscription items, each with an attached plan, that will be set if the update is applied."
    },
    "billing_cycle_anchor": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "If the update is applied, determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format."
    }
  },
  "description": "Pending Updates store the changes pending from a previous update that will be applied\nto the Subscription upon successful payment.",
  "x-expandableFields": [
    "subscription_items"
  ]
}

object subscriptions_resource_subscription_invoice_settings

{
  "type": "object",
  "title": "SubscriptionsResourceSubscriptionInvoiceSettings",
  "required": [
    "issuer"
  ],
  "properties": {
    "issuer": {
      "$ref": "#/components/schemas/connect_account_reference"
    },
    "account_tax_ids": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 5000
          },
          {
            "$ref": "#/components/schemas/tax_id"
          },
          {
            "$ref": "#/components/schemas/deleted_tax_id"
          }
        ],
        "x-expansionResources": {
          "oneOf": [
            {
              "$ref": "#/components/schemas/tax_id"
            },
            {
              "$ref": "#/components/schemas/deleted_tax_id"
            }
          ]
        }
      },
      "nullable": true,
      "description": "The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription."
    }
  },
  "description": "",
  "x-expandableFields": [
    "account_tax_ids",
    "issuer"
  ]
}

object subscriptions_resource_subscription_presentment_details

{
  "type": "object",
  "title": "SubscriptionsResourceSubscriptionPresentmentDetails",
  "required": [
    "presentment_currency"
  ],
  "properties": {
    "presentment_currency": {
      "type": "string",
      "maxLength": 5000,
      "description": "Currency used for customer payments."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object subscriptions_resource_trial_settings_end_behavior

{
  "type": "object",
  "title": "SubscriptionsResourceTrialSettingsEndBehavior",
  "required": [
    "missing_payment_method"
  ],
  "properties": {
    "missing_payment_method": {
      "enum": [
        "cancel",
        "create_invoice",
        "pause"
      ],
      "type": "string",
      "description": "Indicates how the subscription should change when the trial ends if the user did not provide a payment method."
    }
  },
  "description": "Defines how a subscription behaves when a trial ends.",
  "x-expandableFields": []
}

object subscriptions_resource_trial_settings_trial_settings

{
  "type": "object",
  "title": "SubscriptionsResourceTrialSettingsTrialSettings",
  "required": [
    "end_behavior"
  ],
  "properties": {
    "end_behavior": {
      "$ref": "#/components/schemas/subscriptions_resource_trial_settings_end_behavior"
    }
  },
  "description": "Configures how this subscription behaves during the trial period.",
  "x-expandableFields": [
    "end_behavior"
  ]
}

object subscriptions_trials_resource_end_behavior

{
  "type": "object",
  "title": "SubscriptionsTrialsResourceEndBehavior",
  "required": [
    "missing_payment_method"
  ],
  "properties": {
    "missing_payment_method": {
      "enum": [
        "cancel",
        "create_invoice",
        "pause"
      ],
      "type": "string",
      "description": "Indicates how the subscription should change when the trial ends if the user did not provide a payment method."
    }
  },
  "description": "Defines how a subscription behaves when a free trial ends.",
  "x-expandableFields": []
}

object subscriptions_trials_resource_trial_settings

{
  "type": "object",
  "title": "SubscriptionsTrialsResourceTrialSettings",
  "required": [
    "end_behavior"
  ],
  "properties": {
    "end_behavior": {
      "$ref": "#/components/schemas/subscriptions_trials_resource_end_behavior"
    }
  },
  "description": "Configures how this subscription behaves during the trial period.",
  "x-expandableFields": [
    "end_behavior"
  ]
}

object tax.association

{
  "type": "object",
  "title": "TaxProductResourceTaxAssociation",
  "required": [
    "calculation",
    "id",
    "object",
    "payment_intent"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "tax.association"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "calculation": {
      "type": "string",
      "maxLength": 5000,
      "description": "The [Tax Calculation](https://docs.stripe.com/api/tax/calculations/object) that was included in PaymentIntent."
    },
    "payment_intent": {
      "type": "string",
      "maxLength": 5000,
      "description": "The [PaymentIntent](https://docs.stripe.com/api/payment_intents/object) that this Tax Association is tracking."
    },
    "tax_transaction_attempts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/tax_product_resource_tax_association_transaction_attempts"
      },
      "nullable": true,
      "description": "Information about the tax transactions linked to this payment intent"
    }
  },
  "description": "A Tax Association exposes the Tax Transactions that Stripe attempted to create on your behalf based on the PaymentIntent input",
  "x-resourceId": "tax.association",
  "x-expandableFields": [
    "tax_transaction_attempts"
  ]
}

object tax.calculation

{
  "type": "object",
  "title": "TaxProductResourceTaxCalculation",
  "required": [
    "amount_total",
    "currency",
    "customer_details",
    "livemode",
    "object",
    "tax_amount_exclusive",
    "tax_amount_inclusive",
    "tax_breakdown",
    "tax_date"
  ],
  "properties": {
    "id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Unique identifier for the calculation."
    },
    "object": {
      "enum": [
        "tax.calculation"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "currency": {
      "type": "string",
      "maxLength": 5000,
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "customer": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The ID of an existing [Customer](https://docs.stripe.com/api/customers/object) used for the resource."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "tax_date": {
      "type": "integer",
      "format": "unix-time",
      "description": "Timestamp of date at which the tax rules and rates in effect applies for the calculation."
    },
    "expires_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Timestamp of date at which the tax calculation will expire."
    },
    "line_items": {
      "type": "object",
      "title": "TaxProductResourceTaxCalculationLineItemList",
      "nullable": true,
      "required": [
        "data",
        "has_more",
        "object",
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "pattern": "^/v1/tax/calculations/[^/]+/line_items",
          "maxLength": 5000,
          "description": "The URL where this list can be accessed."
        },
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/tax.calculation_line_item"
          },
          "description": "Details about each object."
        },
        "object": {
          "enum": [
            "list"
          ],
          "type": "string",
          "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
        },
        "has_more": {
          "type": "boolean",
          "description": "True if this list has another page of items after this one that can be fetched."
        }
      },
      "description": "The list of items the customer is purchasing.",
      "x-expandableFields": [
        "data"
      ]
    },
    "amount_total": {
      "type": "integer",
      "description": "Total amount after taxes in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units)."
    },
    "shipping_cost": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/tax_product_resource_tax_calculation_shipping_cost"
        }
      ],
      "nullable": true,
      "description": "The shipping cost details for the calculation."
    },
    "tax_breakdown": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/tax_product_resource_tax_breakdown"
      },
      "description": "Breakdown of individual tax amounts that add up to the total."
    },
    "customer_details": {
      "$ref": "#/components/schemas/tax_product_resource_customer_details"
    },
    "ship_from_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/tax_product_resource_ship_from_details"
        }
      ],
      "nullable": true,
      "description": "The details of the ship from location, such as the address."
    },
    "tax_amount_exclusive": {
      "type": "integer",
      "description": "The amount of tax to be collected on top of the line item prices."
    },
    "tax_amount_inclusive": {
      "type": "integer",
      "description": "The amount of tax already included in the line item prices."
    }
  },
  "description": "A Tax Calculation allows you to calculate the tax to collect from your customer.\n\nRelated guide: [Calculate tax in your custom payment flow](https://docs.stripe.com/tax/custom)",
  "x-resourceId": "tax.calculation",
  "x-expandableFields": [
    "customer_details",
    "line_items",
    "ship_from_details",
    "shipping_cost",
    "tax_breakdown"
  ]
}

object tax.calculation_line_item

{
  "type": "object",
  "title": "TaxProductResourceTaxCalculationLineItem",
  "required": [
    "amount",
    "amount_tax",
    "id",
    "livemode",
    "object",
    "quantity",
    "reference",
    "tax_behavior",
    "tax_code"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "amount": {
      "type": "integer",
      "description": "The line item amount in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount."
    },
    "object": {
      "enum": [
        "tax.calculation_line_item"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "product": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The ID of an existing [Product](https://docs.stripe.com/api/products/object)."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "quantity": {
      "type": "integer",
      "description": "The number of units of the item being purchased. For reversals, this is the quantity reversed."
    },
    "tax_code": {
      "type": "string",
      "maxLength": 5000,
      "description": "The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for this resource."
    },
    "reference": {
      "type": "string",
      "maxLength": 5000,
      "description": "A custom identifier for this line item."
    },
    "amount_tax": {
      "type": "integer",
      "description": "The amount of tax calculated for this line item, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units)."
    },
    "tax_behavior": {
      "enum": [
        "exclusive",
        "inclusive"
      ],
      "type": "string",
      "description": "Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes."
    },
    "tax_breakdown": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/tax_product_resource_line_item_tax_breakdown"
      },
      "nullable": true,
      "description": "Detailed account of taxes relevant to this line item."
    }
  },
  "description": "",
  "x-resourceId": "tax.calculation_line_item",
  "x-expandableFields": [
    "tax_breakdown"
  ]
}

object tax.registration

{
  "type": "object",
  "title": "TaxProductRegistrationsResourceTaxRegistration",
  "required": [
    "active_from",
    "country",
    "country_options",
    "created",
    "id",
    "livemode",
    "object",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "tax.registration"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "active",
        "expired",
        "scheduled"
      ],
      "type": "string",
      "description": "The status of the registration. This field is present for convenience and can be deduced from `active_from` and `expires_at`."
    },
    "country": {
      "type": "string",
      "maxLength": 5000,
      "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "expires_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. Measured in seconds since the Unix epoch."
    },
    "active_from": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the registration becomes active. Measured in seconds since the Unix epoch."
    },
    "country_options": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options"
    }
  },
  "description": "A Tax `Registration` lets us know that your business is registered to collect tax on payments within a region, enabling you to [automatically collect tax](https://docs.stripe.com/tax).\n\nStripe doesn't register on your behalf with the relevant authorities when you create a Tax `Registration` object. For more information on how to register to collect tax, see [our guide](https://docs.stripe.com/tax/registering).\n\nRelated guide: [Using the Registrations API](https://docs.stripe.com/tax/registrations-api)",
  "x-resourceId": "tax.registration",
  "x-expandableFields": [
    "country_options"
  ]
}

object tax.settings

{
  "type": "object",
  "title": "TaxProductResourceTaxSettings",
  "required": [
    "defaults",
    "livemode",
    "object",
    "status",
    "status_details"
  ],
  "properties": {
    "object": {
      "enum": [
        "tax.settings"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "active",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Tax `Settings`."
    },
    "defaults": {
      "$ref": "#/components/schemas/tax_product_resource_tax_settings_defaults"
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "head_office": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/tax_product_resource_tax_settings_head_office"
        }
      ],
      "nullable": true,
      "description": "The place where your business is located."
    },
    "status_details": {
      "$ref": "#/components/schemas/tax_product_resource_tax_settings_status_details"
    }
  },
  "description": "You can use Tax `Settings` to manage configurations used by Stripe Tax calculations.\n\nRelated guide: [Using the Settings API](https://docs.stripe.com/tax/settings-api)",
  "x-resourceId": "tax.settings",
  "x-expandableFields": [
    "defaults",
    "head_office",
    "status_details"
  ]
}

object tax.transaction

{
  "type": "object",
  "title": "TaxProductResourceTaxTransaction",
  "required": [
    "created",
    "currency",
    "customer_details",
    "id",
    "livemode",
    "object",
    "posted_at",
    "reference",
    "tax_date",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the transaction."
    },
    "type": {
      "enum": [
        "reversal",
        "transaction"
      ],
      "type": "string",
      "description": "If `reversal`, this transaction reverses an earlier transaction."
    },
    "object": {
      "enum": [
        "tax.transaction"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "currency": {
      "type": "string",
      "maxLength": 5000,
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "customer": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The ID of an existing [Customer](https://docs.stripe.com/api/customers/object) used for the resource."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "reversal": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/tax_product_resource_tax_transaction_resource_reversal"
        }
      ],
      "nullable": true,
      "description": "If `type=reversal`, contains information about what was reversed."
    },
    "tax_date": {
      "type": "integer",
      "format": "unix-time",
      "description": "Timestamp of date at which the tax rules and rates in effect applies for the calculation."
    },
    "posted_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "The Unix timestamp representing when the tax liability is assumed or reduced."
    },
    "reference": {
      "type": "string",
      "maxLength": 5000,
      "description": "A custom unique identifier, such as 'myOrder_123'."
    },
    "line_items": {
      "type": "object",
      "title": "TaxProductResourceTaxTransactionLineItemList",
      "nullable": true,
      "required": [
        "data",
        "has_more",
        "object",
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "pattern": "^/v1/tax/transactions/[^/]+/line_items",
          "maxLength": 5000,
          "description": "The URL where this list can be accessed."
        },
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/tax.transaction_line_item"
          },
          "description": "Details about each object."
        },
        "object": {
          "enum": [
            "list"
          ],
          "type": "string",
          "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
        },
        "has_more": {
          "type": "boolean",
          "description": "True if this list has another page of items after this one that can be fetched."
        }
      },
      "description": "The tax collected or refunded, by line item.",
      "x-expandableFields": [
        "data"
      ]
    },
    "shipping_cost": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/tax_product_resource_tax_transaction_shipping_cost"
        }
      ],
      "nullable": true,
      "description": "The shipping cost details for the transaction."
    },
    "customer_details": {
      "$ref": "#/components/schemas/tax_product_resource_customer_details"
    },
    "ship_from_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/tax_product_resource_ship_from_details"
        }
      ],
      "nullable": true,
      "description": "The details of the ship from location, such as the address."
    }
  },
  "description": "A Tax Transaction records the tax collected from or refunded to your customer.\n\nRelated guide: [Calculate tax in your custom payment flow](https://docs.stripe.com/tax/custom#tax-transaction)",
  "x-resourceId": "tax.transaction",
  "x-expandableFields": [
    "customer_details",
    "line_items",
    "reversal",
    "ship_from_details",
    "shipping_cost"
  ]
}

object tax.transaction_line_item

{
  "type": "object",
  "title": "TaxProductResourceTaxTransactionLineItem",
  "required": [
    "amount",
    "amount_tax",
    "id",
    "livemode",
    "object",
    "quantity",
    "reference",
    "tax_behavior",
    "tax_code",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "type": {
      "enum": [
        "reversal",
        "transaction"
      ],
      "type": "string",
      "description": "If `reversal`, this line item reverses an earlier transaction."
    },
    "amount": {
      "type": "integer",
      "description": "The line item amount in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount."
    },
    "object": {
      "enum": [
        "tax.transaction_line_item"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "product": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The ID of an existing [Product](https://docs.stripe.com/api/products/object)."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "quantity": {
      "type": "integer",
      "description": "The number of units of the item being purchased. For reversals, this is the quantity reversed."
    },
    "reversal": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/tax_product_resource_tax_transaction_line_item_resource_reversal"
        }
      ],
      "nullable": true,
      "description": "If `type=reversal`, contains information about what was reversed."
    },
    "tax_code": {
      "type": "string",
      "maxLength": 5000,
      "description": "The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for this resource."
    },
    "reference": {
      "type": "string",
      "maxLength": 5000,
      "description": "A custom identifier for this line item in the transaction."
    },
    "amount_tax": {
      "type": "integer",
      "description": "The amount of tax calculated for this line item, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units)."
    },
    "tax_behavior": {
      "enum": [
        "exclusive",
        "inclusive"
      ],
      "type": "string",
      "description": "Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes."
    }
  },
  "description": "",
  "x-resourceId": "tax.transaction_line_item",
  "x-expandableFields": [
    "reversal"
  ]
}

object tax_code

{
  "type": "object",
  "title": "TaxProductResourceTaxCode",
  "required": [
    "description",
    "id",
    "name",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "name": {
      "type": "string",
      "maxLength": 5000,
      "description": "A short name for the tax code."
    },
    "object": {
      "enum": [
        "tax_code"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "description": {
      "type": "string",
      "maxLength": 5000,
      "description": "A detailed description of which types of products the tax code represents."
    }
  },
  "description": "[Tax codes](https://stripe.com/docs/tax/tax-categories) classify goods and services for tax purposes.",
  "x-resourceId": "tax_code",
  "x-expandableFields": []
}

object tax_deducted_at_source

{
  "type": "object",
  "title": "TaxDeductedAtSource",
  "required": [
    "id",
    "object",
    "period_end",
    "period_start",
    "tax_deduction_account_number"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "tax_deducted_at_source"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "period_end": {
      "type": "integer",
      "format": "unix-time",
      "description": "The end of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period."
    },
    "period_start": {
      "type": "integer",
      "format": "unix-time",
      "description": "The start of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period."
    },
    "tax_deduction_account_number": {
      "type": "string",
      "maxLength": 5000,
      "description": "The TAN that was supplied to Stripe when TDS was assessed"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object tax_i_ds_owner

{
  "type": "object",
  "title": "TaxIDsOwner",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "account",
        "application",
        "customer",
        "self"
      ],
      "type": "string",
      "description": "Type of owner referenced."
    },
    "account": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/account"
        }
      ],
      "description": "The account being referenced when `type` is `account`.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/account"
          }
        ]
      }
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        }
      ],
      "description": "The customer being referenced when `type` is `customer`.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          }
        ]
      }
    },
    "application": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/application"
        }
      ],
      "description": "The Connect Application being referenced when `type` is `application`.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/application"
          }
        ]
      }
    },
    "customer_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The Account representing the customer being referenced when `type` is `customer`."
    }
  },
  "description": "",
  "x-expandableFields": [
    "account",
    "application",
    "customer"
  ]
}

object tax_id

{
  "type": "object",
  "title": "tax_id",
  "required": [
    "created",
    "id",
    "livemode",
    "object",
    "type",
    "value"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "type": {
      "enum": [
        "ad_nrt",
        "ae_trn",
        "al_tin",
        "am_tin",
        "ao_tin",
        "ar_cuit",
        "au_abn",
        "au_arn",
        "aw_tin",
        "az_tin",
        "ba_tin",
        "bb_tin",
        "bd_bin",
        "bf_ifu",
        "bg_uic",
        "bh_vat",
        "bj_ifu",
        "bo_tin",
        "br_cnpj",
        "br_cpf",
        "bs_tin",
        "by_tin",
        "ca_bn",
        "ca_gst_hst",
        "ca_pst_bc",
        "ca_pst_mb",
        "ca_pst_sk",
        "ca_qst",
        "cd_nif",
        "ch_uid",
        "ch_vat",
        "cl_tin",
        "cm_niu",
        "cn_tin",
        "co_nit",
        "cr_tin",
        "cv_nif",
        "de_stn",
        "do_rcn",
        "ec_ruc",
        "eg_tin",
        "es_cif",
        "et_tin",
        "eu_oss_vat",
        "eu_vat",
        "gb_vat",
        "ge_vat",
        "gn_nif",
        "hk_br",
        "hr_oib",
        "hu_tin",
        "id_npwp",
        "il_vat",
        "in_gst",
        "is_vat",
        "jp_cn",
        "jp_rn",
        "jp_trn",
        "ke_pin",
        "kg_tin",
        "kh_tin",
        "kr_brn",
        "kz_bin",
        "la_tin",
        "li_uid",
        "li_vat",
        "lk_vat",
        "ma_vat",
        "md_vat",
        "me_pib",
        "mk_vat",
        "mr_nif",
        "mx_rfc",
        "my_frp",
        "my_itn",
        "my_sst",
        "ng_tin",
        "no_vat",
        "no_voec",
        "np_pan",
        "nz_gst",
        "om_vat",
        "pe_ruc",
        "ph_tin",
        "pl_nip",
        "ro_tin",
        "rs_pib",
        "ru_inn",
        "ru_kpp",
        "sa_vat",
        "sg_gst",
        "sg_uen",
        "si_tin",
        "sn_ninea",
        "sr_fin",
        "sv_nit",
        "th_vat",
        "tj_tin",
        "tr_tin",
        "tw_vat",
        "tz_vat",
        "ua_vat",
        "ug_tin",
        "unknown",
        "us_ein",
        "uy_ruc",
        "uz_tin",
        "uz_vat",
        "ve_rif",
        "vn_tin",
        "za_vat",
        "zm_tin",
        "zw_tin"
      ],
      "type": "string",
      "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`. Note that some legacy tax IDs have type `unknown`"
    },
    "owner": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/tax_i_ds_owner"
        }
      ],
      "nullable": true,
      "description": "The account or customer the tax ID belongs to."
    },
    "value": {
      "type": "string",
      "maxLength": 5000,
      "description": "Value of the tax ID."
    },
    "object": {
      "enum": [
        "tax_id"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter ISO code representing the country of the tax ID."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        }
      ],
      "nullable": true,
      "description": "ID of the customer.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          }
        ]
      }
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "verification": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/tax_id_verification"
        }
      ],
      "nullable": true,
      "description": "Tax ID verification information."
    },
    "customer_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the Account representing the customer."
    }
  },
  "description": "You can add one or multiple tax IDs to a [customer](https://docs.stripe.com/api/customers) or account.\nCustomer and account tax IDs get displayed on related invoices and credit notes.\n\nRelated guides: [Customer tax identification numbers](https://docs.stripe.com/billing/taxes/tax-ids), [Account tax IDs](https://docs.stripe.com/invoicing/connect#account-tax-ids)",
  "x-resourceId": "tax_id",
  "x-expandableFields": [
    "customer",
    "owner",
    "verification"
  ]
}

object tax_id_verification

{
  "type": "object",
  "title": "tax_id_verification",
  "required": [
    "status"
  ],
  "properties": {
    "status": {
      "enum": [
        "pending",
        "unavailable",
        "unverified",
        "verified"
      ],
      "type": "string",
      "description": "Verification status, one of `pending`, `verified`, `unverified`, or `unavailable`."
    },
    "verified_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Verified name."
    },
    "verified_address": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Verified address."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object tax_product_registrations_resource_country_options

{
  "type": "object",
  "title": "TaxProductRegistrationsResourceCountryOptions",
  "properties": {
    "ae": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods"
    },
    "al": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
    },
    "am": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "ao": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
    },
    "at": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
    },
    "au": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods"
    },
    "aw": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
    },
    "az": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "ba": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
    },
    "bb": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
    },
    "bd": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
    },
    "be": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
    },
    "bf": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
    },
    "bg": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
    },
    "bh": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
    },
    "bj": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "bs": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
    },
    "by": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "ca": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_canada"
    },
    "cd": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
    },
    "ch": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods"
    },
    "cl": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "cm": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "co": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "cr": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "cv": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "cy": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
    },
    "cz": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
    },
    "de": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
    },
    "dk": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
    },
    "ec": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "ee": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
    },
    "eg": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "es": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
    },
    "et": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
    },
    "fi": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
    },
    "fr": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
    },
    "gb": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods"
    },
    "ge": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "gn": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
    },
    "gr": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
    },
    "hr": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
    },
    "hu": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
    },
    "id": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "ie": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
    },
    "in": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "is": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
    },
    "it": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
    },
    "jp": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods"
    },
    "ke": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "kg": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "kh": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "kr": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "kz": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "la": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "lk": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "lt": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
    },
    "lu": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
    },
    "lv": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
    },
    "ma": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "md": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "me": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
    },
    "mk": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
    },
    "mr": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
    },
    "mt": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
    },
    "mx": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "my": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "ng": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "nl": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
    },
    "no": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods"
    },
    "np": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "nz": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods"
    },
    "om": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
    },
    "pe": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "ph": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "pl": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
    },
    "pt": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
    },
    "ro": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
    },
    "rs": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
    },
    "ru": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "sa": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "se": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
    },
    "sg": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods"
    },
    "si": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
    },
    "sk": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
    },
    "sn": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "sr": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
    },
    "th": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_thailand"
    },
    "tj": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "tr": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "tw": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "tz": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "ua": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "ug": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "us": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_united_states"
    },
    "uy": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
    },
    "uz": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "vn": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "za": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
    },
    "zm": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
    },
    "zw": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
    }
  },
  "description": "",
  "x-expandableFields": [
    "ae",
    "al",
    "am",
    "ao",
    "at",
    "au",
    "aw",
    "az",
    "ba",
    "bb",
    "bd",
    "be",
    "bf",
    "bg",
    "bh",
    "bj",
    "bs",
    "by",
    "ca",
    "cd",
    "ch",
    "cl",
    "cm",
    "co",
    "cr",
    "cv",
    "cy",
    "cz",
    "de",
    "dk",
    "ec",
    "ee",
    "eg",
    "es",
    "et",
    "fi",
    "fr",
    "gb",
    "ge",
    "gn",
    "gr",
    "hr",
    "hu",
    "id",
    "ie",
    "in",
    "is",
    "it",
    "jp",
    "ke",
    "kg",
    "kh",
    "kr",
    "kz",
    "la",
    "lk",
    "lt",
    "lu",
    "lv",
    "ma",
    "md",
    "me",
    "mk",
    "mr",
    "mt",
    "mx",
    "my",
    "ng",
    "nl",
    "no",
    "np",
    "nz",
    "om",
    "pe",
    "ph",
    "pl",
    "pt",
    "ro",
    "rs",
    "ru",
    "sa",
    "se",
    "sg",
    "si",
    "sk",
    "sn",
    "sr",
    "th",
    "tj",
    "tr",
    "tw",
    "tz",
    "ua",
    "ug",
    "us",
    "uy",
    "uz",
    "vn",
    "za",
    "zm",
    "zw"
  ]
}

object tax_product_registrations_resource_country_options_ca_province_standard

{
  "type": "object",
  "title": "TaxProductRegistrationsResourceCountryOptionsCaProvinceStandard",
  "required": [
    "province"
  ],
  "properties": {
    "province": {
      "type": "string",
      "maxLength": 5000,
      "description": "Two-letter CA province code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object tax_product_registrations_resource_country_options_canada

{
  "type": "object",
  "title": "TaxProductRegistrationsResourceCountryOptionsCanada",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "province_standard",
        "simplified",
        "standard"
      ],
      "type": "string",
      "description": "Type of registration in Canada."
    },
    "province_standard": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_ca_province_standard"
    }
  },
  "description": "",
  "x-expandableFields": [
    "province_standard"
  ]
}

object tax_product_registrations_resource_country_options_default

{
  "type": "object",
  "title": "TaxProductRegistrationsResourceCountryOptionsDefault",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "standard"
      ],
      "type": "string",
      "description": "Type of registration in `country`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object tax_product_registrations_resource_country_options_default_inbound_goods

{
  "type": "object",
  "title": "TaxProductRegistrationsResourceCountryOptionsDefaultInboundGoods",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "standard"
      ],
      "type": "string",
      "description": "Type of registration in `country`."
    },
    "standard": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default_standard"
    }
  },
  "description": "",
  "x-expandableFields": [
    "standard"
  ]
}

object tax_product_registrations_resource_country_options_default_standard

{
  "type": "object",
  "title": "TaxProductRegistrationsResourceCountryOptionsDefaultStandard",
  "required": [
    "place_of_supply_scheme"
  ],
  "properties": {
    "place_of_supply_scheme": {
      "enum": [
        "inbound_goods",
        "standard"
      ],
      "type": "string",
      "description": "Place of supply scheme used in an Default standard registration."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object tax_product_registrations_resource_country_options_eu_standard

{
  "type": "object",
  "title": "TaxProductRegistrationsResourceCountryOptionsEuStandard",
  "required": [
    "place_of_supply_scheme"
  ],
  "properties": {
    "place_of_supply_scheme": {
      "enum": [
        "inbound_goods",
        "small_seller",
        "standard"
      ],
      "type": "string",
      "description": "Place of supply scheme used in an EU standard registration."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object tax_product_registrations_resource_country_options_europe

{
  "type": "object",
  "title": "TaxProductRegistrationsResourceCountryOptionsEurope",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "ioss",
        "oss_non_union",
        "oss_union",
        "standard"
      ],
      "type": "string",
      "description": "Type of registration in an EU country."
    },
    "standard": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_eu_standard"
    }
  },
  "description": "",
  "x-expandableFields": [
    "standard"
  ]
}

object tax_product_registrations_resource_country_options_simplified

{
  "type": "object",
  "title": "TaxProductRegistrationsResourceCountryOptionsSimplified",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "simplified"
      ],
      "type": "string",
      "description": "Type of registration in `country`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object tax_product_registrations_resource_country_options_thailand

{
  "type": "object",
  "title": "TaxProductRegistrationsResourceCountryOptionsThailand",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "simplified"
      ],
      "type": "string",
      "description": "Type of registration in `country`.",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": []
}

object tax_product_registrations_resource_country_options_united_states

{
  "type": "object",
  "title": "TaxProductRegistrationsResourceCountryOptionsUnitedStates",
  "required": [
    "state",
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "local_amusement_tax",
        "local_lease_tax",
        "state_communications_tax",
        "state_retail_delivery_fee",
        "state_sales_tax"
      ],
      "type": "string",
      "description": "Type of registration in the US.",
      "x-stripeBypassValidation": true
    },
    "state": {
      "type": "string",
      "maxLength": 5000,
      "description": "Two-letter US state code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."
    },
    "local_lease_tax": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_us_local_lease_tax"
    },
    "state_sales_tax": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_us_state_sales_tax"
    },
    "local_amusement_tax": {
      "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_us_local_amusement_tax"
    }
  },
  "description": "",
  "x-expandableFields": [
    "local_amusement_tax",
    "local_lease_tax",
    "state_sales_tax"
  ]
}

object tax_product_registrations_resource_country_options_us_local_amusement_tax

{
  "type": "object",
  "title": "TaxProductRegistrationsResourceCountryOptionsUsLocalAmusementTax",
  "required": [
    "jurisdiction"
  ],
  "properties": {
    "jurisdiction": {
      "type": "string",
      "maxLength": 5000,
      "description": "A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object tax_product_registrations_resource_country_options_us_local_lease_tax

{
  "type": "object",
  "title": "TaxProductRegistrationsResourceCountryOptionsUsLocalLeaseTax",
  "required": [
    "jurisdiction"
  ],
  "properties": {
    "jurisdiction": {
      "type": "string",
      "maxLength": 5000,
      "description": "A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object tax_product_registrations_resource_country_options_us_state_sales_tax

{
  "type": "object",
  "title": "TaxProductRegistrationsResourceCountryOptionsUsStateSalesTax",
  "properties": {
    "elections": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_us_state_sales_tax_election"
      },
      "description": "Elections for the state sales tax registration."
    }
  },
  "description": "",
  "x-expandableFields": [
    "elections"
  ]
}

object tax_product_registrations_resource_country_options_us_state_sales_tax_election

{
  "type": "object",
  "title": "TaxProductRegistrationsResourceCountryOptionsUsStateSalesTaxElection",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "local_use_tax",
        "simplified_sellers_use_tax",
        "single_local_use_tax"
      ],
      "type": "string",
      "description": "The type of the election for the state sales tax registration."
    },
    "jurisdiction": {
      "type": "string",
      "maxLength": 5000,
      "description": "A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object tax_product_resource_customer_details

{
  "type": "object",
  "title": "TaxProductResourceCustomerDetails",
  "required": [
    "tax_ids",
    "taxability_override"
  ],
  "properties": {
    "address": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/tax_product_resource_postal_address"
        }
      ],
      "nullable": true,
      "description": "The customer's postal address (for example, home or business location)."
    },
    "tax_ids": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/tax_product_resource_customer_details_resource_tax_id"
      },
      "description": "The customer's tax IDs (for example, EU VAT numbers)."
    },
    "ip_address": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The customer's IP address (IPv4 or IPv6)."
    },
    "address_source": {
      "enum": [
        "billing",
        "shipping"
      ],
      "type": "string",
      "nullable": true,
      "description": "The type of customer address provided."
    },
    "taxability_override": {
      "enum": [
        "customer_exempt",
        "none",
        "reverse_charge"
      ],
      "type": "string",
      "description": "The taxability override used for taxation."
    }
  },
  "description": "",
  "x-expandableFields": [
    "address",
    "tax_ids"
  ]
}

object tax_product_resource_customer_details_resource_tax_id

{
  "type": "object",
  "title": "TaxProductResourceCustomerDetailsResourceTaxId",
  "required": [
    "type",
    "value"
  ],
  "properties": {
    "type": {
      "enum": [
        "ad_nrt",
        "ae_trn",
        "al_tin",
        "am_tin",
        "ao_tin",
        "ar_cuit",
        "au_abn",
        "au_arn",
        "aw_tin",
        "az_tin",
        "ba_tin",
        "bb_tin",
        "bd_bin",
        "bf_ifu",
        "bg_uic",
        "bh_vat",
        "bj_ifu",
        "bo_tin",
        "br_cnpj",
        "br_cpf",
        "bs_tin",
        "by_tin",
        "ca_bn",
        "ca_gst_hst",
        "ca_pst_bc",
        "ca_pst_mb",
        "ca_pst_sk",
        "ca_qst",
        "cd_nif",
        "ch_uid",
        "ch_vat",
        "cl_tin",
        "cm_niu",
        "cn_tin",
        "co_nit",
        "cr_tin",
        "cv_nif",
        "de_stn",
        "do_rcn",
        "ec_ruc",
        "eg_tin",
        "es_cif",
        "et_tin",
        "eu_oss_vat",
        "eu_vat",
        "gb_vat",
        "ge_vat",
        "gn_nif",
        "hk_br",
        "hr_oib",
        "hu_tin",
        "id_npwp",
        "il_vat",
        "in_gst",
        "is_vat",
        "jp_cn",
        "jp_rn",
        "jp_trn",
        "ke_pin",
        "kg_tin",
        "kh_tin",
        "kr_brn",
        "kz_bin",
        "la_tin",
        "li_uid",
        "li_vat",
        "lk_vat",
        "ma_vat",
        "md_vat",
        "me_pib",
        "mk_vat",
        "mr_nif",
        "mx_rfc",
        "my_frp",
        "my_itn",
        "my_sst",
        "ng_tin",
        "no_vat",
        "no_voec",
        "np_pan",
        "nz_gst",
        "om_vat",
        "pe_ruc",
        "ph_tin",
        "pl_nip",
        "ro_tin",
        "rs_pib",
        "ru_inn",
        "ru_kpp",
        "sa_vat",
        "sg_gst",
        "sg_uen",
        "si_tin",
        "sn_ninea",
        "sr_fin",
        "sv_nit",
        "th_vat",
        "tj_tin",
        "tr_tin",
        "tw_vat",
        "tz_vat",
        "ua_vat",
        "ug_tin",
        "unknown",
        "us_ein",
        "uy_ruc",
        "uz_tin",
        "uz_vat",
        "ve_rif",
        "vn_tin",
        "za_vat",
        "zm_tin",
        "zw_tin"
      ],
      "type": "string",
      "description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`"
    },
    "value": {
      "type": "string",
      "maxLength": 5000,
      "description": "The value of the tax ID."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object tax_product_resource_jurisdiction

{
  "type": "object",
  "title": "TaxProductResourceJurisdiction",
  "required": [
    "country",
    "display_name",
    "level"
  ],
  "properties": {
    "level": {
      "enum": [
        "city",
        "country",
        "county",
        "district",
        "state"
      ],
      "type": "string",
      "description": "Indicates the level of the jurisdiction imposing the tax."
    },
    "state": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, \"NY\" for New York, United States."
    },
    "country": {
      "type": "string",
      "maxLength": 5000,
      "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."
    },
    "display_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "A human-readable name for the jurisdiction imposing the tax."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object tax_product_resource_line_item_tax_breakdown

{
  "type": "object",
  "title": "TaxProductResourceLineItemTaxBreakdown",
  "required": [
    "amount",
    "jurisdiction",
    "sourcing",
    "taxability_reason",
    "taxable_amount"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "The amount of tax, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units)."
    },
    "sourcing": {
      "enum": [
        "destination",
        "origin"
      ],
      "type": "string",
      "description": "Indicates whether the jurisdiction was determined by the origin (merchant's address) or destination (customer's address).",
      "x-stripeBypassValidation": true
    },
    "jurisdiction": {
      "$ref": "#/components/schemas/tax_product_resource_jurisdiction"
    },
    "taxable_amount": {
      "type": "integer",
      "description": "The amount on which tax is calculated, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units)."
    },
    "tax_rate_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/tax_product_resource_line_item_tax_rate_details"
        }
      ],
      "nullable": true,
      "description": "Details regarding the rate for this tax. This field will be `null` when the tax is not imposed, for example if the product is exempt from tax."
    },
    "taxability_reason": {
      "enum": [
        "customer_exempt",
        "not_collecting",
        "not_subject_to_tax",
        "not_supported",
        "portion_product_exempt",
        "portion_reduced_rated",
        "portion_standard_rated",
        "product_exempt",
        "product_exempt_holiday",
        "proportionally_rated",
        "reduced_rated",
        "reverse_charge",
        "standard_rated",
        "taxable_basis_reduced",
        "zero_rated"
      ],
      "type": "string",
      "description": "The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported."
    }
  },
  "description": "",
  "x-expandableFields": [
    "jurisdiction",
    "tax_rate_details"
  ]
}

object tax_product_resource_line_item_tax_rate_details

{
  "type": "object",
  "title": "TaxProductResourceLineItemTaxRateDetails",
  "required": [
    "display_name",
    "percentage_decimal",
    "tax_type"
  ],
  "properties": {
    "tax_type": {
      "enum": [
        "amusement_tax",
        "communications_tax",
        "gst",
        "hst",
        "igst",
        "jct",
        "lease_tax",
        "pst",
        "qst",
        "retail_delivery_fee",
        "rst",
        "sales_tax",
        "service_tax",
        "vat"
      ],
      "type": "string",
      "description": "The tax type, such as `vat` or `sales_tax`.",
      "x-stripeBypassValidation": true
    },
    "display_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "A localized display name for tax type, intended to be human-readable. For example, \"Local Sales and Use Tax\", \"Value-added tax (VAT)\", or \"Umsatzsteuer (USt.)\"."
    },
    "percentage_decimal": {
      "type": "string",
      "maxLength": 5000,
      "description": "The tax rate percentage as a string. For example, 8.5% is represented as \"8.5\"."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object tax_product_resource_postal_address

{
  "type": "object",
  "title": "TaxProductResourcePostalAddress",
  "required": [
    "country"
  ],
  "properties": {
    "city": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "City, district, suburb, town, or village."
    },
    "line1": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Address line 1, such as the street, PO Box, or company name."
    },
    "line2": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Address line 2, such as the apartment, suite, unit, or building."
    },
    "state": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix, such as \"NY\" or \"TX\"."
    },
    "country": {
      "type": "string",
      "maxLength": 5000,
      "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."
    },
    "postal_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ZIP or postal code."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object tax_product_resource_ship_from_details

{
  "type": "object",
  "title": "TaxProductResourceShipFromDetails",
  "required": [
    "address"
  ],
  "properties": {
    "address": {
      "$ref": "#/components/schemas/tax_product_resource_postal_address"
    }
  },
  "description": "",
  "x-expandableFields": [
    "address"
  ]
}

object tax_product_resource_tax_association_transaction_attempts

{
  "type": "object",
  "title": "TaxProductResourceTaxAssociationTransactionAttempts",
  "required": [
    "source",
    "status"
  ],
  "properties": {
    "source": {
      "type": "string",
      "maxLength": 5000,
      "description": "The source of the tax transaction attempt. This is either a refund or a payment intent."
    },
    "status": {
      "type": "string",
      "maxLength": 5000,
      "description": "The status of the transaction attempt. This can be `errored` or `committed`."
    },
    "errored": {
      "$ref": "#/components/schemas/tax_product_resource_tax_association_transaction_attempts_resource_errored"
    },
    "committed": {
      "$ref": "#/components/schemas/tax_product_resource_tax_association_transaction_attempts_resource_committed"
    }
  },
  "description": "",
  "x-expandableFields": [
    "committed",
    "errored"
  ]
}

object tax_product_resource_tax_association_transaction_attempts_resource_committed

{
  "type": "object",
  "title": "TaxProductResourceTaxAssociationTransactionAttemptsResourceCommitted",
  "required": [
    "transaction"
  ],
  "properties": {
    "transaction": {
      "type": "string",
      "maxLength": 5000,
      "description": "The [Tax Transaction](https://docs.stripe.com/api/tax/transaction/object)"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object tax_product_resource_tax_association_transaction_attempts_resource_errored

{
  "type": "object",
  "title": "TaxProductResourceTaxAssociationTransactionAttemptsResourceErrored",
  "required": [
    "reason"
  ],
  "properties": {
    "reason": {
      "enum": [
        "another_payment_associated_with_calculation",
        "calculation_expired",
        "currency_mismatch",
        "original_transaction_voided",
        "unique_reference_violation"
      ],
      "type": "string",
      "description": "Details on why we couldn't commit the tax transaction."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object tax_product_resource_tax_breakdown

{
  "type": "object",
  "title": "TaxProductResourceTaxBreakdown",
  "required": [
    "amount",
    "inclusive",
    "tax_rate_details",
    "taxability_reason",
    "taxable_amount"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "The amount of tax, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units)."
    },
    "inclusive": {
      "type": "boolean",
      "description": "Specifies whether the tax amount is included in the line item amount."
    },
    "taxable_amount": {
      "type": "integer",
      "description": "The amount on which tax is calculated, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units)."
    },
    "tax_rate_details": {
      "$ref": "#/components/schemas/tax_product_resource_tax_rate_details"
    },
    "taxability_reason": {
      "enum": [
        "customer_exempt",
        "not_collecting",
        "not_subject_to_tax",
        "not_supported",
        "portion_product_exempt",
        "portion_reduced_rated",
        "portion_standard_rated",
        "product_exempt",
        "product_exempt_holiday",
        "proportionally_rated",
        "reduced_rated",
        "reverse_charge",
        "standard_rated",
        "taxable_basis_reduced",
        "zero_rated"
      ],
      "type": "string",
      "description": "The reasoning behind this tax, for example, if the product is tax exempt. We might extend the possible values for this field to support new tax rules."
    }
  },
  "description": "",
  "x-expandableFields": [
    "tax_rate_details"
  ]
}

object tax_product_resource_tax_calculation_shipping_cost

{
  "type": "object",
  "title": "TaxProductResourceTaxCalculationShippingCost",
  "required": [
    "amount",
    "amount_tax",
    "tax_behavior",
    "tax_code"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "The shipping amount in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount."
    },
    "tax_code": {
      "type": "string",
      "maxLength": 5000,
      "description": "The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for shipping."
    },
    "amount_tax": {
      "type": "integer",
      "description": "The amount of tax calculated for shipping, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units)."
    },
    "tax_behavior": {
      "enum": [
        "exclusive",
        "inclusive"
      ],
      "type": "string",
      "description": "Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes."
    },
    "shipping_rate": {
      "type": "string",
      "maxLength": 5000,
      "description": "The ID of an existing [ShippingRate](https://docs.stripe.com/api/shipping_rates/object)."
    },
    "tax_breakdown": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/tax_product_resource_line_item_tax_breakdown"
      },
      "description": "Detailed account of taxes relevant to shipping cost."
    }
  },
  "description": "",
  "x-expandableFields": [
    "tax_breakdown"
  ]
}

object tax_product_resource_tax_rate_details

{
  "type": "object",
  "title": "TaxProductResourceTaxRateDetails",
  "required": [
    "percentage_decimal"
  ],
  "properties": {
    "state": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."
    },
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."
    },
    "tax_type": {
      "enum": [
        "amusement_tax",
        "communications_tax",
        "gst",
        "hst",
        "igst",
        "jct",
        "lease_tax",
        "pst",
        "qst",
        "retail_delivery_fee",
        "rst",
        "sales_tax",
        "service_tax",
        "vat"
      ],
      "type": "string",
      "nullable": true,
      "description": "The tax type, such as `vat` or `sales_tax`.",
      "x-stripeBypassValidation": true
    },
    "rate_type": {
      "enum": [
        "flat_amount",
        "percentage"
      ],
      "type": "string",
      "nullable": true,
      "description": "Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax."
    },
    "flat_amount": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/tax_rate_flat_amount"
        }
      ],
      "nullable": true,
      "description": "The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate."
    },
    "percentage_decimal": {
      "type": "string",
      "maxLength": 5000,
      "description": "The tax rate percentage as a string. For example, 8.5% is represented as `\"8.5\"`."
    }
  },
  "description": "",
  "x-expandableFields": [
    "flat_amount"
  ]
}

object tax_product_resource_tax_settings_defaults

{
  "type": "object",
  "title": "TaxProductResourceTaxSettingsDefaults",
  "required": [
    "provider"
  ],
  "properties": {
    "provider": {
      "enum": [
        "anrok",
        "avalara",
        "sphere",
        "stripe"
      ],
      "type": "string",
      "description": "The tax calculation provider this account uses. Defaults to `stripe` when not using a [third-party provider](/tax/third-party-apps)."
    },
    "tax_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Default [tax code](https://stripe.com/docs/tax/tax-categories) used to classify your products and prices."
    },
    "tax_behavior": {
      "enum": [
        "exclusive",
        "inclusive",
        "inferred_by_currency"
      ],
      "type": "string",
      "nullable": true,
      "description": "Default [tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#tax-behavior) used to specify whether the price is considered inclusive of taxes or exclusive of taxes. If the item's price has a tax behavior set, it will take precedence over the default tax behavior."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object tax_product_resource_tax_settings_head_office

{
  "type": "object",
  "title": "TaxProductResourceTaxSettingsHeadOffice",
  "required": [
    "address"
  ],
  "properties": {
    "address": {
      "$ref": "#/components/schemas/address"
    }
  },
  "description": "",
  "x-expandableFields": [
    "address"
  ]
}

object tax_product_resource_tax_settings_status_details

{
  "type": "object",
  "title": "TaxProductResourceTaxSettingsStatusDetails",
  "properties": {
    "active": {
      "$ref": "#/components/schemas/tax_product_resource_tax_settings_status_details_resource_active"
    },
    "pending": {
      "$ref": "#/components/schemas/tax_product_resource_tax_settings_status_details_resource_pending"
    }
  },
  "description": "",
  "x-expandableFields": [
    "active",
    "pending"
  ]
}

object tax_product_resource_tax_settings_status_details_resource_active

{
  "type": "object",
  "title": "TaxProductResourceTaxSettingsStatusDetailsResourceActive",
  "properties": {},
  "description": "",
  "x-expandableFields": []
}

object tax_product_resource_tax_settings_status_details_resource_pending

{
  "type": "object",
  "title": "TaxProductResourceTaxSettingsStatusDetailsResourcePending",
  "properties": {
    "missing_fields": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "The list of missing fields that are required to perform calculations. It includes the entry `head_office` when the status is `pending`. It is recommended to set the optional values even if they aren't listed as required for calculating taxes. Calculations can fail if missing fields aren't explicitly provided on every call."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object tax_product_resource_tax_transaction_line_item_resource_reversal

{
  "type": "object",
  "title": "TaxProductResourceTaxTransactionLineItemResourceReversal",
  "required": [
    "original_line_item"
  ],
  "properties": {
    "original_line_item": {
      "type": "string",
      "maxLength": 5000,
      "description": "The `id` of the line item to reverse in the original transaction."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object tax_product_resource_tax_transaction_resource_reversal

{
  "type": "object",
  "title": "TaxProductResourceTaxTransactionResourceReversal",
  "properties": {
    "original_transaction": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The `id` of the reversed `Transaction` object."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object tax_product_resource_tax_transaction_shipping_cost

{
  "type": "object",
  "title": "TaxProductResourceTaxTransactionShippingCost",
  "required": [
    "amount",
    "amount_tax",
    "tax_behavior",
    "tax_code"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "The shipping amount in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount."
    },
    "tax_code": {
      "type": "string",
      "maxLength": 5000,
      "description": "The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for shipping."
    },
    "amount_tax": {
      "type": "integer",
      "description": "The amount of tax calculated for shipping, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units)."
    },
    "tax_behavior": {
      "enum": [
        "exclusive",
        "inclusive"
      ],
      "type": "string",
      "description": "Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes."
    },
    "shipping_rate": {
      "type": "string",
      "maxLength": 5000,
      "description": "The ID of an existing [ShippingRate](https://docs.stripe.com/api/shipping_rates/object)."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object tax_rate

{
  "type": "object",
  "title": "TaxRate",
  "required": [
    "active",
    "created",
    "display_name",
    "id",
    "inclusive",
    "livemode",
    "object",
    "percentage"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "state": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, \"NY\" for New York, United States."
    },
    "active": {
      "type": "boolean",
      "description": "Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set."
    },
    "object": {
      "enum": [
        "tax_rate"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "country": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "tax_type": {
      "enum": [
        "amusement_tax",
        "communications_tax",
        "gst",
        "hst",
        "igst",
        "jct",
        "lease_tax",
        "pst",
        "qst",
        "retail_delivery_fee",
        "rst",
        "sales_tax",
        "service_tax",
        "vat"
      ],
      "type": "string",
      "nullable": true,
      "description": "The high-level tax type, such as `vat` or `sales_tax`.",
      "x-stripeBypassValidation": true
    },
    "inclusive": {
      "type": "boolean",
      "description": "This specifies if the tax rate is inclusive or exclusive."
    },
    "rate_type": {
      "enum": [
        "flat_amount",
        "percentage"
      ],
      "type": "string",
      "nullable": true,
      "description": "Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax."
    },
    "percentage": {
      "type": "number",
      "description": "Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers."
    },
    "flat_amount": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/tax_rate_flat_amount"
        }
      ],
      "nullable": true,
      "description": "The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate."
    },
    "display_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page."
    },
    "jurisdiction": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice."
    },
    "jurisdiction_level": {
      "enum": [
        "city",
        "country",
        "county",
        "district",
        "multiple",
        "state"
      ],
      "type": "string",
      "nullable": true,
      "description": "The level of the jurisdiction that imposes this tax rate. Will be `null` for manually defined tax rates."
    },
    "effective_percentage": {
      "type": "number",
      "nullable": true,
      "description": "Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true,\nthis percentage reflects the rate actually used to calculate tax based on the product's taxability\nand whether the user is registered to collect taxes in the corresponding jurisdiction."
    }
  },
  "description": "Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax.\n\nRelated guide: [Tax rates](/billing/taxes/tax-rates)",
  "x-resourceId": "tax_rate",
  "x-expandableFields": [
    "flat_amount"
  ]
}

object tax_rate_flat_amount

{
  "type": "object",
  "title": "TaxRateFlatAmount",
  "required": [
    "amount",
    "currency"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "Amount of the tax when the `rate_type` is `flat_amount`. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99)."
    },
    "currency": {
      "type": "string",
      "maxLength": 5000,
      "description": "Three-letter ISO currency code, in lowercase."
    }
  },
  "description": "The amount of the tax rate when the `rate_type`` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate.",
  "x-expandableFields": []
}

object terminal.configuration

{
  "type": "object",
  "title": "TerminalConfigurationConfiguration",
  "required": [
    "id",
    "livemode",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "String indicating the name of the Configuration object, set by the user"
    },
    "wifi": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_wifi_config"
    },
    "object": {
      "enum": [
        "terminal.configuration"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "offline": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_offline_config"
    },
    "tipping": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_tipping"
    },
    "cellular": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_cellular_config"
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "stripe_s700": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_device_type_specific_config"
    },
    "stripe_s710": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_device_type_specific_config"
    },
    "reboot_window": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_reboot_window"
    },
    "verifone_p400": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_device_type_specific_config"
    },
    "bbpos_wisepad3": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_device_type_specific_config"
    },
    "bbpos_wisepos_e": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_device_type_specific_config"
    },
    "is_account_default": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether this Configuration is the default for your account"
    }
  },
  "description": "A Configurations object represents how features should be configured for terminal readers.\nFor information about how to use it, see the [Terminal configurations documentation](https://docs.stripe.com/terminal/fleet/configurations-overview).",
  "x-resourceId": "terminal.configuration",
  "x-expandableFields": [
    "bbpos_wisepad3",
    "bbpos_wisepos_e",
    "cellular",
    "offline",
    "reboot_window",
    "stripe_s700",
    "stripe_s710",
    "tipping",
    "verifone_p400",
    "wifi"
  ]
}

object terminal.connection_token

{
  "type": "object",
  "title": "TerminalConnectionToken",
  "required": [
    "object",
    "secret"
  ],
  "properties": {
    "object": {
      "enum": [
        "terminal.connection_token"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "secret": {
      "type": "string",
      "maxLength": 5000,
      "description": "Your application should pass this token to the Stripe Terminal SDK."
    },
    "location": {
      "type": "string",
      "maxLength": 5000,
      "description": "The id of the location that this connection token is scoped to. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://docs.stripe.com/terminal/fleet/locations-and-zones?dashboard-or-api=api#connection-tokens)."
    }
  },
  "description": "A Connection Token is used by the Stripe Terminal SDK to connect to a reader.\n\nRelated guide: [Fleet management](https://docs.stripe.com/terminal/fleet/locations)",
  "x-resourceId": "terminal.connection_token",
  "x-expandableFields": []
}

object terminal.location

{
  "type": "object",
  "title": "TerminalLocationLocation",
  "required": [
    "address",
    "display_name",
    "id",
    "livemode",
    "metadata",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "phone": {
      "type": "string",
      "maxLength": 5000,
      "description": "The phone number of the location."
    },
    "object": {
      "enum": [
        "terminal.location"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "address": {
      "$ref": "#/components/schemas/address"
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "address_kana": {
      "$ref": "#/components/schemas/legal_entity_japan_address"
    },
    "display_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The display name of the location."
    },
    "address_kanji": {
      "$ref": "#/components/schemas/legal_entity_japan_address"
    },
    "display_name_kana": {
      "type": "string",
      "maxLength": 5000,
      "description": "The Kana variation of the display name of the location."
    },
    "display_name_kanji": {
      "type": "string",
      "maxLength": 5000,
      "description": "The Kanji variation of the display name of the location."
    },
    "configuration_overrides": {
      "type": "string",
      "maxLength": 5000,
      "description": "The ID of a configuration that will be used to customize all readers in this location."
    }
  },
  "description": "A Location represents a grouping of readers.\n\nRelated guide: [Fleet management](https://docs.stripe.com/terminal/fleet/locations)",
  "x-resourceId": "terminal.location",
  "x-expandableFields": [
    "address",
    "address_kana",
    "address_kanji"
  ]
}

object terminal.onboarding_link

{
  "type": "object",
  "title": "TerminalOnboardingLinkOnboardingLink",
  "required": [
    "link_options",
    "link_type",
    "object",
    "redirect_url"
  ],
  "properties": {
    "object": {
      "enum": [
        "terminal.onboarding_link"
      ],
      "type": "string"
    },
    "link_type": {
      "enum": [
        "apple_terms_and_conditions"
      ],
      "type": "string",
      "description": "The type of link being generated."
    },
    "link_options": {
      "$ref": "#/components/schemas/terminal_onboarding_link_link_options"
    },
    "on_behalf_of": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Stripe account ID to generate the link for."
    },
    "redirect_url": {
      "type": "string",
      "maxLength": 5000,
      "description": "The link passed back to the user for their onboarding."
    }
  },
  "description": "Returns redirect links used for onboarding onto Tap to Pay on iPhone.",
  "x-resourceId": "terminal.onboarding_link",
  "x-expandableFields": [
    "link_options"
  ]
}

object terminal.reader

{
  "type": "object",
  "title": "TerminalReaderReader",
  "required": [
    "device_type",
    "id",
    "label",
    "livemode",
    "metadata",
    "object",
    "serial_number"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "label": {
      "type": "string",
      "maxLength": 5000,
      "description": "Custom label given to the reader for easier identification."
    },
    "action": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/terminal_reader_reader_resource_reader_action"
        }
      ],
      "nullable": true,
      "description": "The most recent action performed by the reader."
    },
    "object": {
      "enum": [
        "terminal.reader"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "offline",
        "online"
      ],
      "type": "string",
      "nullable": true,
      "description": "The networking status of the reader. We do not recommend using this field in flows that may block taking payments."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "location": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/terminal.location"
        }
      ],
      "nullable": true,
      "description": "The location identifier of the reader.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/terminal.location"
          }
        ]
      }
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "ip_address": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The local IP address of the reader."
    },
    "device_type": {
      "enum": [
        "bbpos_chipper2x",
        "bbpos_wisepad3",
        "bbpos_wisepos_e",
        "mobile_phone_reader",
        "simulated_stripe_s700",
        "simulated_stripe_s710",
        "simulated_wisepos_e",
        "stripe_m2",
        "stripe_s700",
        "stripe_s710",
        "verifone_P400"
      ],
      "type": "string",
      "description": "Device type of the reader.",
      "x-stripeBypassValidation": true
    },
    "last_seen_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The last time this reader reported to Stripe backend. Timestamp is measured in milliseconds since the Unix epoch. Unlike most other Stripe timestamp fields which use seconds, this field uses milliseconds."
    },
    "serial_number": {
      "type": "string",
      "maxLength": 5000,
      "description": "Serial number of the reader."
    },
    "device_sw_version": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The current software version of the reader."
    }
  },
  "description": "A Reader represents a physical device for accepting payment details.\n\nRelated guide: [Connecting to a reader](https://docs.stripe.com/terminal/payments/connect-reader)",
  "x-resourceId": "terminal.reader",
  "x-expandableFields": [
    "action",
    "location"
  ]
}

object terminal.refund

{
  "type": "object",
  "title": "TerminalRefundsRefund",
  "properties": {},
  "description": "A Refund object returned by the Terminal refunds API.",
  "x-resourceId": "terminal.refund",
  "x-expandableFields": []
}

object terminal_configuration_configuration_resource_cellular_config

{
  "type": "object",
  "title": "TerminalConfigurationConfigurationResourceCellularConfig",
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Whether a cellular-capable reader can connect to the internet over cellular."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object terminal_configuration_configuration_resource_currency_specific_config

{
  "type": "object",
  "title": "TerminalConfigurationConfigurationResourceCurrencySpecificConfig",
  "properties": {
    "percentages": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "nullable": true,
      "description": "Percentages displayed when collecting a tip"
    },
    "fixed_amounts": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "nullable": true,
      "description": "Fixed amounts displayed when collecting a tip"
    },
    "smart_tip_threshold": {
      "type": "integer",
      "description": "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object terminal_configuration_configuration_resource_device_type_specific_config

{
  "type": "object",
  "title": "TerminalConfigurationConfigurationResourceDeviceTypeSpecificConfig",
  "properties": {
    "splashscreen": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/file"
        }
      ],
      "description": "A File ID representing an image to display on the reader",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/file"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "splashscreen"
  ]
}

object terminal_configuration_configuration_resource_enterprise_peap_wifi

{
  "type": "object",
  "title": "TerminalConfigurationConfigurationResourceEnterprisePEAPWifi",
  "required": [
    "password",
    "ssid",
    "username"
  ],
  "properties": {
    "ssid": {
      "type": "string",
      "maxLength": 5000,
      "description": "Name of the WiFi network"
    },
    "password": {
      "type": "string",
      "maxLength": 5000,
      "description": "Password for connecting to the WiFi network"
    },
    "username": {
      "type": "string",
      "maxLength": 5000,
      "description": "Username for connecting to the WiFi network"
    },
    "ca_certificate_file": {
      "type": "string",
      "maxLength": 5000,
      "description": "A File ID representing a PEM file containing the server certificate"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object terminal_configuration_configuration_resource_enterprise_tls_wifi

{
  "type": "object",
  "title": "TerminalConfigurationConfigurationResourceEnterpriseTLSWifi",
  "required": [
    "client_certificate_file",
    "private_key_file",
    "ssid"
  ],
  "properties": {
    "ssid": {
      "type": "string",
      "maxLength": 5000,
      "description": "Name of the WiFi network"
    },
    "private_key_file": {
      "type": "string",
      "maxLength": 5000,
      "description": "A File ID representing a PEM file containing the client RSA private key"
    },
    "ca_certificate_file": {
      "type": "string",
      "maxLength": 5000,
      "description": "A File ID representing a PEM file containing the server certificate"
    },
    "client_certificate_file": {
      "type": "string",
      "maxLength": 5000,
      "description": "A File ID representing a PEM file containing the client certificate"
    },
    "private_key_file_password": {
      "type": "string",
      "maxLength": 5000,
      "description": "Password for the private key file"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object terminal_configuration_configuration_resource_offline_config

{
  "type": "object",
  "title": "TerminalConfigurationConfigurationResourceOfflineConfig",
  "properties": {
    "enabled": {
      "type": "boolean",
      "nullable": true,
      "description": "Determines whether to allow transactions to be collected while reader is offline. Defaults to false."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object terminal_configuration_configuration_resource_personal_psk_wifi

{
  "type": "object",
  "title": "TerminalConfigurationConfigurationResourcePersonalPSKWifi",
  "required": [
    "password",
    "ssid"
  ],
  "properties": {
    "ssid": {
      "type": "string",
      "maxLength": 5000,
      "description": "Name of the WiFi network"
    },
    "password": {
      "type": "string",
      "maxLength": 5000,
      "description": "Password for connecting to the WiFi network"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object terminal_configuration_configuration_resource_reboot_window

{
  "type": "object",
  "title": "TerminalConfigurationConfigurationResourceRebootWindow",
  "required": [
    "end_hour",
    "start_hour"
  ],
  "properties": {
    "end_hour": {
      "type": "integer",
      "description": "Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour."
    },
    "start_hour": {
      "type": "integer",
      "description": "Integer between 0 to 23 that represents the start hour of the reboot time window."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object terminal_configuration_configuration_resource_tipping

{
  "type": "object",
  "title": "TerminalConfigurationConfigurationResourceTipping",
  "properties": {
    "aed": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
    },
    "aud": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
    },
    "cad": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
    },
    "chf": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
    },
    "czk": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
    },
    "dkk": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
    },
    "eur": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
    },
    "gbp": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
    },
    "gip": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
    },
    "hkd": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
    },
    "huf": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
    },
    "jpy": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
    },
    "mxn": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
    },
    "myr": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
    },
    "nok": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
    },
    "nzd": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
    },
    "pln": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
    },
    "ron": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
    },
    "sek": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
    },
    "sgd": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
    },
    "usd": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"
    }
  },
  "description": "",
  "x-expandableFields": [
    "aed",
    "aud",
    "cad",
    "chf",
    "czk",
    "dkk",
    "eur",
    "gbp",
    "gip",
    "hkd",
    "huf",
    "jpy",
    "mxn",
    "myr",
    "nok",
    "nzd",
    "pln",
    "ron",
    "sek",
    "sgd",
    "usd"
  ]
}

object terminal_configuration_configuration_resource_wifi_config

{
  "type": "object",
  "title": "TerminalConfigurationConfigurationResourceWifiConfig",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "enterprise_eap_peap",
        "enterprise_eap_tls",
        "personal_psk"
      ],
      "type": "string",
      "description": "Security type of the WiFi network. The hash with the corresponding name contains the credentials for this security type."
    },
    "personal_psk": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_personal_psk_wifi"
    },
    "enterprise_eap_tls": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_enterprise_tls_wifi"
    },
    "enterprise_eap_peap": {
      "$ref": "#/components/schemas/terminal_configuration_configuration_resource_enterprise_peap_wifi"
    }
  },
  "description": "",
  "x-expandableFields": [
    "enterprise_eap_peap",
    "enterprise_eap_tls",
    "personal_psk"
  ]
}

object terminal_onboarding_link_apple_terms_and_conditions

{
  "type": "object",
  "title": "TerminalOnboardingLinkAppleTermsAndConditions",
  "required": [
    "merchant_display_name"
  ],
  "properties": {
    "allow_relinking": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether the link should also support users relinking their Apple account."
    },
    "merchant_display_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The business name of the merchant accepting Apple's Terms and Conditions."
    }
  },
  "description": "Options associated with the Apple Terms and Conditions link type.",
  "x-expandableFields": []
}

object terminal_onboarding_link_link_options

{
  "type": "object",
  "title": "TerminalOnboardingLinkLinkOptions",
  "properties": {
    "apple_terms_and_conditions": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/terminal_onboarding_link_apple_terms_and_conditions"
        }
      ],
      "nullable": true,
      "description": "The options associated with the Apple Terms and Conditions link type."
    }
  },
  "description": "Link type options associated with the current onboarding link object.",
  "x-expandableFields": [
    "apple_terms_and_conditions"
  ]
}

object terminal_reader_reader_resource_cart

{
  "type": "object",
  "title": "TerminalReaderReaderResourceCart",
  "required": [
    "currency",
    "line_items",
    "total"
  ],
  "properties": {
    "tax": {
      "type": "integer",
      "nullable": true,
      "description": "Tax amount for the entire cart. A positive integer in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."
    },
    "total": {
      "type": "integer",
      "description": "Total amount for the entire cart, including tax. A positive integer in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "line_items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/terminal_reader_reader_resource_line_item"
      },
      "description": "List of line items in the cart."
    }
  },
  "description": "Represents a cart to be displayed on the reader",
  "x-expandableFields": [
    "line_items"
  ]
}

object terminal_reader_reader_resource_choice

{
  "type": "object",
  "title": "TerminalReaderReaderResourceChoice",
  "required": [
    "text"
  ],
  "properties": {
    "id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The identifier for the selected choice. Maximum 50 characters."
    },
    "text": {
      "type": "string",
      "maxLength": 5000,
      "description": "The text to be selected. Maximum 30 characters."
    },
    "style": {
      "enum": [
        "primary",
        "secondary"
      ],
      "type": "string",
      "nullable": true,
      "description": "The button style for the choice. Can be `primary` or `secondary`."
    }
  },
  "description": "Choice to be selected on a Reader",
  "x-expandableFields": []
}

object terminal_reader_reader_resource_collect_config

{
  "type": "object",
  "title": "TerminalReaderReaderResourceCollectConfig",
  "properties": {
    "tipping": {
      "$ref": "#/components/schemas/terminal_reader_reader_resource_tipping_config"
    },
    "skip_tipping": {
      "type": "boolean",
      "description": "Override showing a tipping selection screen on this transaction."
    },
    "enable_customer_cancellation": {
      "type": "boolean",
      "description": "Enable customer-initiated cancellation when processing this payment."
    }
  },
  "description": "Represents a per-transaction override of a reader configuration",
  "x-expandableFields": [
    "tipping"
  ]
}

object terminal_reader_reader_resource_collect_inputs_action

{
  "type": "object",
  "title": "TerminalReaderReaderResourceCollectInputsAction",
  "required": [
    "inputs"
  ],
  "properties": {
    "inputs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/terminal_reader_reader_resource_input"
      },
      "description": "List of inputs to be collected."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    }
  },
  "description": "Represents a reader action to collect customer inputs",
  "x-expandableFields": [
    "inputs"
  ]
}

object terminal_reader_reader_resource_collect_payment_method_action

{
  "type": "object",
  "title": "TerminalReaderReaderResourceCollectPaymentMethodAction",
  "required": [
    "payment_intent"
  ],
  "properties": {
    "collect_config": {
      "$ref": "#/components/schemas/terminal_reader_reader_resource_collect_config"
    },
    "payment_intent": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_intent"
        }
      ],
      "description": "Most recent PaymentIntent processed by the reader.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_intent"
          }
        ]
      }
    },
    "payment_method": {
      "$ref": "#/components/schemas/payment_method"
    }
  },
  "description": "Represents a reader action to collect a payment method",
  "x-expandableFields": [
    "collect_config",
    "payment_intent",
    "payment_method"
  ]
}

object terminal_reader_reader_resource_confirm_config

{
  "type": "object",
  "title": "TerminalReaderReaderResourceConfirmConfig",
  "properties": {
    "return_url": {
      "type": "string",
      "maxLength": 5000,
      "description": "If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion."
    }
  },
  "description": "Represents a per-transaction override of a reader configuration",
  "x-expandableFields": []
}

object terminal_reader_reader_resource_confirm_payment_intent_action

{
  "type": "object",
  "title": "TerminalReaderReaderResourceConfirmPaymentIntentAction",
  "required": [
    "payment_intent"
  ],
  "properties": {
    "confirm_config": {
      "$ref": "#/components/schemas/terminal_reader_reader_resource_confirm_config"
    },
    "payment_intent": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_intent"
        }
      ],
      "description": "Most recent PaymentIntent processed by the reader.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_intent"
          }
        ]
      }
    }
  },
  "description": "Represents a reader action to confirm a payment",
  "x-expandableFields": [
    "confirm_config",
    "payment_intent"
  ]
}

object terminal_reader_reader_resource_custom_text

{
  "type": "object",
  "title": "TerminalReaderReaderResourceCustomText",
  "properties": {
    "title": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Customize the default title for this input"
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Customize the default description for this input"
    },
    "skip_button": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Customize the default label for this input's skip button"
    },
    "submit_button": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Customize the default label for this input's submit button"
    }
  },
  "description": "Represents custom text to be displayed when collecting the input using a reader",
  "x-expandableFields": []
}

object terminal_reader_reader_resource_email

{
  "type": "object",
  "title": "TerminalReaderReaderResourceEmail",
  "properties": {
    "value": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The collected email address"
    }
  },
  "description": "Information about a email being collected using a reader",
  "x-expandableFields": []
}

object terminal_reader_reader_resource_input

{
  "type": "object",
  "title": "TerminalReaderReaderResourceInput",
  "required": [
    "type"
  ],
  "properties": {
    "text": {
      "$ref": "#/components/schemas/terminal_reader_reader_resource_text"
    },
    "type": {
      "enum": [
        "email",
        "numeric",
        "phone",
        "selection",
        "signature",
        "text"
      ],
      "type": "string",
      "description": "Type of input being collected."
    },
    "email": {
      "$ref": "#/components/schemas/terminal_reader_reader_resource_email"
    },
    "phone": {
      "$ref": "#/components/schemas/terminal_reader_reader_resource_phone"
    },
    "numeric": {
      "$ref": "#/components/schemas/terminal_reader_reader_resource_numeric"
    },
    "skipped": {
      "type": "boolean",
      "description": "Indicate that this input was skipped by the user."
    },
    "toggles": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/terminal_reader_reader_resource_toggle"
      },
      "nullable": true,
      "description": "List of toggles being collected. Values are present if collection is complete."
    },
    "required": {
      "type": "boolean",
      "nullable": true,
      "description": "Indicate that this input is required, disabling the skip button."
    },
    "selection": {
      "$ref": "#/components/schemas/terminal_reader_reader_resource_selection"
    },
    "signature": {
      "$ref": "#/components/schemas/terminal_reader_reader_resource_signature"
    },
    "custom_text": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/terminal_reader_reader_resource_custom_text"
        }
      ],
      "nullable": true,
      "description": "Default text of input being collected."
    }
  },
  "description": "Represents an input to be collected using the reader",
  "x-expandableFields": [
    "custom_text",
    "email",
    "numeric",
    "phone",
    "selection",
    "signature",
    "text",
    "toggles"
  ]
}

object terminal_reader_reader_resource_line_item

{
  "type": "object",
  "title": "TerminalReaderReaderResourceLineItem",
  "required": [
    "amount",
    "description",
    "quantity"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "The amount of the line item. A positive integer in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."
    },
    "quantity": {
      "type": "integer",
      "description": "The quantity of the line item."
    },
    "description": {
      "type": "string",
      "maxLength": 5000,
      "description": "Description of the line item."
    }
  },
  "description": "Represents a line item to be displayed on the reader",
  "x-expandableFields": []
}

object terminal_reader_reader_resource_numeric

{
  "type": "object",
  "title": "TerminalReaderReaderResourceNumeric",
  "properties": {
    "value": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The collected number"
    }
  },
  "description": "Information about a number being collected using a reader",
  "x-expandableFields": []
}

object terminal_reader_reader_resource_phone

{
  "type": "object",
  "title": "TerminalReaderReaderResourcePhone",
  "properties": {
    "value": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The collected phone number"
    }
  },
  "description": "Information about a phone number being collected using a reader",
  "x-expandableFields": []
}

object terminal_reader_reader_resource_process_config

{
  "type": "object",
  "title": "TerminalReaderReaderResourceProcessConfig",
  "properties": {
    "tipping": {
      "$ref": "#/components/schemas/terminal_reader_reader_resource_tipping_config"
    },
    "return_url": {
      "type": "string",
      "maxLength": 5000,
      "description": "If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion."
    },
    "skip_tipping": {
      "type": "boolean",
      "description": "Override showing a tipping selection screen on this transaction."
    },
    "enable_customer_cancellation": {
      "type": "boolean",
      "description": "Enable customer-initiated cancellation when processing this payment."
    }
  },
  "description": "Represents a per-transaction override of a reader configuration",
  "x-expandableFields": [
    "tipping"
  ]
}

object terminal_reader_reader_resource_process_payment_intent_action

{
  "type": "object",
  "title": "TerminalReaderReaderResourceProcessPaymentIntentAction",
  "required": [
    "payment_intent"
  ],
  "properties": {
    "payment_intent": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_intent"
        }
      ],
      "description": "Most recent PaymentIntent processed by the reader.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_intent"
          }
        ]
      }
    },
    "process_config": {
      "$ref": "#/components/schemas/terminal_reader_reader_resource_process_config"
    }
  },
  "description": "Represents a reader action to process a payment intent",
  "x-expandableFields": [
    "payment_intent",
    "process_config"
  ]
}

object terminal_reader_reader_resource_process_setup_config

{
  "type": "object",
  "title": "TerminalReaderReaderResourceProcessSetupConfig",
  "properties": {
    "enable_customer_cancellation": {
      "type": "boolean",
      "description": "Enable customer-initiated cancellation when processing this SetupIntent."
    }
  },
  "description": "Represents a per-setup override of a reader configuration",
  "x-expandableFields": []
}

object terminal_reader_reader_resource_process_setup_intent_action

{
  "type": "object",
  "title": "TerminalReaderReaderResourceProcessSetupIntentAction",
  "required": [
    "setup_intent"
  ],
  "properties": {
    "setup_intent": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/setup_intent"
        }
      ],
      "description": "Most recent SetupIntent processed by the reader.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/setup_intent"
          }
        ]
      }
    },
    "generated_card": {
      "type": "string",
      "maxLength": 5000,
      "description": "ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod."
    },
    "process_config": {
      "$ref": "#/components/schemas/terminal_reader_reader_resource_process_setup_config"
    }
  },
  "description": "Represents a reader action to process a setup intent",
  "x-expandableFields": [
    "process_config",
    "setup_intent"
  ]
}

object terminal_reader_reader_resource_reader_action

{
  "type": "object",
  "title": "TerminalReaderReaderResourceReaderAction",
  "required": [
    "status",
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "collect_inputs",
        "collect_payment_method",
        "confirm_payment_intent",
        "process_payment_intent",
        "process_setup_intent",
        "refund_payment",
        "set_reader_display"
      ],
      "type": "string",
      "description": "Type of action performed by the reader.",
      "x-stripeBypassValidation": true
    },
    "status": {
      "enum": [
        "failed",
        "in_progress",
        "succeeded"
      ],
      "type": "string",
      "description": "Status of the action performed by the reader."
    },
    "failure_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Failure code, only set if status is `failed`."
    },
    "collect_inputs": {
      "$ref": "#/components/schemas/terminal_reader_reader_resource_collect_inputs_action"
    },
    "refund_payment": {
      "$ref": "#/components/schemas/terminal_reader_reader_resource_refund_payment_action"
    },
    "failure_message": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Detailed failure message, only set if status is `failed`."
    },
    "set_reader_display": {
      "$ref": "#/components/schemas/terminal_reader_reader_resource_set_reader_display_action"
    },
    "process_setup_intent": {
      "$ref": "#/components/schemas/terminal_reader_reader_resource_process_setup_intent_action"
    },
    "collect_payment_method": {
      "$ref": "#/components/schemas/terminal_reader_reader_resource_collect_payment_method_action"
    },
    "confirm_payment_intent": {
      "$ref": "#/components/schemas/terminal_reader_reader_resource_confirm_payment_intent_action"
    },
    "process_payment_intent": {
      "$ref": "#/components/schemas/terminal_reader_reader_resource_process_payment_intent_action"
    }
  },
  "description": "Represents an action performed by the reader",
  "x-expandableFields": [
    "collect_inputs",
    "collect_payment_method",
    "confirm_payment_intent",
    "process_payment_intent",
    "process_setup_intent",
    "refund_payment",
    "set_reader_display"
  ]
}

object terminal_reader_reader_resource_refund_payment_action

{
  "type": "object",
  "title": "TerminalReaderReaderResourceRefundPaymentAction",
  "properties": {
    "amount": {
      "type": "integer",
      "description": "The amount being refunded."
    },
    "charge": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/charge"
        }
      ],
      "description": "Charge that is being refunded.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/charge"
          }
        ]
      }
    },
    "reason": {
      "enum": [
        "duplicate",
        "fraudulent",
        "requested_by_customer"
      ],
      "type": "string",
      "description": "The reason for the refund."
    },
    "refund": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/refund"
        }
      ],
      "description": "Unique identifier for the refund object.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/refund"
          }
        ]
      }
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "payment_intent": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/payment_intent"
        }
      ],
      "description": "Payment intent that is being refunded.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/payment_intent"
          }
        ]
      }
    },
    "reverse_transfer": {
      "type": "boolean",
      "description": "Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge."
    },
    "refund_payment_config": {
      "$ref": "#/components/schemas/terminal_reader_reader_resource_refund_payment_config"
    },
    "refund_application_fee": {
      "type": "boolean",
      "description": "Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge."
    }
  },
  "description": "Represents a reader action to refund a payment",
  "x-expandableFields": [
    "charge",
    "payment_intent",
    "refund",
    "refund_payment_config"
  ]
}

object terminal_reader_reader_resource_refund_payment_config

{
  "type": "object",
  "title": "TerminalReaderReaderResourceRefundPaymentConfig",
  "properties": {
    "enable_customer_cancellation": {
      "type": "boolean",
      "description": "Enable customer-initiated cancellation when refunding this payment."
    }
  },
  "description": "Represents a per-transaction override of a reader configuration",
  "x-expandableFields": []
}

object terminal_reader_reader_resource_selection

{
  "type": "object",
  "title": "TerminalReaderReaderResourceSelection",
  "required": [
    "choices"
  ],
  "properties": {
    "id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The id of the selected choice"
    },
    "text": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The text of the selected choice"
    },
    "choices": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/terminal_reader_reader_resource_choice"
      },
      "description": "List of possible choices to be selected"
    }
  },
  "description": "Information about a selection being collected using a reader",
  "x-expandableFields": [
    "choices"
  ]
}

object terminal_reader_reader_resource_set_reader_display_action

{
  "type": "object",
  "title": "TerminalReaderReaderResourceSetReaderDisplayAction",
  "required": [
    "type"
  ],
  "properties": {
    "cart": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/terminal_reader_reader_resource_cart"
        }
      ],
      "nullable": true,
      "description": "Cart object to be displayed by the reader, including line items, amounts, and currency."
    },
    "type": {
      "enum": [
        "cart"
      ],
      "type": "string",
      "description": "Type of information to be displayed by the reader. Only `cart` is currently supported."
    }
  },
  "description": "Represents a reader action to set the reader display",
  "x-expandableFields": [
    "cart"
  ]
}

object terminal_reader_reader_resource_signature

{
  "type": "object",
  "title": "TerminalReaderReaderResourceSignature",
  "properties": {
    "value": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The File ID of a collected signature image"
    }
  },
  "description": "Information about a signature being collected using a reader",
  "x-expandableFields": []
}

object terminal_reader_reader_resource_text

{
  "type": "object",
  "title": "TerminalReaderReaderResourceText",
  "properties": {
    "value": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The collected text value"
    }
  },
  "description": "Information about text being collected using a reader",
  "x-expandableFields": []
}

object terminal_reader_reader_resource_tipping_config

{
  "type": "object",
  "title": "TerminalReaderReaderResourceTippingConfig",
  "properties": {
    "amount_eligible": {
      "type": "integer",
      "description": "Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency)."
    }
  },
  "description": "Represents a per-transaction tipping configuration",
  "x-expandableFields": []
}

object terminal_reader_reader_resource_toggle

{
  "type": "object",
  "title": "TerminalReaderReaderResourceToggle",
  "properties": {
    "title": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The toggle's title text. Maximum 50 characters."
    },
    "value": {
      "enum": [
        "disabled",
        "enabled"
      ],
      "type": "string",
      "nullable": true,
      "description": "The toggle's collected value. Can be `enabled` or `disabled`."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The toggle's description text. Maximum 50 characters."
    },
    "default_value": {
      "enum": [
        "disabled",
        "enabled"
      ],
      "type": "string",
      "nullable": true,
      "description": "The toggle's default value. Can be `enabled` or `disabled`."
    }
  },
  "description": "Information about an input's toggle",
  "x-expandableFields": []
}

object test_helpers.test_clock

{
  "type": "object",
  "title": "TestClock",
  "required": [
    "created",
    "deletes_after",
    "frozen_time",
    "id",
    "livemode",
    "object",
    "status",
    "status_details"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The custom name supplied at creation."
    },
    "object": {
      "enum": [
        "test_helpers.test_clock"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "advancing",
        "internal_failure",
        "ready"
      ],
      "type": "string",
      "description": "The status of the Test Clock."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "frozen_time": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which all objects belonging to this clock are frozen."
    },
    "deletes_after": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which this clock is scheduled to auto delete."
    },
    "status_details": {
      "$ref": "#/components/schemas/billing_clocks_resource_status_details_status_details"
    }
  },
  "description": "A test clock enables deterministic control over objects in testmode. With a test clock, you can create\nobjects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances,\nyou can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time.",
  "x-resourceId": "test_helpers.test_clock",
  "x-expandableFields": [
    "status_details"
  ]
}

object three_d_secure_details

{
  "type": "object",
  "title": "three_d_secure_details",
  "properties": {
    "result": {
      "enum": [
        "attempt_acknowledged",
        "authenticated",
        "exempted",
        "failed",
        "not_supported",
        "processing_error"
      ],
      "type": "string",
      "nullable": true,
      "description": "Indicates the outcome of 3D Secure authentication."
    },
    "version": {
      "enum": [
        "1.0.2",
        "2.1.0",
        "2.2.0",
        "2.3.0",
        "2.3.1"
      ],
      "type": "string",
      "nullable": true,
      "description": "The version of 3D Secure that was used.",
      "x-stripeBypassValidation": true
    },
    "result_reason": {
      "enum": [
        "abandoned",
        "bypassed",
        "canceled",
        "card_not_enrolled",
        "network_not_supported",
        "protocol_error",
        "rejected"
      ],
      "type": "string",
      "nullable": true,
      "description": "Additional information about why 3D Secure succeeded or failed based\non the `result`."
    },
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID\n(dsTransId) for this payment."
    },
    "authentication_flow": {
      "enum": [
        "challenge",
        "frictionless"
      ],
      "type": "string",
      "nullable": true,
      "description": "For authenticated transactions: how the customer was authenticated by\nthe issuing bank."
    },
    "electronic_commerce_indicator": {
      "enum": [
        "01",
        "02",
        "05",
        "06",
        "07"
      ],
      "type": "string",
      "nullable": true,
      "description": "The Electronic Commerce Indicator (ECI). A protocol-level field\nindicating what degree of authentication was performed.",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": []
}

object three_d_secure_details_charge

{
  "type": "object",
  "title": "three_d_secure_details_charge",
  "properties": {
    "result": {
      "enum": [
        "attempt_acknowledged",
        "authenticated",
        "exempted",
        "failed",
        "not_supported",
        "processing_error"
      ],
      "type": "string",
      "nullable": true,
      "description": "Indicates the outcome of 3D Secure authentication."
    },
    "version": {
      "enum": [
        "1.0.2",
        "2.1.0",
        "2.2.0",
        "2.3.0",
        "2.3.1"
      ],
      "type": "string",
      "nullable": true,
      "description": "The version of 3D Secure that was used.",
      "x-stripeBypassValidation": true
    },
    "result_reason": {
      "enum": [
        "abandoned",
        "bypassed",
        "canceled",
        "card_not_enrolled",
        "network_not_supported",
        "protocol_error",
        "rejected"
      ],
      "type": "string",
      "nullable": true,
      "description": "Additional information about why 3D Secure succeeded or failed based\non the `result`."
    },
    "transaction_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID\n(dsTransId) for this payment."
    },
    "authentication_flow": {
      "enum": [
        "challenge",
        "frictionless"
      ],
      "type": "string",
      "nullable": true,
      "description": "For authenticated transactions: how the customer was authenticated by\nthe issuing bank."
    },
    "exemption_indicator": {
      "enum": [
        "low_risk",
        "none"
      ],
      "type": "string",
      "nullable": true,
      "description": "The exemption requested via 3DS and accepted by the issuer at authentication time."
    },
    "exemption_indicator_applied": {
      "type": "boolean",
      "description": "Whether Stripe requested the value of `exemption_indicator` in the transaction. This will depend on\nthe outcome of Stripe's internal risk assessment."
    },
    "electronic_commerce_indicator": {
      "enum": [
        "01",
        "02",
        "05",
        "06",
        "07"
      ],
      "type": "string",
      "nullable": true,
      "description": "The Electronic Commerce Indicator (ECI). A protocol-level field\nindicating what degree of authentication was performed.",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": []
}

object three_d_secure_usage

{
  "type": "object",
  "title": "three_d_secure_usage",
  "required": [
    "supported"
  ],
  "properties": {
    "supported": {
      "type": "boolean",
      "description": "Whether 3D Secure is supported on this card."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object thresholds_resource_usage_alert_filter

{
  "type": "object",
  "title": "ThresholdsResourceUsageAlertFilter",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "customer"
      ],
      "type": "string"
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        }
      ],
      "nullable": true,
      "description": "Limit the scope of the alert to this customer ID",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "customer"
  ]
}

object thresholds_resource_usage_threshold_config

{
  "type": "object",
  "title": "ThresholdsResourceUsageThresholdConfig",
  "required": [
    "gte",
    "meter",
    "recurrence"
  ],
  "properties": {
    "gte": {
      "type": "integer",
      "description": "The value at which this alert will trigger."
    },
    "meter": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/billing.meter"
        }
      ],
      "description": "The [Billing Meter](/api/billing/meter) ID whose usage is monitored.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/billing.meter"
          }
        ]
      }
    },
    "filters": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/thresholds_resource_usage_alert_filter"
      },
      "nullable": true,
      "description": "The filters allow limiting the scope of this usage alert. You can only specify up to one filter at this time."
    },
    "recurrence": {
      "enum": [
        "one_time"
      ],
      "type": "string",
      "description": "Defines how the alert will behave.",
      "x-stripeBypassValidation": true
    }
  },
  "description": "The usage threshold alert configuration enables setting up alerts for when a certain usage threshold on a specific meter is crossed.",
  "x-expandableFields": [
    "filters",
    "meter"
  ]
}

object token

{
  "type": "object",
  "title": "Token",
  "required": [
    "created",
    "id",
    "livemode",
    "object",
    "type",
    "used"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "card": {
      "$ref": "#/components/schemas/card"
    },
    "type": {
      "type": "string",
      "maxLength": 5000,
      "description": "Type of the token: `account`, `bank_account`, `card`, or `pii`."
    },
    "used": {
      "type": "boolean",
      "description": "Determines if you have already used this token (you can only use tokens once)."
    },
    "object": {
      "enum": [
        "token"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "client_ip": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "IP address of the client that generates the token."
    },
    "bank_account": {
      "$ref": "#/components/schemas/bank_account"
    }
  },
  "description": "Tokenization is the process Stripe uses to collect sensitive card or bank\naccount details, or personally identifiable information (PII), directly from\nyour customers in a secure manner. A token representing this information is\nreturned to your server to use. Use our\n[recommended payments integrations](https://docs.stripe.com/payments) to perform this process\non the client-side. This guarantees that no sensitive card data touches your server,\nand allows your integration to operate in a PCI-compliant way.\n\nIf you can't use client-side tokenization, you can also create tokens using\nthe API with either your publishable or secret API key. If\nyour integration uses this method, you're responsible for any PCI compliance\nthat it might require, and you must keep your secret API key safe. Unlike with\nclient-side tokenization, your customer's information isn't sent directly to\nStripe, so we can't determine how it's handled or stored.\n\nYou can't store or use tokens more than once. To store card or bank account\ninformation for later use, create [Customer](https://docs.stripe.com/api#customers)\nobjects or [External accounts](/api#external_accounts).\n[Radar](https://docs.stripe.com/radar), our integrated solution for automatic fraud protection,\nperforms best with integrations that use client-side tokenization.",
  "x-resourceId": "token",
  "x-expandableFields": [
    "bank_account",
    "card"
  ]
}

object token_card_networks

{
  "type": "object",
  "title": "token_card_networks",
  "properties": {
    "preferred": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object topup

{
  "type": "object",
  "title": "Topup",
  "required": [
    "amount",
    "created",
    "currency",
    "id",
    "livemode",
    "metadata",
    "object",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "amount": {
      "type": "integer",
      "description": "Amount transferred."
    },
    "object": {
      "enum": [
        "topup"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "source": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/source"
        }
      ],
      "nullable": true,
      "description": "The source field is deprecated. It might not always be present in the API response."
    },
    "status": {
      "enum": [
        "canceled",
        "failed",
        "pending",
        "reversed",
        "succeeded"
      ],
      "type": "string",
      "description": "The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "currency": {
      "type": "string",
      "maxLength": 5000,
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An arbitrary string attached to the object. Often useful for displaying to users."
    },
    "failure_code": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Error code explaining reason for top-up failure if available (see [the errors section](/api/errors) for a list of codes)."
    },
    "transfer_group": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A string that identifies this top-up as part of a group."
    },
    "failure_message": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Message to user further explaining reason for top-up failure if available."
    },
    "balance_transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/balance_transaction"
        }
      ],
      "nullable": true,
      "description": "ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/balance_transaction"
          }
        ]
      }
    },
    "statement_descriptor": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter."
    },
    "expected_availability_date": {
      "type": "integer",
      "nullable": true,
      "description": "Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up."
    }
  },
  "description": "To top up your Stripe balance, you create a top-up object. You can retrieve\nindividual top-ups, as well as list all top-ups. Top-ups are identified by a\nunique, random ID.\n\nRelated guide: [Topping up your platform account](https://docs.stripe.com/connect/top-ups)",
  "x-resourceId": "topup",
  "x-expandableFields": [
    "balance_transaction",
    "source"
  ]
}

object transfer

{
  "type": "object",
  "title": "Transfer",
  "required": [
    "amount",
    "amount_reversed",
    "created",
    "currency",
    "id",
    "livemode",
    "metadata",
    "object",
    "reversals",
    "reversed"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "amount": {
      "type": "integer",
      "description": "Amount in cents (or local equivalent) to be transferred."
    },
    "object": {
      "enum": [
        "transfer"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time that this record of the transfer was first created."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "reversed": {
      "type": "boolean",
      "description": "Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false."
    },
    "reversals": {
      "type": "object",
      "title": "TransferReversalList",
      "required": [
        "data",
        "has_more",
        "object",
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "maxLength": 5000,
          "description": "The URL where this list can be accessed."
        },
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/transfer_reversal"
          },
          "description": "Details about each object."
        },
        "object": {
          "enum": [
            "list"
          ],
          "type": "string",
          "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
        },
        "has_more": {
          "type": "boolean",
          "description": "True if this list has another page of items after this one that can be fetched."
        }
      },
      "description": "A list of reversals that have been applied to the transfer.",
      "x-expandableFields": [
        "data"
      ]
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An arbitrary string attached to the object. Often useful for displaying to users."
    },
    "destination": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/account"
        }
      ],
      "nullable": true,
      "description": "ID of the Stripe account the transfer was sent to.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/account"
          }
        ]
      }
    },
    "source_type": {
      "type": "string",
      "maxLength": 5000,
      "description": "The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`."
    },
    "transfer_group": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A string that identifies this transaction as part of a group. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details."
    },
    "amount_reversed": {
      "type": "integer",
      "description": "Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued)."
    },
    "source_transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/charge"
        }
      ],
      "nullable": true,
      "description": "ID of the charge that was used to fund the transfer. If null, the transfer was funded from the available balance.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/charge"
          }
        ]
      }
    },
    "balance_transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/balance_transaction"
        }
      ],
      "nullable": true,
      "description": "Balance transaction that describes the impact of this transfer on your account balance.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/balance_transaction"
          }
        ]
      }
    },
    "destination_payment": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/charge"
        }
      ],
      "description": "If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/charge"
          }
        ]
      }
    }
  },
  "description": "A `Transfer` object is created when you move funds between Stripe accounts as\npart of Connect.\n\nBefore April 6, 2017, transfers also represented movement of funds from a\nStripe account to a card or bank account. This behavior has since been split\nout into a [Payout](https://api.stripe.com#payout_object) object, with corresponding payout endpoints. For more\ninformation, read about the\n[transfer/payout split](https://docs.stripe.com/transfer-payout-split).\n\nRelated guide: [Creating separate charges and transfers](https://docs.stripe.com/connect/separate-charges-and-transfers)",
  "x-resourceId": "transfer",
  "x-expandableFields": [
    "balance_transaction",
    "destination",
    "destination_payment",
    "reversals",
    "source_transaction"
  ]
}

object transfer_data

{
  "type": "object",
  "title": "transfer_data",
  "required": [
    "destination"
  ],
  "properties": {
    "amount": {
      "type": "integer",
      "description": "The amount transferred to the destination account. This transfer will occur automatically after the payment succeeds. If no amount is specified, by default the entire payment amount is transferred to the destination account.\n The amount must be less than or equal to the [amount](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-amount), and must be a positive integer\n representing how much to transfer in the smallest currency unit (e.g., 100 cents to charge $1.00)."
    },
    "destination": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/account"
        }
      ],
      "description": "The account (if any) that the payment is attributed to for tax reporting, and where funds from the payment are transferred to after payment success.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/account"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "destination"
  ]
}

object transfer_reversal

{
  "type": "object",
  "title": "TransferReversal",
  "required": [
    "amount",
    "created",
    "currency",
    "id",
    "object",
    "transfer"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "amount": {
      "type": "integer",
      "description": "Amount, in cents (or local equivalent)."
    },
    "object": {
      "enum": [
        "transfer_reversal"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "transfer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/transfer"
        }
      ],
      "description": "ID of the transfer that was reversed.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/transfer"
          }
        ]
      }
    },
    "source_refund": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/refund"
        }
      ],
      "nullable": true,
      "description": "ID of the refund responsible for the transfer reversal.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/refund"
          }
        ]
      }
    },
    "balance_transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/balance_transaction"
        }
      ],
      "nullable": true,
      "description": "Balance transaction that describes the impact on your account balance.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/balance_transaction"
          }
        ]
      }
    },
    "destination_payment_refund": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/refund"
        }
      ],
      "nullable": true,
      "description": "Linked payment refund for the transfer reversal.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/refund"
          }
        ]
      }
    }
  },
  "description": "[Stripe Connect](https://docs.stripe.com/connect) platforms can reverse transfers made to a\nconnected account, either entirely or partially, and can also specify whether\nto refund any related application fees. Transfer reversals add to the\nplatform's balance and subtract from the destination account's balance.\n\nReversing a transfer that was made for a [destination\ncharge](/docs/connect/destination-charges) is allowed only up to the amount of\nthe charge. It is possible to reverse a\n[transfer_group](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options)\ntransfer only if the destination account has enough balance to cover the\nreversal.\n\nRelated guide: [Reverse transfers](https://docs.stripe.com/connect/separate-charges-and-transfers#reverse-transfers)",
  "x-resourceId": "transfer_reversal",
  "x-expandableFields": [
    "balance_transaction",
    "destination_payment_refund",
    "source_refund",
    "transfer"
  ]
}

object transfer_schedule

{
  "type": "object",
  "title": "TransferSchedule",
  "required": [
    "delay_days",
    "interval"
  ],
  "properties": {
    "interval": {
      "type": "string",
      "maxLength": 5000,
      "description": "How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`."
    },
    "delay_days": {
      "type": "integer",
      "description": "The number of days charges for the account will be held before being paid out."
    },
    "weekly_anchor": {
      "type": "string",
      "maxLength": 5000,
      "description": "The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown if `interval` is weekly."
    },
    "monthly_anchor": {
      "type": "integer",
      "description": "The day of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months."
    },
    "weekly_payout_days": {
      "type": "array",
      "items": {
        "enum": [
          "friday",
          "monday",
          "thursday",
          "tuesday",
          "wednesday"
        ],
        "type": "string",
        "x-stripeBypassValidation": true
      },
      "description": "The days of the week when available funds are paid out, specified as an array, for example, [`monday`, `tuesday`]. Only shown if `interval` is weekly."
    },
    "monthly_payout_days": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "The days of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object transform_quantity

{
  "type": "object",
  "title": "TransformQuantity",
  "required": [
    "divide_by",
    "round"
  ],
  "properties": {
    "round": {
      "enum": [
        "down",
        "up"
      ],
      "type": "string",
      "description": "After division, either round the result `up` or `down`."
    },
    "divide_by": {
      "type": "integer",
      "description": "Divide usage by this number."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object transform_usage

{
  "type": "object",
  "title": "TransformUsage",
  "required": [
    "divide_by",
    "round"
  ],
  "properties": {
    "round": {
      "enum": [
        "down",
        "up"
      ],
      "type": "string",
      "description": "After division, either round the result `up` or `down`."
    },
    "divide_by": {
      "type": "integer",
      "description": "Divide usage by this number."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object treasury.credit_reversal

{
  "type": "object",
  "title": "TreasuryReceivedCreditsResourceCreditReversal",
  "required": [
    "amount",
    "created",
    "currency",
    "financial_account",
    "id",
    "livemode",
    "metadata",
    "network",
    "object",
    "received_credit",
    "status",
    "status_transitions"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "amount": {
      "type": "integer",
      "description": "Amount (in cents) transferred."
    },
    "object": {
      "enum": [
        "treasury.credit_reversal"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "canceled",
        "posted",
        "processing"
      ],
      "type": "string",
      "description": "Status of the CreditReversal"
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "network": {
      "enum": [
        "ach",
        "stripe"
      ],
      "type": "string",
      "description": "The rails used to reverse the funds."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/treasury.transaction"
        }
      ],
      "nullable": true,
      "description": "The Transaction associated with this object.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/treasury.transaction"
          }
        ]
      }
    },
    "received_credit": {
      "type": "string",
      "maxLength": 5000,
      "description": "The ReceivedCredit being reversed."
    },
    "financial_account": {
      "type": "string",
      "maxLength": 5000,
      "description": "The FinancialAccount to reverse funds from."
    },
    "status_transitions": {
      "$ref": "#/components/schemas/treasury_received_credits_resource_status_transitions"
    },
    "hosted_regulatory_receipt_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses."
    }
  },
  "description": "You can reverse some [ReceivedCredits](https://api.stripe.com#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.",
  "x-resourceId": "treasury.credit_reversal",
  "x-expandableFields": [
    "status_transitions",
    "transaction"
  ]
}

object treasury.debit_reversal

{
  "type": "object",
  "title": "TreasuryReceivedDebitsResourceDebitReversal",
  "required": [
    "amount",
    "created",
    "currency",
    "id",
    "livemode",
    "metadata",
    "network",
    "object",
    "received_debit",
    "status",
    "status_transitions"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "amount": {
      "type": "integer",
      "description": "Amount (in cents) transferred."
    },
    "object": {
      "enum": [
        "treasury.debit_reversal"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "failed",
        "processing",
        "succeeded"
      ],
      "type": "string",
      "description": "Status of the DebitReversal"
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "network": {
      "enum": [
        "ach",
        "card"
      ],
      "type": "string",
      "description": "The rails used to reverse the funds."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/treasury.transaction"
        }
      ],
      "nullable": true,
      "description": "The Transaction associated with this object.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/treasury.transaction"
          }
        ]
      }
    },
    "linked_flows": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/treasury_received_debits_resource_debit_reversal_linked_flows"
        }
      ],
      "nullable": true,
      "description": "Other flows linked to a DebitReversal."
    },
    "received_debit": {
      "type": "string",
      "maxLength": 5000,
      "description": "The ReceivedDebit being reversed."
    },
    "financial_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The FinancialAccount to reverse funds from."
    },
    "status_transitions": {
      "$ref": "#/components/schemas/treasury_received_debits_resource_status_transitions"
    },
    "hosted_regulatory_receipt_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses."
    }
  },
  "description": "You can reverse some [ReceivedDebits](https://api.stripe.com#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal.",
  "x-resourceId": "treasury.debit_reversal",
  "x-expandableFields": [
    "linked_flows",
    "status_transitions",
    "transaction"
  ]
}

object treasury.financial_account

{
  "type": "object",
  "title": "TreasuryFinancialAccountsResourceFinancialAccount",
  "required": [
    "balance",
    "country",
    "created",
    "financial_addresses",
    "id",
    "livemode",
    "object",
    "status",
    "status_details",
    "supported_currencies"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "treasury.financial_account"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "closed",
        "open"
      ],
      "type": "string",
      "description": "Status of this FinancialAccount.",
      "x-stripeBypassValidation": true
    },
    "balance": {
      "$ref": "#/components/schemas/treasury_financial_accounts_resource_balance"
    },
    "country": {
      "type": "string",
      "maxLength": 5000,
      "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "features": {
      "$ref": "#/components/schemas/treasury.financial_account_features"
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "nickname": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The nickname for the FinancialAccount."
    },
    "is_default": {
      "type": "boolean"
    },
    "status_details": {
      "$ref": "#/components/schemas/treasury_financial_accounts_resource_status_details"
    },
    "active_features": {
      "type": "array",
      "items": {
        "enum": [
          "card_issuing",
          "deposit_insurance",
          "financial_addresses.aba",
          "financial_addresses.aba.forwarding",
          "inbound_transfers.ach",
          "intra_stripe_flows",
          "outbound_payments.ach",
          "outbound_payments.us_domestic_wire",
          "outbound_transfers.ach",
          "outbound_transfers.us_domestic_wire",
          "remote_deposit_capture"
        ],
        "type": "string",
        "x-stripeBypassValidation": true
      },
      "description": "The array of paths to active Features in the Features hash."
    },
    "pending_features": {
      "type": "array",
      "items": {
        "enum": [
          "card_issuing",
          "deposit_insurance",
          "financial_addresses.aba",
          "financial_addresses.aba.forwarding",
          "inbound_transfers.ach",
          "intra_stripe_flows",
          "outbound_payments.ach",
          "outbound_payments.us_domestic_wire",
          "outbound_transfers.ach",
          "outbound_transfers.us_domestic_wire",
          "remote_deposit_capture"
        ],
        "type": "string",
        "x-stripeBypassValidation": true
      },
      "description": "The array of paths to pending Features in the Features hash."
    },
    "financial_addresses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/treasury_financial_accounts_resource_financial_address"
      },
      "description": "The set of credentials that resolve to a FinancialAccount."
    },
    "restricted_features": {
      "type": "array",
      "items": {
        "enum": [
          "card_issuing",
          "deposit_insurance",
          "financial_addresses.aba",
          "financial_addresses.aba.forwarding",
          "inbound_transfers.ach",
          "intra_stripe_flows",
          "outbound_payments.ach",
          "outbound_payments.us_domestic_wire",
          "outbound_transfers.ach",
          "outbound_transfers.us_domestic_wire",
          "remote_deposit_capture"
        ],
        "type": "string",
        "x-stripeBypassValidation": true
      },
      "description": "The array of paths to restricted Features in the Features hash."
    },
    "supported_currencies": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The currencies the FinancialAccount can hold a balance in. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase."
    },
    "platform_restrictions": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/treasury_financial_accounts_resource_platform_restrictions"
        }
      ],
      "nullable": true,
      "description": "The set of functionalities that the platform can restrict on the FinancialAccount."
    }
  },
  "description": "Stripe Treasury provides users with a container for money called a FinancialAccount that is separate from their Payments balance.\nFinancialAccounts serve as the source and destination of Treasury’s money movement APIs.",
  "x-resourceId": "treasury.financial_account",
  "x-expandableFields": [
    "balance",
    "features",
    "financial_addresses",
    "platform_restrictions",
    "status_details"
  ]
}

object treasury.financial_account_features

{
  "type": "object",
  "title": "TreasuryFinancialAccountsResourceFinancialAccountFeatures",
  "required": [
    "object"
  ],
  "properties": {
    "object": {
      "enum": [
        "treasury.financial_account_features"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "card_issuing": {
      "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggle_settings"
    },
    "deposit_insurance": {
      "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggle_settings"
    },
    "inbound_transfers": {
      "$ref": "#/components/schemas/treasury_financial_accounts_resource_inbound_transfers"
    },
    "outbound_payments": {
      "$ref": "#/components/schemas/treasury_financial_accounts_resource_outbound_payments"
    },
    "intra_stripe_flows": {
      "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggle_settings"
    },
    "outbound_transfers": {
      "$ref": "#/components/schemas/treasury_financial_accounts_resource_outbound_transfers"
    },
    "financial_addresses": {
      "$ref": "#/components/schemas/treasury_financial_accounts_resource_financial_addresses_features"
    }
  },
  "description": "Encodes whether a FinancialAccount has access to a particular Feature, with a `status` enum and associated `status_details`.\nStripe or the platform can control Features via the requested field.",
  "x-resourceId": "treasury.financial_account_features",
  "x-expandableFields": [
    "card_issuing",
    "deposit_insurance",
    "financial_addresses",
    "inbound_transfers",
    "intra_stripe_flows",
    "outbound_payments",
    "outbound_transfers"
  ]
}

object treasury.inbound_transfer

{
  "type": "object",
  "title": "TreasuryInboundTransfersResourceInboundTransfer",
  "required": [
    "amount",
    "cancelable",
    "created",
    "currency",
    "financial_account",
    "id",
    "linked_flows",
    "livemode",
    "metadata",
    "object",
    "statement_descriptor",
    "status",
    "status_transitions"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "amount": {
      "type": "integer",
      "description": "Amount (in cents) transferred."
    },
    "object": {
      "enum": [
        "treasury.inbound_transfer"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "canceled",
        "failed",
        "processing",
        "succeeded"
      ],
      "type": "string",
      "description": "Status of the InboundTransfer: `processing`, `succeeded`, `failed`, and `canceled`. An InboundTransfer is `processing` if it is created and pending. The status changes to `succeeded` once the funds have been \"confirmed\" and a `transaction` is created and posted. The status changes to `failed` if the transfer fails.",
      "x-stripeBypassValidation": true
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "returned": {
      "type": "boolean",
      "nullable": true,
      "description": "Returns `true` if the funds for an InboundTransfer were returned after the InboundTransfer went to the `succeeded` state."
    },
    "cancelable": {
      "type": "boolean",
      "description": "Returns `true` if the InboundTransfer is able to be canceled."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An arbitrary string attached to the object. Often useful for displaying to users."
    },
    "transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/treasury.transaction"
        }
      ],
      "nullable": true,
      "description": "The Transaction associated with this object.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/treasury.transaction"
          }
        ]
      }
    },
    "linked_flows": {
      "$ref": "#/components/schemas/treasury_inbound_transfers_resource_inbound_transfer_resource_linked_flows"
    },
    "failure_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/treasury_inbound_transfers_resource_failure_details"
        }
      ],
      "nullable": true,
      "description": "Details about this InboundTransfer's failure. Only set when status is `failed`."
    },
    "financial_account": {
      "type": "string",
      "maxLength": 5000,
      "description": "The FinancialAccount that received the funds."
    },
    "status_transitions": {
      "$ref": "#/components/schemas/treasury_inbound_transfers_resource_inbound_transfer_resource_status_transitions"
    },
    "statement_descriptor": {
      "type": "string",
      "maxLength": 5000,
      "description": "Statement descriptor shown when funds are debited from the source. Not all payment networks support `statement_descriptor`."
    },
    "origin_payment_method": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The origin payment method to be debited for an InboundTransfer."
    },
    "hosted_regulatory_receipt_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses."
    },
    "origin_payment_method_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/inbound_transfers"
        }
      ],
      "nullable": true,
      "description": "Details about the PaymentMethod for an InboundTransfer."
    }
  },
  "description": "Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://api.stripe.com#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.\n\nRelated guide: [Moving money with Treasury using InboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers)",
  "x-resourceId": "treasury.inbound_transfer",
  "x-expandableFields": [
    "failure_details",
    "linked_flows",
    "origin_payment_method_details",
    "status_transitions",
    "transaction"
  ]
}

object treasury.outbound_payment

{
  "type": "object",
  "title": "TreasuryOutboundPaymentsResourceOutboundPayment",
  "required": [
    "amount",
    "cancelable",
    "created",
    "currency",
    "expected_arrival_date",
    "financial_account",
    "id",
    "livemode",
    "metadata",
    "object",
    "statement_descriptor",
    "status",
    "status_transitions",
    "transaction"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "amount": {
      "type": "integer",
      "description": "Amount (in cents) transferred."
    },
    "object": {
      "enum": [
        "treasury.outbound_payment"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "canceled",
        "failed",
        "posted",
        "processing",
        "returned"
      ],
      "type": "string",
      "description": "Current status of the OutboundPayment: `processing`, `failed`, `posted`, `returned`, `canceled`. An OutboundPayment is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundPayment has been \"confirmed\" and funds have left the account, or to `failed` or `canceled`. If an OutboundPayment fails to arrive at its destination, its status will change to `returned`."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "customer": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the [customer](https://docs.stripe.com/api/customers) to whom an OutboundPayment is sent."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "cancelable": {
      "type": "boolean",
      "description": "Returns `true` if the object can be canceled, and `false` otherwise."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An arbitrary string attached to the object. Often useful for displaying to users."
    },
    "transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/treasury.transaction"
        }
      ],
      "description": "The Transaction associated with this object.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/treasury.transaction"
          }
        ]
      }
    },
    "end_user_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/treasury_outbound_payments_resource_outbound_payment_resource_end_user_details"
        }
      ],
      "nullable": true,
      "description": "Details about the end user."
    },
    "returned_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/treasury_outbound_payments_resource_returned_status"
        }
      ],
      "nullable": true,
      "description": "Details about a returned OutboundPayment. Only set when the status is `returned`."
    },
    "tracking_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/treasury_outbound_payments_resource_outbound_payment_resource_tracking_details"
        }
      ],
      "nullable": true,
      "description": "Details about network-specific tracking information if available."
    },
    "financial_account": {
      "type": "string",
      "maxLength": 5000,
      "description": "The FinancialAccount that funds were pulled from."
    },
    "status_transitions": {
      "$ref": "#/components/schemas/treasury_outbound_payments_resource_outbound_payment_resource_status_transitions"
    },
    "statement_descriptor": {
      "type": "string",
      "maxLength": 5000,
      "description": "The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer)."
    },
    "expected_arrival_date": {
      "type": "integer",
      "format": "unix-time",
      "description": "The date when funds are expected to arrive in the destination account."
    },
    "destination_payment_method": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using `destination_payment_method_data`."
    },
    "hosted_regulatory_receipt_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses."
    },
    "destination_payment_method_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/outbound_payments_payment_method_details"
        }
      ],
      "nullable": true,
      "description": "Details about the PaymentMethod for an OutboundPayment."
    }
  },
  "description": "Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://api.stripe.com#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://api.stripe.com#outbound_transfers).\n\nSimulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.\n\nRelated guide: [Moving money with Treasury using OutboundPayment objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments)",
  "x-resourceId": "treasury.outbound_payment",
  "x-expandableFields": [
    "destination_payment_method_details",
    "end_user_details",
    "returned_details",
    "status_transitions",
    "tracking_details",
    "transaction"
  ]
}

object treasury.outbound_transfer

{
  "type": "object",
  "title": "TreasuryOutboundTransfersResourceOutboundTransfer",
  "required": [
    "amount",
    "cancelable",
    "created",
    "currency",
    "destination_payment_method_details",
    "expected_arrival_date",
    "financial_account",
    "id",
    "livemode",
    "metadata",
    "object",
    "statement_descriptor",
    "status",
    "status_transitions",
    "transaction"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "amount": {
      "type": "integer",
      "description": "Amount (in cents) transferred."
    },
    "object": {
      "enum": [
        "treasury.outbound_transfer"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "canceled",
        "failed",
        "posted",
        "processing",
        "returned"
      ],
      "type": "string",
      "description": "Current status of the OutboundTransfer: `processing`, `failed`, `canceled`, `posted`, `returned`. An OutboundTransfer is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundTransfer has been \"confirmed\" and funds have left the account, or to `failed` or `canceled`. If an OutboundTransfer fails to arrive at its destination, its status will change to `returned`."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "cancelable": {
      "type": "boolean",
      "description": "Returns `true` if the object can be canceled, and `false` otherwise."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An arbitrary string attached to the object. Often useful for displaying to users."
    },
    "transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/treasury.transaction"
        }
      ],
      "description": "The Transaction associated with this object.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/treasury.transaction"
          }
        ]
      }
    },
    "returned_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/treasury_outbound_transfers_resource_returned_details"
        }
      ],
      "nullable": true,
      "description": "Details about a returned OutboundTransfer. Only set when the status is `returned`."
    },
    "tracking_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/treasury_outbound_transfers_resource_outbound_transfer_resource_tracking_details"
        }
      ],
      "nullable": true,
      "description": "Details about network-specific tracking information if available."
    },
    "financial_account": {
      "type": "string",
      "maxLength": 5000,
      "description": "The FinancialAccount that funds were pulled from."
    },
    "status_transitions": {
      "$ref": "#/components/schemas/treasury_outbound_transfers_resource_status_transitions"
    },
    "statement_descriptor": {
      "type": "string",
      "maxLength": 5000,
      "description": "Information about the OutboundTransfer to be sent to the recipient account."
    },
    "expected_arrival_date": {
      "type": "integer",
      "format": "unix-time",
      "description": "The date when funds are expected to arrive in the destination account."
    },
    "destination_payment_method": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The PaymentMethod used as the payment instrument for an OutboundTransfer."
    },
    "hosted_regulatory_receipt_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses."
    },
    "destination_payment_method_details": {
      "$ref": "#/components/schemas/outbound_transfers_payment_method_details"
    }
  },
  "description": "Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://api.stripe.com#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://api.stripe.com#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.\n\nSimulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.\n\nRelated guide: [Moving money with Treasury using OutboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers)",
  "x-resourceId": "treasury.outbound_transfer",
  "x-expandableFields": [
    "destination_payment_method_details",
    "returned_details",
    "status_transitions",
    "tracking_details",
    "transaction"
  ]
}

object treasury.received_credit

{
  "type": "object",
  "title": "TreasuryReceivedCreditsResourceReceivedCredit",
  "required": [
    "amount",
    "created",
    "currency",
    "description",
    "id",
    "initiating_payment_method_details",
    "linked_flows",
    "livemode",
    "network",
    "object",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "amount": {
      "type": "integer",
      "description": "Amount (in cents) transferred."
    },
    "object": {
      "enum": [
        "treasury.received_credit"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "failed",
        "succeeded"
      ],
      "type": "string",
      "description": "Status of the ReceivedCredit. ReceivedCredits are created either `succeeded` (approved) or `failed` (declined). If a ReceivedCredit is declined, the failure reason can be found in the `failure_code` field.",
      "x-stripeBypassValidation": true
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "network": {
      "enum": [
        "ach",
        "card",
        "stripe",
        "us_domestic_wire"
      ],
      "type": "string",
      "description": "The rails used to send the funds.",
      "x-stripeBypassValidation": true
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "description": {
      "type": "string",
      "maxLength": 5000,
      "description": "An arbitrary string attached to the object. Often useful for displaying to users."
    },
    "transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/treasury.transaction"
        }
      ],
      "nullable": true,
      "description": "The Transaction associated with this object.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/treasury.transaction"
          }
        ]
      }
    },
    "failure_code": {
      "enum": [
        "account_closed",
        "account_frozen",
        "international_transaction",
        "other"
      ],
      "type": "string",
      "nullable": true,
      "description": "Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen.",
      "x-stripeBypassValidation": true
    },
    "linked_flows": {
      "$ref": "#/components/schemas/treasury_received_credits_resource_linked_flows"
    },
    "reversal_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/treasury_received_credits_resource_reversal_details"
        }
      ],
      "nullable": true,
      "description": "Details describing when a ReceivedCredit may be reversed."
    },
    "financial_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The FinancialAccount that received the funds."
    },
    "hosted_regulatory_receipt_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses."
    },
    "initiating_payment_method_details": {
      "$ref": "#/components/schemas/treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details"
    }
  },
  "description": "ReceivedCredits represent funds sent to a [FinancialAccount](https://api.stripe.com#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.",
  "x-resourceId": "treasury.received_credit",
  "x-expandableFields": [
    "initiating_payment_method_details",
    "linked_flows",
    "reversal_details",
    "transaction"
  ]
}

object treasury.received_debit

{
  "type": "object",
  "title": "TreasuryReceivedDebitsResourceReceivedDebit",
  "required": [
    "amount",
    "created",
    "currency",
    "description",
    "id",
    "linked_flows",
    "livemode",
    "network",
    "object",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "amount": {
      "type": "integer",
      "description": "Amount (in cents) transferred."
    },
    "object": {
      "enum": [
        "treasury.received_debit"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "failed",
        "succeeded"
      ],
      "type": "string",
      "description": "Status of the ReceivedDebit. ReceivedDebits are created with a status of either `succeeded` (approved) or `failed` (declined). The failure reason can be found under the `failure_code`.",
      "x-stripeBypassValidation": true
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "network": {
      "enum": [
        "ach",
        "card",
        "stripe"
      ],
      "type": "string",
      "description": "The network used for the ReceivedDebit.",
      "x-stripeBypassValidation": true
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "description": {
      "type": "string",
      "maxLength": 5000,
      "description": "An arbitrary string attached to the object. Often useful for displaying to users."
    },
    "transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/treasury.transaction"
        }
      ],
      "nullable": true,
      "description": "The Transaction associated with this object.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/treasury.transaction"
          }
        ]
      }
    },
    "failure_code": {
      "enum": [
        "account_closed",
        "account_frozen",
        "insufficient_funds",
        "international_transaction",
        "other"
      ],
      "type": "string",
      "nullable": true,
      "description": "Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen."
    },
    "linked_flows": {
      "$ref": "#/components/schemas/treasury_received_debits_resource_linked_flows"
    },
    "reversal_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/treasury_received_debits_resource_reversal_details"
        }
      ],
      "nullable": true,
      "description": "Details describing when a ReceivedDebit might be reversed."
    },
    "financial_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The FinancialAccount that funds were pulled from."
    },
    "hosted_regulatory_receipt_url": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses."
    },
    "initiating_payment_method_details": {
      "$ref": "#/components/schemas/treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details"
    }
  },
  "description": "ReceivedDebits represent funds pulled from a [FinancialAccount](https://api.stripe.com#financial_accounts). These are not initiated from the FinancialAccount.",
  "x-resourceId": "treasury.received_debit",
  "x-expandableFields": [
    "initiating_payment_method_details",
    "linked_flows",
    "reversal_details",
    "transaction"
  ]
}

object treasury.transaction

{
  "type": "object",
  "title": "TreasuryTransactionsResourceTransaction",
  "required": [
    "amount",
    "balance_impact",
    "created",
    "currency",
    "description",
    "financial_account",
    "flow_type",
    "id",
    "livemode",
    "object",
    "status",
    "status_transitions"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "flow": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the flow that created the Transaction."
    },
    "amount": {
      "type": "integer",
      "description": "Amount (in cents) transferred."
    },
    "object": {
      "enum": [
        "treasury.transaction"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "open",
        "posted",
        "void"
      ],
      "type": "string",
      "description": "Status of the Transaction."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "entries": {
      "type": "object",
      "title": "TreasuryTransactionsResourceTransactionEntryList",
      "nullable": true,
      "required": [
        "data",
        "has_more",
        "object",
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "pattern": "^/v1/treasury/transaction_entries",
          "maxLength": 5000,
          "description": "The URL where this list can be accessed."
        },
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/treasury.transaction_entry"
          },
          "description": "Details about each object."
        },
        "object": {
          "enum": [
            "list"
          ],
          "type": "string",
          "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
        },
        "has_more": {
          "type": "boolean",
          "description": "True if this list has another page of items after this one that can be fetched."
        }
      },
      "description": "A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints.",
      "x-expandableFields": [
        "data"
      ]
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "flow_type": {
      "enum": [
        "credit_reversal",
        "debit_reversal",
        "inbound_transfer",
        "issuing_authorization",
        "other",
        "outbound_payment",
        "outbound_transfer",
        "received_credit",
        "received_debit"
      ],
      "type": "string",
      "description": "Type of the flow that created the Transaction.",
      "x-stripeBypassValidation": true
    },
    "description": {
      "type": "string",
      "maxLength": 5000,
      "description": "An arbitrary string attached to the object. Often useful for displaying to users."
    },
    "flow_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/treasury_transactions_resource_flow_details"
        }
      ],
      "nullable": true,
      "description": "Details of the flow that created the Transaction."
    },
    "balance_impact": {
      "$ref": "#/components/schemas/treasury_transactions_resource_balance_impact"
    },
    "financial_account": {
      "type": "string",
      "maxLength": 5000,
      "description": "The FinancialAccount associated with this object."
    },
    "status_transitions": {
      "$ref": "#/components/schemas/treasury_transactions_resource_abstract_transaction_resource_status_transitions"
    }
  },
  "description": "Transactions represent changes to a [FinancialAccount's](https://api.stripe.com#financial_accounts) balance.",
  "x-resourceId": "treasury.transaction",
  "x-expandableFields": [
    "balance_impact",
    "entries",
    "flow_details",
    "status_transitions"
  ]
}

object treasury.transaction_entry

{
  "type": "object",
  "title": "TreasuryTransactionsResourceTransactionEntry",
  "required": [
    "balance_impact",
    "created",
    "currency",
    "effective_at",
    "financial_account",
    "flow_type",
    "id",
    "livemode",
    "object",
    "transaction",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "flow": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Token of the flow associated with the TransactionEntry."
    },
    "type": {
      "enum": [
        "credit_reversal",
        "credit_reversal_posting",
        "debit_reversal",
        "inbound_transfer",
        "inbound_transfer_return",
        "issuing_authorization_hold",
        "issuing_authorization_release",
        "other",
        "outbound_payment",
        "outbound_payment_cancellation",
        "outbound_payment_failure",
        "outbound_payment_posting",
        "outbound_payment_return",
        "outbound_transfer",
        "outbound_transfer_cancellation",
        "outbound_transfer_failure",
        "outbound_transfer_posting",
        "outbound_transfer_return",
        "received_credit",
        "received_debit"
      ],
      "type": "string",
      "description": "The specific money movement that generated the TransactionEntry."
    },
    "object": {
      "enum": [
        "treasury.transaction_entry"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "flow_type": {
      "enum": [
        "credit_reversal",
        "debit_reversal",
        "inbound_transfer",
        "issuing_authorization",
        "other",
        "outbound_payment",
        "outbound_transfer",
        "received_credit",
        "received_debit"
      ],
      "type": "string",
      "description": "Type of the flow associated with the TransactionEntry.",
      "x-stripeBypassValidation": true
    },
    "transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/treasury.transaction"
        }
      ],
      "description": "The Transaction associated with this object.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/treasury.transaction"
          }
        ]
      }
    },
    "effective_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "When the TransactionEntry will impact the FinancialAccount's balance."
    },
    "flow_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/treasury_transactions_resource_flow_details"
        }
      ],
      "nullable": true,
      "description": "Details of the flow associated with the TransactionEntry."
    },
    "balance_impact": {
      "$ref": "#/components/schemas/treasury_transactions_resource_balance_impact"
    },
    "financial_account": {
      "type": "string",
      "maxLength": 5000,
      "description": "The FinancialAccount associated with this object."
    }
  },
  "description": "TransactionEntries represent individual units of money movements within a single [Transaction](https://api.stripe.com#transactions).",
  "x-resourceId": "treasury.transaction_entry",
  "x-expandableFields": [
    "balance_impact",
    "flow_details",
    "transaction"
  ]
}

object treasury_financial_accounts_resource_aba_record

{
  "type": "object",
  "title": "TreasuryFinancialAccountsResourceABARecord",
  "required": [
    "account_holder_name",
    "account_number_last4",
    "bank_name",
    "routing_number"
  ],
  "properties": {
    "bank_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "Name of the bank."
    },
    "account_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The account number."
    },
    "routing_number": {
      "type": "string",
      "maxLength": 5000,
      "description": "Routing number for the account."
    },
    "account_holder_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The name of the person or business that owns the bank account."
    },
    "account_number_last4": {
      "type": "string",
      "maxLength": 5000,
      "description": "The last four characters of the account number."
    }
  },
  "description": "ABA Records contain U.S. bank account details per the ABA format.",
  "x-expandableFields": []
}

object treasury_financial_accounts_resource_aba_toggle_settings

{
  "type": "object",
  "title": "TreasuryFinancialAccountsResourceAbaToggleSettings",
  "required": [
    "requested",
    "status",
    "status_details"
  ],
  "properties": {
    "status": {
      "enum": [
        "active",
        "pending",
        "restricted"
      ],
      "type": "string",
      "description": "Whether the Feature is operational."
    },
    "requested": {
      "type": "boolean",
      "description": "Whether the FinancialAccount should have the Feature."
    },
    "status_details": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details"
      },
      "description": "Additional details; includes at least one entry when the status is not `active`."
    }
  },
  "description": "Toggle settings for enabling/disabling the ABA address feature",
  "x-expandableFields": [
    "status_details"
  ]
}

object treasury_financial_accounts_resource_balance

{
  "type": "object",
  "title": "TreasuryFinancialAccountsResourceBalance",
  "required": [
    "cash",
    "inbound_pending",
    "outbound_pending"
  ],
  "properties": {
    "cash": {
      "type": "object",
      "description": "Funds the user can spend right now.",
      "additionalProperties": {
        "type": "integer"
      }
    },
    "inbound_pending": {
      "type": "object",
      "description": "Funds not spendable yet, but will become available at a later time.",
      "additionalProperties": {
        "type": "integer"
      }
    },
    "outbound_pending": {
      "type": "object",
      "description": "Funds in the account, but not spendable because they are being held for pending outbound flows.",
      "additionalProperties": {
        "type": "integer"
      }
    }
  },
  "description": "Balance information for the FinancialAccount",
  "x-expandableFields": []
}

object treasury_financial_accounts_resource_closed_status_details

{
  "type": "object",
  "title": "TreasuryFinancialAccountsResourceClosedStatusDetails",
  "required": [
    "reasons"
  ],
  "properties": {
    "reasons": {
      "type": "array",
      "items": {
        "enum": [
          "account_rejected",
          "closed_by_platform",
          "other"
        ],
        "type": "string"
      },
      "description": "The array that contains reasons for a FinancialAccount closure."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object treasury_financial_accounts_resource_financial_address

{
  "type": "object",
  "title": "TreasuryFinancialAccountsResourceFinancialAddress",
  "required": [
    "type"
  ],
  "properties": {
    "aba": {
      "$ref": "#/components/schemas/treasury_financial_accounts_resource_aba_record"
    },
    "type": {
      "enum": [
        "aba"
      ],
      "type": "string",
      "description": "The type of financial address",
      "x-stripeBypassValidation": true
    },
    "supported_networks": {
      "type": "array",
      "items": {
        "enum": [
          "ach",
          "us_domestic_wire"
        ],
        "type": "string",
        "x-stripeBypassValidation": true
      },
      "description": "The list of networks that the address supports"
    }
  },
  "description": "FinancialAddresses contain identifying information that resolves to a FinancialAccount.",
  "x-expandableFields": [
    "aba"
  ]
}

object treasury_financial_accounts_resource_financial_addresses_features

{
  "type": "object",
  "title": "TreasuryFinancialAccountsResourceFinancialAddressesFeatures",
  "properties": {
    "aba": {
      "$ref": "#/components/schemas/treasury_financial_accounts_resource_aba_toggle_settings"
    }
  },
  "description": "Settings related to Financial Addresses features on a Financial Account",
  "x-expandableFields": [
    "aba"
  ]
}

object treasury_financial_accounts_resource_inbound_ach_toggle_settings

{
  "type": "object",
  "title": "TreasuryFinancialAccountsResourceInboundAchToggleSettings",
  "required": [
    "requested",
    "status",
    "status_details"
  ],
  "properties": {
    "status": {
      "enum": [
        "active",
        "pending",
        "restricted"
      ],
      "type": "string",
      "description": "Whether the Feature is operational."
    },
    "requested": {
      "type": "boolean",
      "description": "Whether the FinancialAccount should have the Feature."
    },
    "status_details": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details"
      },
      "description": "Additional details; includes at least one entry when the status is not `active`."
    }
  },
  "description": "Toggle settings for enabling/disabling an inbound ACH specific feature",
  "x-expandableFields": [
    "status_details"
  ]
}

object treasury_financial_accounts_resource_inbound_transfers

{
  "type": "object",
  "title": "TreasuryFinancialAccountsResourceInboundTransfers",
  "properties": {
    "ach": {
      "$ref": "#/components/schemas/treasury_financial_accounts_resource_inbound_ach_toggle_settings"
    }
  },
  "description": "InboundTransfers contains inbound transfers features for a FinancialAccount.",
  "x-expandableFields": [
    "ach"
  ]
}

object treasury_financial_accounts_resource_outbound_ach_toggle_settings

{
  "type": "object",
  "title": "TreasuryFinancialAccountsResourceOutboundAchToggleSettings",
  "required": [
    "requested",
    "status",
    "status_details"
  ],
  "properties": {
    "status": {
      "enum": [
        "active",
        "pending",
        "restricted"
      ],
      "type": "string",
      "description": "Whether the Feature is operational."
    },
    "requested": {
      "type": "boolean",
      "description": "Whether the FinancialAccount should have the Feature."
    },
    "status_details": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details"
      },
      "description": "Additional details; includes at least one entry when the status is not `active`."
    }
  },
  "description": "Toggle settings for enabling/disabling an outbound ACH specific feature",
  "x-expandableFields": [
    "status_details"
  ]
}

object treasury_financial_accounts_resource_outbound_payments

{
  "type": "object",
  "title": "TreasuryFinancialAccountsResourceOutboundPayments",
  "properties": {
    "ach": {
      "$ref": "#/components/schemas/treasury_financial_accounts_resource_outbound_ach_toggle_settings"
    },
    "us_domestic_wire": {
      "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggle_settings"
    }
  },
  "description": "Settings related to Outbound Payments features on a Financial Account",
  "x-expandableFields": [
    "ach",
    "us_domestic_wire"
  ]
}

object treasury_financial_accounts_resource_outbound_transfers

{
  "type": "object",
  "title": "TreasuryFinancialAccountsResourceOutboundTransfers",
  "properties": {
    "ach": {
      "$ref": "#/components/schemas/treasury_financial_accounts_resource_outbound_ach_toggle_settings"
    },
    "us_domestic_wire": {
      "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggle_settings"
    }
  },
  "description": "OutboundTransfers contains outbound transfers features for a FinancialAccount.",
  "x-expandableFields": [
    "ach",
    "us_domestic_wire"
  ]
}

object treasury_financial_accounts_resource_platform_restrictions

{
  "type": "object",
  "title": "TreasuryFinancialAccountsResourcePlatformRestrictions",
  "properties": {
    "inbound_flows": {
      "enum": [
        "restricted",
        "unrestricted"
      ],
      "type": "string",
      "nullable": true,
      "description": "Restricts all inbound money movement."
    },
    "outbound_flows": {
      "enum": [
        "restricted",
        "unrestricted"
      ],
      "type": "string",
      "nullable": true,
      "description": "Restricts all outbound money movement."
    }
  },
  "description": "Restrictions that a Connect Platform has placed on this FinancialAccount.",
  "x-expandableFields": []
}

object treasury_financial_accounts_resource_status_details

{
  "type": "object",
  "title": "TreasuryFinancialAccountsResourceStatusDetails",
  "properties": {
    "closed": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/treasury_financial_accounts_resource_closed_status_details"
        }
      ],
      "nullable": true,
      "description": "Details related to the closure of this FinancialAccount"
    }
  },
  "description": "",
  "x-expandableFields": [
    "closed"
  ]
}

object treasury_financial_accounts_resource_toggle_settings

{
  "type": "object",
  "title": "TreasuryFinancialAccountsResourceToggleSettings",
  "required": [
    "requested",
    "status",
    "status_details"
  ],
  "properties": {
    "status": {
      "enum": [
        "active",
        "pending",
        "restricted"
      ],
      "type": "string",
      "description": "Whether the Feature is operational."
    },
    "requested": {
      "type": "boolean",
      "description": "Whether the FinancialAccount should have the Feature."
    },
    "status_details": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details"
      },
      "description": "Additional details; includes at least one entry when the status is not `active`."
    }
  },
  "description": "Toggle settings for enabling/disabling a feature",
  "x-expandableFields": [
    "status_details"
  ]
}

object treasury_financial_accounts_resource_toggles_setting_status_details

{
  "type": "object",
  "title": "TreasuryFinancialAccountsResourceTogglesSettingStatusDetails",
  "required": [
    "code"
  ],
  "properties": {
    "code": {
      "enum": [
        "activating",
        "capability_not_requested",
        "financial_account_closed",
        "rejected_other",
        "rejected_unsupported_business",
        "requirements_past_due",
        "requirements_pending_verification",
        "restricted_by_platform",
        "restricted_other"
      ],
      "type": "string",
      "description": "Represents the reason why the status is `pending` or `restricted`.",
      "x-stripeBypassValidation": true
    },
    "resolution": {
      "enum": [
        "contact_stripe",
        "provide_information",
        "remove_restriction"
      ],
      "type": "string",
      "nullable": true,
      "description": "Represents what the user should do, if anything, to activate the Feature.",
      "x-stripeBypassValidation": true
    },
    "restriction": {
      "enum": [
        "inbound_flows",
        "outbound_flows"
      ],
      "type": "string",
      "description": "The `platform_restrictions` that are restricting this Feature.",
      "x-stripeBypassValidation": true
    }
  },
  "description": "Additional details on the FinancialAccount Features information.",
  "x-expandableFields": []
}

object treasury_inbound_transfers_resource_failure_details

{
  "type": "object",
  "title": "TreasuryInboundTransfersResourceFailureDetails",
  "required": [
    "code"
  ],
  "properties": {
    "code": {
      "enum": [
        "account_closed",
        "account_frozen",
        "bank_account_restricted",
        "bank_ownership_changed",
        "debit_not_authorized",
        "incorrect_account_holder_address",
        "incorrect_account_holder_name",
        "incorrect_account_holder_tax_id",
        "insufficient_funds",
        "invalid_account_number",
        "invalid_currency",
        "no_account",
        "other"
      ],
      "type": "string",
      "description": "Reason for the failure."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object treasury_inbound_transfers_resource_inbound_transfer_resource_linked_flows

{
  "type": "object",
  "title": "TreasuryInboundTransfersResourceInboundTransferResourceLinkedFlows",
  "properties": {
    "received_debit": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "If funds for this flow were returned after the flow went to the `succeeded` state, this field contains a reference to the ReceivedDebit return."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object treasury_inbound_transfers_resource_inbound_transfer_resource_status_transitions

{
  "type": "object",
  "title": "TreasuryInboundTransfersResourceInboundTransferResourceStatusTransitions",
  "properties": {
    "failed_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Timestamp describing when an InboundTransfer changed status to `failed`."
    },
    "canceled_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Timestamp describing when an InboundTransfer changed status to `canceled`."
    },
    "succeeded_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Timestamp describing when an InboundTransfer changed status to `succeeded`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object treasury_outbound_payments_resource_ach_tracking_details

{
  "type": "object",
  "title": "TreasuryOutboundPaymentsResourceACHTrackingDetails",
  "required": [
    "trace_id"
  ],
  "properties": {
    "trace_id": {
      "type": "string",
      "maxLength": 5000,
      "description": "ACH trace ID of the OutboundPayment for payments sent over the `ach` network."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object treasury_outbound_payments_resource_outbound_payment_resource_end_user_details

{
  "type": "object",
  "title": "TreasuryOutboundPaymentsResourceOutboundPaymentResourceEndUserDetails",
  "required": [
    "present"
  ],
  "properties": {
    "present": {
      "type": "boolean",
      "description": "`true` if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, `false`."
    },
    "ip_address": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "IP address of the user initiating the OutboundPayment. Set if `present` is set to `true`. IP address collection is required for risk and compliance reasons. This will be used to help determine if the OutboundPayment is authorized or should be blocked."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object treasury_outbound_payments_resource_outbound_payment_resource_status_transitions

{
  "type": "object",
  "title": "TreasuryOutboundPaymentsResourceOutboundPaymentResourceStatusTransitions",
  "properties": {
    "failed_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Timestamp describing when an OutboundPayment changed status to `failed`."
    },
    "posted_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Timestamp describing when an OutboundPayment changed status to `posted`."
    },
    "canceled_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Timestamp describing when an OutboundPayment changed status to `canceled`."
    },
    "returned_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Timestamp describing when an OutboundPayment changed status to `returned`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object treasury_outbound_payments_resource_outbound_payment_resource_tracking_details

{
  "type": "object",
  "title": "TreasuryOutboundPaymentsResourceOutboundPaymentResourceTrackingDetails",
  "required": [
    "type"
  ],
  "properties": {
    "ach": {
      "$ref": "#/components/schemas/treasury_outbound_payments_resource_ach_tracking_details"
    },
    "type": {
      "enum": [
        "ach",
        "us_domestic_wire"
      ],
      "type": "string",
      "description": "The US bank account network used to send funds."
    },
    "us_domestic_wire": {
      "$ref": "#/components/schemas/treasury_outbound_payments_resource_us_domestic_wire_tracking_details"
    }
  },
  "description": "",
  "x-expandableFields": [
    "ach",
    "us_domestic_wire"
  ]
}

object treasury_outbound_payments_resource_returned_status

{
  "type": "object",
  "title": "TreasuryOutboundPaymentsResourceReturnedStatus",
  "required": [
    "code",
    "transaction"
  ],
  "properties": {
    "code": {
      "enum": [
        "account_closed",
        "account_frozen",
        "bank_account_restricted",
        "bank_ownership_changed",
        "declined",
        "incorrect_account_holder_name",
        "invalid_account_number",
        "invalid_currency",
        "no_account",
        "other"
      ],
      "type": "string",
      "description": "Reason for the return."
    },
    "transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/treasury.transaction"
        }
      ],
      "description": "The Transaction associated with this object.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/treasury.transaction"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "transaction"
  ]
}

object treasury_outbound_payments_resource_us_domestic_wire_tracking_details

{
  "type": "object",
  "title": "TreasuryOutboundPaymentsResourceUSDomesticWireTrackingDetails",
  "properties": {
    "imad": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "IMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network."
    },
    "omad": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "OMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network."
    },
    "chips": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "CHIPS System Sequence Number (SSN) of the OutboundPayment for payments sent over the `us_domestic_wire` network."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object treasury_outbound_transfers_resource_ach_tracking_details

{
  "type": "object",
  "title": "TreasuryOutboundTransfersResourceACHTrackingDetails",
  "required": [
    "trace_id"
  ],
  "properties": {
    "trace_id": {
      "type": "string",
      "maxLength": 5000,
      "description": "ACH trace ID of the OutboundTransfer for transfers sent over the `ach` network."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object treasury_outbound_transfers_resource_outbound_transfer_resource_tracking_details

{
  "type": "object",
  "title": "TreasuryOutboundTransfersResourceOutboundTransferResourceTrackingDetails",
  "required": [
    "type"
  ],
  "properties": {
    "ach": {
      "$ref": "#/components/schemas/treasury_outbound_transfers_resource_ach_tracking_details"
    },
    "type": {
      "enum": [
        "ach",
        "us_domestic_wire"
      ],
      "type": "string",
      "description": "The US bank account network used to send funds."
    },
    "us_domestic_wire": {
      "$ref": "#/components/schemas/treasury_outbound_transfers_resource_us_domestic_wire_tracking_details"
    }
  },
  "description": "",
  "x-expandableFields": [
    "ach",
    "us_domestic_wire"
  ]
}

object treasury_outbound_transfers_resource_returned_details

{
  "type": "object",
  "title": "TreasuryOutboundTransfersResourceReturnedDetails",
  "required": [
    "code",
    "transaction"
  ],
  "properties": {
    "code": {
      "enum": [
        "account_closed",
        "account_frozen",
        "bank_account_restricted",
        "bank_ownership_changed",
        "declined",
        "incorrect_account_holder_name",
        "invalid_account_number",
        "invalid_currency",
        "no_account",
        "other"
      ],
      "type": "string",
      "description": "Reason for the return."
    },
    "transaction": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/treasury.transaction"
        }
      ],
      "description": "The Transaction associated with this object.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/treasury.transaction"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "transaction"
  ]
}

object treasury_outbound_transfers_resource_status_transitions

{
  "type": "object",
  "title": "TreasuryOutboundTransfersResourceStatusTransitions",
  "properties": {
    "failed_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Timestamp describing when an OutboundTransfer changed status to `failed`"
    },
    "posted_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Timestamp describing when an OutboundTransfer changed status to `posted`"
    },
    "canceled_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Timestamp describing when an OutboundTransfer changed status to `canceled`"
    },
    "returned_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Timestamp describing when an OutboundTransfer changed status to `returned`"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object treasury_outbound_transfers_resource_us_domestic_wire_tracking_details

{
  "type": "object",
  "title": "TreasuryOutboundTransfersResourceUSDomesticWireTrackingDetails",
  "properties": {
    "imad": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "IMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network."
    },
    "omad": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "OMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network."
    },
    "chips": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "CHIPS System Sequence Number (SSN) of the OutboundTransfer for transfers sent over the `us_domestic_wire` network."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object treasury_received_credits_resource_linked_flows

{
  "type": "object",
  "title": "TreasuryReceivedCreditsResourceLinkedFlows",
  "properties": {
    "source_flow": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the source flow. Set if `network` is `stripe` and the source flow is visible to the user. Examples of source flows include OutboundPayments, payouts, or CreditReversals."
    },
    "credit_reversal": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The CreditReversal created as a result of this ReceivedCredit being reversed."
    },
    "source_flow_type": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The type of flow that originated the ReceivedCredit (for example, `outbound_payment`)."
    },
    "issuing_transaction": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Set if the ReceivedCredit is also viewable as an [Issuing transaction](https://api.stripe.com#issuing_transactions) object."
    },
    "source_flow_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/treasury_received_credits_resource_source_flows_details"
        }
      ],
      "nullable": true,
      "description": "The expandable object of the source flow."
    },
    "issuing_authorization": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Set if the ReceivedCredit was created due to an [Issuing Authorization](https://api.stripe.com#issuing_authorizations) object."
    }
  },
  "description": "",
  "x-expandableFields": [
    "source_flow_details"
  ]
}

object treasury_received_credits_resource_reversal_details

{
  "type": "object",
  "title": "TreasuryReceivedCreditsResourceReversalDetails",
  "properties": {
    "deadline": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Time before which a ReceivedCredit can be reversed."
    },
    "restricted_reason": {
      "enum": [
        "already_reversed",
        "deadline_passed",
        "network_restricted",
        "other",
        "source_flow_restricted"
      ],
      "type": "string",
      "nullable": true,
      "description": "Set if a ReceivedCredit cannot be reversed."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object treasury_received_credits_resource_source_flows_details

{
  "type": "object",
  "title": "TreasuryReceivedCreditsResourceSourceFlowsDetails",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "credit_reversal",
        "other",
        "outbound_payment",
        "outbound_transfer",
        "payout"
      ],
      "type": "string",
      "description": "The type of the source flow that originated the ReceivedCredit."
    },
    "payout": {
      "$ref": "#/components/schemas/payout"
    },
    "credit_reversal": {
      "$ref": "#/components/schemas/treasury.credit_reversal"
    },
    "outbound_payment": {
      "$ref": "#/components/schemas/treasury.outbound_payment"
    },
    "outbound_transfer": {
      "$ref": "#/components/schemas/treasury.outbound_transfer"
    }
  },
  "description": "",
  "x-expandableFields": [
    "credit_reversal",
    "outbound_payment",
    "outbound_transfer",
    "payout"
  ]
}

object treasury_received_credits_resource_status_transitions

{
  "type": "object",
  "title": "TreasuryReceivedCreditsResourceStatusTransitions",
  "properties": {
    "posted_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Timestamp describing when the CreditReversal changed status to `posted`"
    }
  },
  "description": "",
  "x-expandableFields": []
}

object treasury_received_debits_resource_debit_reversal_linked_flows

{
  "type": "object",
  "title": "TreasuryReceivedDebitsResourceDebitReversalLinkedFlows",
  "properties": {
    "issuing_dispute": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Set if there is an Issuing dispute associated with the DebitReversal."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object treasury_received_debits_resource_linked_flows

{
  "type": "object",
  "title": "TreasuryReceivedDebitsResourceLinkedFlows",
  "properties": {
    "topup": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Set if the ReceivedDebit was created due to a [Topup](https://api.stripe.com#topups) object."
    },
    "payout": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Set if the ReceivedDebit was created due to a [Payout](https://api.stripe.com#payouts) object."
    },
    "debit_reversal": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The DebitReversal created as a result of this ReceivedDebit being reversed."
    },
    "inbound_transfer": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Set if the ReceivedDebit is associated with an InboundTransfer's return of funds."
    },
    "issuing_transaction": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Set if the ReceivedDebit is also viewable as an [Issuing Dispute](https://api.stripe.com#issuing_disputes) object."
    },
    "issuing_authorization": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Set if the ReceivedDebit was created due to an [Issuing Authorization](https://api.stripe.com#issuing_authorizations) object."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object treasury_received_debits_resource_reversal_details

{
  "type": "object",
  "title": "TreasuryReceivedDebitsResourceReversalDetails",
  "properties": {
    "deadline": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Time before which a ReceivedDebit can be reversed."
    },
    "restricted_reason": {
      "enum": [
        "already_reversed",
        "deadline_passed",
        "network_restricted",
        "other",
        "source_flow_restricted"
      ],
      "type": "string",
      "nullable": true,
      "description": "Set if a ReceivedDebit can't be reversed."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object treasury_received_debits_resource_status_transitions

{
  "type": "object",
  "title": "TreasuryReceivedDebitsResourceStatusTransitions",
  "properties": {
    "completed_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Timestamp describing when the DebitReversal changed status to `completed`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object treasury_shared_resource_billing_details

{
  "type": "object",
  "title": "TreasurySharedResourceBillingDetails",
  "required": [
    "address"
  ],
  "properties": {
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Full name."
    },
    "email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Email address."
    },
    "address": {
      "$ref": "#/components/schemas/address"
    }
  },
  "description": "",
  "x-expandableFields": [
    "address"
  ]
}

object treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details

{
  "type": "object",
  "title": "TreasurySharedResourceInitiatingPaymentMethodDetailsInitiatingPaymentMethodDetails",
  "required": [
    "billing_details",
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "balance",
        "financial_account",
        "issuing_card",
        "stripe",
        "us_bank_account"
      ],
      "type": "string",
      "description": "Polymorphic type matching the originating money movement's source. This can be an external account, a Stripe balance, or a FinancialAccount.",
      "x-stripeBypassValidation": true
    },
    "balance": {
      "enum": [
        "payments"
      ],
      "type": "string",
      "description": "Set when `type` is `balance`."
    },
    "issuing_card": {
      "type": "string",
      "maxLength": 5000,
      "description": "Set when `type` is `issuing_card`. This is an [Issuing Card](https://api.stripe.com#issuing_cards) ID."
    },
    "billing_details": {
      "$ref": "#/components/schemas/treasury_shared_resource_billing_details"
    },
    "us_bank_account": {
      "$ref": "#/components/schemas/treasury_shared_resource_initiating_payment_method_details_us_bank_account"
    },
    "financial_account": {
      "$ref": "#/components/schemas/received_payment_method_details_financial_account"
    }
  },
  "description": "",
  "x-expandableFields": [
    "billing_details",
    "financial_account",
    "us_bank_account"
  ]
}

object treasury_shared_resource_initiating_payment_method_details_us_bank_account

{
  "type": "object",
  "title": "TreasurySharedResourceInitiatingPaymentMethodDetailsUSBankAccount",
  "properties": {
    "last4": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The last four digits of the bank account number."
    },
    "bank_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Bank name."
    },
    "routing_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The routing number for the bank account."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object treasury_transactions_resource_abstract_transaction_resource_status_transitions

{
  "type": "object",
  "title": "TreasuryTransactionsResourceAbstractTransactionResourceStatusTransitions",
  "properties": {
    "void_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Timestamp describing when the Transaction changed status to `void`."
    },
    "posted_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Timestamp describing when the Transaction changed status to `posted`."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object treasury_transactions_resource_balance_impact

{
  "type": "object",
  "title": "TreasuryTransactionsResourceBalanceImpact",
  "required": [
    "cash",
    "inbound_pending",
    "outbound_pending"
  ],
  "properties": {
    "cash": {
      "type": "integer",
      "description": "The change made to funds the user can spend right now."
    },
    "inbound_pending": {
      "type": "integer",
      "description": "The change made to funds that are not spendable yet, but will become available at a later time."
    },
    "outbound_pending": {
      "type": "integer",
      "description": "The change made to funds in the account, but not spendable because they are being held for pending outbound flows."
    }
  },
  "description": "Change to a FinancialAccount's balance",
  "x-expandableFields": []
}

object treasury_transactions_resource_flow_details

{
  "type": "object",
  "title": "TreasuryTransactionsResourceFlowDetails",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "credit_reversal",
        "debit_reversal",
        "inbound_transfer",
        "issuing_authorization",
        "other",
        "outbound_payment",
        "outbound_transfer",
        "received_credit",
        "received_debit"
      ],
      "type": "string",
      "description": "Type of the flow that created the Transaction. Set to the same value as `flow_type`.",
      "x-stripeBypassValidation": true
    },
    "debit_reversal": {
      "$ref": "#/components/schemas/treasury.debit_reversal"
    },
    "received_debit": {
      "$ref": "#/components/schemas/treasury.received_debit"
    },
    "credit_reversal": {
      "$ref": "#/components/schemas/treasury.credit_reversal"
    },
    "received_credit": {
      "$ref": "#/components/schemas/treasury.received_credit"
    },
    "inbound_transfer": {
      "$ref": "#/components/schemas/treasury.inbound_transfer"
    },
    "outbound_payment": {
      "$ref": "#/components/schemas/treasury.outbound_payment"
    },
    "outbound_transfer": {
      "$ref": "#/components/schemas/treasury.outbound_transfer"
    },
    "issuing_authorization": {
      "$ref": "#/components/schemas/issuing.authorization"
    }
  },
  "description": "",
  "x-expandableFields": [
    "credit_reversal",
    "debit_reversal",
    "inbound_transfer",
    "issuing_authorization",
    "outbound_payment",
    "outbound_transfer",
    "received_credit",
    "received_debit"
  ]
}

object us_bank_account_networks

{
  "type": "object",
  "title": "us_bank_account_networks",
  "required": [
    "supported"
  ],
  "properties": {
    "preferred": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The preferred network."
    },
    "supported": {
      "type": "array",
      "items": {
        "enum": [
          "ach",
          "us_domestic_wire"
        ],
        "type": "string"
      },
      "description": "All supported networks."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object verification_session_redaction

{
  "type": "object",
  "title": "verification_session_redaction",
  "required": [
    "status"
  ],
  "properties": {
    "status": {
      "enum": [
        "processing",
        "redacted"
      ],
      "type": "string",
      "description": "Indicates whether this object and its related objects have been redacted or not."
    }
  },
  "description": "",
  "x-expandableFields": []
}

object webhook_endpoint

{
  "type": "object",
  "title": "NotificationWebhookEndpoint",
  "required": [
    "created",
    "enabled_events",
    "id",
    "livemode",
    "metadata",
    "object",
    "status",
    "url"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "url": {
      "type": "string",
      "maxLength": 5000,
      "description": "The URL of the webhook endpoint."
    },
    "object": {
      "enum": [
        "webhook_endpoint"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "secret": {
      "type": "string",
      "maxLength": 5000,
      "description": "The endpoint's secret, used to generate [webhook signatures](https://docs.stripe.com/webhooks/signatures). Only returned at creation."
    },
    "status": {
      "type": "string",
      "maxLength": 5000,
      "description": "The status of the webhook. It can be `enabled` or `disabled`."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "api_version": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The API version events are rendered as for this webhook endpoint."
    },
    "application": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The ID of the associated Connect application."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An optional description of what the webhook is used for."
    },
    "enabled_events": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "The list of events to enable for this endpoint. `['*']` indicates that all events are enabled, except those that require explicit selection."
    }
  },
  "description": "You can configure [webhook endpoints](https://docs.stripe.com/webhooks/) via the API to be\nnotified about events that happen in your Stripe account or connected\naccounts.\n\nMost users configure webhooks from [the dashboard](https://dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints.\n\nRelated guide: [Setting up webhooks](https://docs.stripe.com/webhooks/configure)",
  "x-resourceId": "webhook_endpoint",
  "x-expandableFields": []
}