Stripe API

Online payment processing for internet businesses

stripe.com ↗
Version
2026-04-22.dahlia
OpenAPI
3.0.0
Endpoints
587
Schemas
1385
88
Quality
Updated
3 days 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/

Endpoints

Clear filters

Account 1 endpoints

GET /v1/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/account

Accounts 11 endpoints

GET /v1/accounts

Returns a list of accounts connected to your platform via Connect. 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/accounts
GET /v1/accounts/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/accounts/{account}/bank_accounts/{id}
GET /v1/accounts/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/accounts/{account}/capabilities
GET /v1/accounts/{account}/capabilities/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/accounts/{account}/capabilities/{capability}
GET /v1/accounts/{account}/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/accounts/{account}/people
GET /v1/accounts/{account}/people/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/accounts/{account}/people/{person}
GET /v1/accounts/{account}/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/accounts/{account}/persons
GET /v1/accounts/{account}/persons/{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

application/x-www-form-urlencoded

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

application/x-www-form-urlencoded

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/apple_pay/domains/{domain}

Applicationfees 4 endpoints

GET /v1/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/application_fees/{id}
GET /v1/application_fees/{id}/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 limit and starting_after 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/application_fees/{id}/refunds

Apps 2 endpoints

GET /v1/apps/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/apps/secrets
GET /v1/apps/secrets/find

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/apps/secrets/find

Balance 3 endpoints

GET /v1/balance

Retrieves the current account balance, based on the authentication that was used to make the request. For a sample request, see Accounting for negative balances.

operationId: GetBalance

Parameters

Name In Required Type Description
expand query optional array

Specifies which fields in the response should be expanded.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/balance
GET /v1/balance/history

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 /v1/balance/history.

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, in lowercase. Must be a supported 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.

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, inbound_transfer, inbound_transfer_reversal, 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, transfer_refund, or fee_credit_funding.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/balance/history
GET /v1/balance/history/{id}

Retrieves the balance transaction with the given ID.

Note that this endpoint previously used the path /v1/balance/history/:id.

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/balance/history/{id}

Balancesettings 1 endpoints

GET /v1/balance_settings

Retrieves balance settings for a given connected account. Related guide: Making API calls for connected accounts

operationId: GetBalanceSettings

Parameters

Name In Required Type Description
expand query optional array

Specifies which fields in the response should be expanded.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/balance_settings

Balancetransactions 2 endpoints

GET /v1/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 /v1/balance/history.

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, in lowercase. Must be a supported 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.

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, inbound_transfer, inbound_transfer_reversal, 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, transfer_refund, or fee_credit_funding.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/balance_transactions
GET /v1/balance_transactions/{id}

Retrieves the balance transaction with the given ID.

Note that this endpoint previously used the path /v1/balance/history/:id.

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/balance_transactions/{id}

Billing 10 endpoints

GET /v1/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/billing/alerts
GET /v1/billing/alerts/{id}

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/billing/alerts/{id}
GET /v1/billing/credit_balance_summary

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/billing/credit_balance_summary
GET /v1/billing/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/billing/credit_balance_transactions
GET /v1/billing/credit_balance_transactions/{id}

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/billing/credit_balance_transactions/{id}
GET /v1/billing/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/billing/credit_grants
GET /v1/billing/credit_grants/{id}

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/billing/credit_grants/{id}
GET /v1/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/billing/meters/{id}
GET /v1/billing/meters/{id}/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

Billingportal 2 endpoints

GET /v1/billing_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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/billing_portal/configurations
GET /v1/billing_portal/configurations/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/billing_portal/configurations/{configuration}

Charges 6 endpoints

GET /v1/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/charges
GET /v1/charges/search

Search for charges you’ve previously created using Stripe’s Search Query Language. 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 and the list of supported query fields for charges.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/charges/search
GET /v1/charges/{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

application/x-www-form-urlencoded

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/charges/{charge}/dispute
GET /v1/charges/{charge}/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 limit and starting_after 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

application/x-www-form-urlencoded

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

Checkout 3 endpoints

GET /v1/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/checkout/sessions
GET /v1/checkout/sessions/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/checkout/sessions/{session}
GET /v1/checkout/sessions/{session}/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

Climate 6 endpoints

GET /v1/climate/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/climate/orders
GET /v1/climate/orders/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/climate/orders/{order}
GET /v1/climate/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/climate/products
GET /v1/climate/products/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/climate/products/{product}
GET /v1/climate/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/climate/suppliers
GET /v1/climate/suppliers/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/climate/suppliers/{supplier}

Confirmationtokens 1 endpoints

GET /v1/confirmation_tokens/{confirmation_token}

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/confirmation_tokens/{confirmation_token}

Countryspecs 2 endpoints

GET /v1/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/country_specs
GET /v1/country_specs/{country}

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/country_specs/{country}

Coupons 2 endpoints

GET /v1/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/coupons
GET /v1/coupons/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/coupons/{coupon}

Creditnotes 5 endpoints

GET /v1/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/credit_notes
GET /v1/credit_notes/preview

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 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/credit_notes/preview
GET /v1/credit_notes/preview/lines

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 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/credit_notes/preview/lines
GET /v1/credit_notes/{credit_note}/lines

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/credit_notes/{credit_note}/lines
GET /v1/credit_notes/{id}

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/credit_notes/{id}

Customers 18 endpoints

GET /v1/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/customers
GET /v1/customers/search

Search for customers you’ve previously created using Stripe’s Search Query Language. 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 and the list of supported query fields for customers.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/customers/search
GET /v1/customers/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

Returns a list of transactions that updated the customer’s balances.

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

Retrieves a specific customer balance transaction that updated the customer’s balances.

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/customers/{customer}/balance_transactions/{transaction}
GET /v1/customers/{customer}/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

Returns a list of transactions that modified the customer’s cash balance.

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

Retrieves a specific cash balance transaction, which updated the customer’s cash balance.

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

application/x-www-form-urlencoded

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

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

application/x-www-form-urlencoded

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

application/x-www-form-urlencoded

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/customers/{customer}/sources/{id}
GET /v1/customers/{customer}/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

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

application/x-www-form-urlencoded

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount
GET /v1/customers/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

Retrieves the tax_id 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

Disputes 2 endpoints

GET /v1/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/disputes
GET /v1/disputes/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/disputes/{dispute}

Entitlements 4 endpoints

GET /v1/entitlements/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/entitlements/active_entitlements
GET /v1/entitlements/active_entitlements/{id}

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/entitlements/active_entitlements/{id}
GET /v1/entitlements/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/entitlements/features
GET /v1/entitlements/features/{id}

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/entitlements/features/{id}

Events 2 endpoints

GET /v1/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 event object api_version attribute (not according to your current Stripe API version or Stripe-Version 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/events
GET /v1/events/{id}

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/events/{id}

Exchangerates 2 endpoints

GET /v1/exchange_rates

[Deprecated] The ExchangeRate APIs are deprecated. Please use the FX Quotes API 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/exchange_rates
GET /v1/exchange_rates/{rate_id}

[Deprecated] The ExchangeRate APIs are deprecated. Please use the FX Quotes API 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/exchange_rates/{rate_id}

Files 2 endpoints

GET /v1/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/files
GET /v1/files/{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 access file contents.

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/files/{file}

Financialconnections 6 endpoints

GET /v1/financial_connections/accounts

Returns a list of Financial Connections Account 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

Retrieves the details of an Financial Connections Account.

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

Lists all owners for a given Account

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

Retrieves the details of a Financial Connections Session

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/financial_connections/sessions/{session}
GET /v1/financial_connections/transactions

Returns a list of Financial Connections Transaction 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/financial_connections/transactions
GET /v1/financial_connections/transactions/{transaction}

Retrieves the details of a Financial Connections Transaction

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/financial_connections/transactions/{transaction}

Forwarding 2 endpoints

GET /v1/forwarding/requests

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/forwarding/requests
GET /v1/forwarding/requests/{id}

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/forwarding/requests/{id}

Identity 4 endpoints

GET /v1/identity/verification_reports

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/identity/verification_reports
GET /v1/identity/verification_reports/{report}

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/identity/verification_reports/{report}
GET /v1/identity/verification_sessions

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.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/identity/verification_sessions
GET /v1/identity/verification_sessions/{session}

Retrieves the details of a VerificationSession that was previously created.

When the session status is requires_input, you can use this method to retrieve a valid client_secret or url 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/identity/verification_sessions/{session}

Invoicepayments 2 endpoints

GET /v1/invoice_payments

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/invoice_payments
GET /v1/invoice_payments/{invoice_payment}

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/invoice_payments/{invoice_payment}

Invoicerenderingtemplates 2 endpoints

GET /v1/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/invoice_rendering_templates
GET /v1/invoice_rendering_templates/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/invoice_rendering_templates/{template}

Invoiceitems 2 endpoints

GET /v1/invoiceitems

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/invoiceitems
GET /v1/invoiceitems/{invoiceitem}

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/invoiceitems/{invoiceitem}

Invoices 4 endpoints

GET /v1/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

subscription query optional string

Only return invoices for the subscription specified by this subscription ID.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/invoices
GET /v1/invoices/search

Search for invoices you’ve previously created using Stripe’s Search Query Language. 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 and the list of supported query fields for invoices.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/invoices/search
GET /v1/invoices/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/invoices/{invoice}
GET /v1/invoices/{invoice}/lines

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/invoices/{invoice}/lines

Issuing 17 endpoints

GET /v1/issuing/authorizations

Returns a list of Issuing Authorization 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

Retrieves an Issuing Authorization 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/issuing/authorizations/{authorization}
GET /v1/issuing/cardholders

Returns a list of Issuing Cardholder 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

Retrieves an Issuing Cardholder 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/issuing/cardholders/{cardholder}
GET /v1/issuing/cards

Returns a list of Issuing Card 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

Retrieves an Issuing Card 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/issuing/cards/{card}
GET /v1/issuing/disputes

Returns a list of Issuing Dispute 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

Retrieves an Issuing Dispute 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/issuing/disputes/{dispute}
GET /v1/issuing/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/issuing/personalization_designs
GET /v1/issuing/personalization_designs/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/issuing/personalization_designs/{personalization_design}
GET /v1/issuing/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/issuing/physical_bundles
GET /v1/issuing/physical_bundles/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/issuing/physical_bundles/{physical_bundle}
GET /v1/issuing/settlements/{settlement}

Retrieves an Issuing Settlement 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/issuing/settlements/{settlement}
GET /v1/issuing/tokens

Lists all Issuing Token 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

Retrieves an Issuing Token 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/issuing/tokens/{token}
GET /v1/issuing/transactions

Returns a list of Issuing Transaction 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

Retrieves an Issuing Transaction 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/issuing/transactions/{transaction}

Linkaccountsessions 1 endpoints

GET /v1/link_account_sessions/{session}

Retrieves the details of a Financial Connections Session

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/link_account_sessions/{session}

Linkedaccounts 3 endpoints

GET /v1/linked_accounts

Returns a list of Financial Connections Account 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/linked_accounts
GET /v1/linked_accounts/{account}

Retrieves the details of an Financial Connections Account.

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/linked_accounts/{account}
GET /v1/linked_accounts/{account}/owners

Lists all owners for a given Account

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/linked_accounts/{account}/owners

Mandates 1 endpoints

GET /v1/mandates/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/mandates/{mandate}

Paymentattemptrecords 2 endpoints

GET /v1/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/payment_attempt_records
GET /v1/payment_attempt_records/{id}

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/payment_attempt_records/{id}

Paymentintents 4 endpoints

GET /v1/payment_intents

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/payment_intents
GET /v1/payment_intents/search

Search for PaymentIntents you’ve previously created using Stripe’s Search Query Language. 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 and the list of supported query fields for payment intents.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/payment_intents/search
GET /v1/payment_intents/{intent}

Retrieves the details of a PaymentIntent that has previously been created.

You can retrieve a PaymentIntent client-side using a publishable key when the client_secret is in the query string.

If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the payment intent 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/payment_intents/{intent}
GET /v1/payment_intents/{intent}/amount_details_line_items

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/payment_intents/{intent}/amount_details_line_items

Paymentmethodconfigurations 2 endpoints

GET /v1/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/payment_method_configurations
GET /v1/payment_method_configurations/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/payment_method_configurations/{configuration}

Paymentmethoddomains 2 endpoints

GET /v1/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/payment_method_domains
GET /v1/payment_method_domains/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/payment_method_domains/{payment_method_domain}

Paymentmethods 2 endpoints

GET /v1/payment_methods

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/payment_methods
GET /v1/payment_methods/{payment_method}

Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use Retrieve a Customer’s PaymentMethods

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/payment_methods/{payment_method}

Paymentrecords 1 endpoints

GET /v1/payment_records/{id}

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/payment_records/{id}

Payouts 2 endpoints

GET /v1/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/payouts
GET /v1/payouts/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/payouts/{payout}

Plans 2 endpoints

GET /v1/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/plans
GET /v1/plans/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/plans/{plan}

Prices 3 endpoints

GET /v1/prices

Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/prices
GET /v1/prices/search

Search for prices you’ve previously created using Stripe’s Search Query Language. 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 and the list of supported query fields for prices.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/prices/search
GET /v1/prices/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/prices/{price}

Products 5 endpoints

GET /v1/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 or 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/products
GET /v1/products/search

Search for products you’ve previously created using Stripe’s Search Query Language. 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 and the list of supported query fields for products.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/products/search
GET /v1/products/{id}

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

Promotioncodes 2 endpoints

GET /v1/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/promotion_codes
GET /v1/promotion_codes/{promotion_code}

Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use list with the desired 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/promotion_codes/{promotion_code}

Quotes 5 endpoints

GET /v1/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/quotes
GET /v1/quotes/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/quotes/{quote}
GET /v1/quotes/{quote}/computed_upfront_line_items

When retrieving a quote, there is an includable computed.upfront.line_items 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/quotes/{quote}/computed_upfront_line_items
GET /v1/quotes/{quote}/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/quotes/{quote}/line_items
GET /v1/quotes/{quote}/pdf

Download the PDF for a finalized quote. Explanation for special handling can be found here

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/quotes/{quote}/pdf

Radar 6 endpoints

GET /v1/radar/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/radar/early_fraud_warnings
GET /v1/radar/early_fraud_warnings/{early_fraud_warning}

Retrieves the details of an early fraud warning that has previously been created.

Please refer to the early fraud warning 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/radar/early_fraud_warnings/{early_fraud_warning}
GET /v1/radar/value_list_items

Returns a list of ValueListItem 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/radar/value_list_items
GET /v1/radar/value_list_items/{item}

Retrieves a ValueListItem 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/radar/value_list_items/{item}
GET /v1/radar/value_lists

Returns a list of ValueList 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/radar/value_lists
GET /v1/radar/value_lists/{value_list}

Retrieves a ValueList 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/radar/value_lists/{value_list}

Refunds 2 endpoints

GET /v1/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/refunds
GET /v1/refunds/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/refunds/{refund}

Reporting 4 endpoints

GET /v1/reporting/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/reporting/report_runs
GET /v1/reporting/report_runs/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/reporting/report_runs/{report_run}
GET /v1/reporting/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/reporting/report_types
GET /v1/reporting/report_types/{report_type}

Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/reporting/report_types/{report_type}

Reviews 2 endpoints

GET /v1/reviews

Returns a list of Review objects that have open set to true. 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/reviews
GET /v1/reviews/{review}

Retrieves a Review 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/reviews/{review}

Setupattempts 1 endpoints

GET /v1/setup_attempts

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/setup_attempts

Setupintents 2 endpoints

GET /v1/setup_intents

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/setup_intents
GET /v1/setup_intents/{intent}

Retrieves the details of a SetupIntent that has previously been created.

Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string.

When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the SetupIntent 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/setup_intents/{intent}

Shippingrates 2 endpoints

GET /v1/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/shipping_rates
GET /v1/shipping_rates/{shipping_rate_token}

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/shipping_rates/{shipping_rate_token}

Sigma 2 endpoints

GET /v1/sigma/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/sigma/scheduled_query_runs
GET /v1/sigma/scheduled_query_runs/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/sigma/scheduled_query_runs/{scheduled_query_run}

Sources 4 endpoints

GET /v1/sources/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

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

application/x-www-form-urlencoded

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/sources/{source}/source_transactions
GET /v1/sources/{source}/source_transactions/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

Subscriptionitems 2 endpoints

GET /v1/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/subscription_items
GET /v1/subscription_items/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/subscription_items/{item}

Subscriptionschedules 2 endpoints

GET /v1/subscription_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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/subscription_schedules
GET /v1/subscription_schedules/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/subscription_schedules/{schedule}

Subscriptions 3 endpoints

GET /v1/subscriptions

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

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. 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/subscriptions
GET /v1/subscriptions/search

Search for subscriptions you’ve previously created using Stripe’s Search Query Language. 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 and the list of supported query fields for subscriptions.

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/subscriptions/search
GET /v1/subscriptions/{subscription_exposed_id}

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/subscriptions/{subscription_exposed_id}

Tax 8 endpoints

GET /v1/tax/associations/find

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 id

Request Body

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/tax/associations/find
GET /v1/tax/calculations/{calculation}

Retrieves a Tax Calculation 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/tax/calculations/{calculation}
GET /v1/tax/calculations/{calculation}/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

Returns a list of Tax Registration 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/tax/registrations
GET /v1/tax/registrations/{id}

Returns a Tax Registration 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/tax/registrations/{id}
GET /v1/tax/settings

Retrieves Tax Settings 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

Retrieves a Tax Transaction 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/tax/transactions/{transaction}
GET /v1/tax/transactions/{transaction}/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

Taxcodes 2 endpoints

GET /v1/tax_codes

A list of all tax codes available 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/tax_codes
GET /v1/tax_codes/{id}

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/tax_codes/{id}

Taxids 2 endpoints

GET /v1/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/tax_ids
GET /v1/tax_ids/{id}

Retrieves an account or customer tax_id 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/tax_ids/{id}

Taxrates 2 endpoints

GET /v1/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/tax_rates
GET /v1/tax_rates/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/tax_rates/{tax_rate}

Terminal 6 endpoints

GET /v1/terminal/configurations

Returns a list of Configuration 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/terminal/configurations
GET /v1/terminal/configurations/{configuration}

Retrieves a Configuration 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/terminal/configurations/{configuration}
GET /v1/terminal/locations

Returns a list of Location 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/terminal/locations
GET /v1/terminal/locations/{location}

Retrieves a Location 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/terminal/locations/{location}
GET /v1/terminal/readers

Returns a list of Reader 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/terminal/readers
GET /v1/terminal/readers/{reader}

Retrieves a Reader 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/terminal/readers/{reader}

Testhelpers 2 endpoints

GET /v1/test_helpers/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/test_helpers/test_clocks
GET /v1/test_helpers/test_clocks/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/test_helpers/test_clocks/{test_clock}

Tokens 1 endpoints

GET /v1/tokens/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/tokens/{token}

Topups 2 endpoints

GET /v1/topups

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/topups
GET /v1/topups/{topup}

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/topups/{topup}

Transfers 4 endpoints

GET /v1/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/transfers
GET /v1/transfers/{id}/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 limit and starting_after 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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/transfers/{id}/reversals
GET /v1/transfers/{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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

Treasury 21 endpoints

GET /v1/treasury/credit_reversals

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/treasury/credit_reversals
GET /v1/treasury/credit_reversals/{credit_reversal}

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/treasury/credit_reversals/{credit_reversal}
GET /v1/treasury/debit_reversals

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/treasury/debit_reversals
GET /v1/treasury/debit_reversals/{debit_reversal}

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/treasury/debit_reversals/{debit_reversal}
GET /v1/treasury/financial_accounts

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/treasury/financial_accounts/{financial_account}
GET /v1/treasury/financial_accounts/{financial_account}/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

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

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/treasury/inbound_transfers
GET /v1/treasury/inbound_transfers/{id}

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/treasury/inbound_transfers/{id}
GET /v1/treasury/outbound_payments

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/treasury/outbound_payments
GET /v1/treasury/outbound_payments/{id}

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/treasury/outbound_payments/{id}
GET /v1/treasury/outbound_transfers

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/treasury/outbound_transfers
GET /v1/treasury/outbound_transfers/{outbound_transfer}

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/treasury/outbound_transfers/{outbound_transfer}
GET /v1/treasury/received_credits

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/treasury/received_credits
GET /v1/treasury/received_credits/{id}

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/treasury/received_credits/{id}
GET /v1/treasury/received_debits

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/treasury/received_debits
GET /v1/treasury/received_debits/{id}

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/treasury/received_debits/{id}
GET /v1/treasury/transaction_entries

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/treasury/transaction_entries
GET /v1/treasury/transaction_entries/{id}

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/treasury/transaction_entries/{id}
GET /v1/treasury/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/treasury/transactions
GET /v1/treasury/transactions/{id}

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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/treasury/transactions/{id}

Webhookendpoints 2 endpoints

GET /v1/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

application/x-www-form-urlencoded

Responses

default

Error response.

200

Successful response.

GET /v1/webhook_endpoints
GET /v1/webhook_endpoints/{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

application/x-www-form-urlencoded

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."
    },
    "sunbit_payments": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the Sunbit capability of the account, or whether the account can directly process Sunbit payments."
    },
    "app_distribution": {
      "enum": [
        "active",
        "inactive",
        "pending"
      ],
      "type": "string",
      "description": "The status of the `app_distribution` capability of the account, or whether the platform can distribute apps to other accounts."
    },
    "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"
  ]
}

Versions

Version Endpoints Schemas Ingested Status
2026-04-22.dahlia 587 1385 2026-04-27 current
2026-03-25.dahlia 587 1359 2026-04-19