Stripe Customer API is one of 159 APIs that Stripe publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Customers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.
This API exposes
45 operations
across 24 paths,
and defines 70 schemas.
It is described by OpenAPI 3.2.0, at version 2023-10-16.
Requests are made against a single base URL, https://api.stripe.com/.
The identity and technical contract details declared by the specification.
customer
object
This object represents a customer of your business. Use it to create recurring charges and track payments that belong to the same customer. Related guide: [Sav…
28 properties
4 required
PostCustomersCustomerBankAccountsRequest
object
6 properties
GetCustomersCustomerCardsIdRequest
object
GetCustomersCustomerBalanceTransactionsRequest
object
PostCustomersCustomerSourcesIdVerifyRequest
object
2 properties
CustomerCashBalanceTransactionList
object
4 properties
4 required
DeleteCustomersCustomerSourcesIdRequest
object
1 property
payment_method
object
PaymentMethod objects represent your customer's payment instruments. You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) t…
43 properties
6 required
DeleteCustomersCustomerDiscountRequest
object
GetCustomersCustomerBankAccountsIdRequest
object
BankAccountList
object
4 properties
4 required
subscription
object
Subscriptions allow you to charge a customer on a recurring basis. Related guide: [Creating subscriptions](https://stripe.com/docs/billing/subscriptions/creati…
43 properties
16 required
PostCustomersCustomerBankAccountsIdVerifyRequest
object
2 properties
GetCustomersCustomerDiscountRequest
object
GetCustomersCustomerSubscriptionsRequest
object
PostCustomersCustomerFundingInstructionsRequest
object
4 properties
3 required
payment_intent
object
A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each orde…
39 properties
10 required
GetCustomersCustomerBankAccountsRequest
object
deleted_customer
object
3 properties
3 required
GetCustomersCustomerSourcesIdRequest
object
PostCustomersCustomerCardsRequest
object
6 properties
ApmsSourcesSourceList
object
4 properties
4 required
DeleteCustomersCustomerTaxIdsIdRequest
object
GetCustomersCustomerCashBalanceTransactionsRequest
object
PostCustomersCustomerBalanceTransactionsRequest
object
5 properties
2 required
card
object
You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer t…
28 properties
7 required
GetCustomersCustomerBalanceTransactionsTransactionRequest
object
GetCustomersCustomerRequest
object
CardList
object
4 properties
4 required
GetCustomersCustomerSubscriptionsSubscriptionExposedIdRequest
object
tax_id
object
You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers) or account. Customer and account tax IDs get displayed on related in…
9 properties
6 required
PostPaymentIntentsIntentApplyCustomerBalanceRequest
object
3 properties
PostCustomersCustomerCashBalanceRequest
object
2 properties
CustomerBalanceTransactionList
object
4 properties
4 required
PostCustomersCustomerSubscriptionsRequest
object
29 properties
CustomerPaymentMethodResourceList
object
4 properties
4 required
DeleteCustomersCustomerRequest
object
GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscountRequest
object
PostCustomersCustomerCardsIdRequest
object
14 properties
GetCustomersCustomerPaymentMethodsRequest
object
GetCustomersCustomerPaymentMethodsPaymentMethodRequest
object
GetCustomersCustomerCashBalanceTransactionsTransactionRequest
object
GetCustomersCustomerTaxIdsIdRequest
object
DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdRequest
object
3 properties
error
object
An error response from the Stripe API
1 property
1 required
customer_cash_balance_transaction
object
Customers with certain payments enabled have a cash balance, representing funds that were paid by the customer to a merchant, but have not yet been allocated t…
15 properties
9 required
bank_account
object
These bank accounts are payment methods on Customer objects. On the other hand [External Accounts](https://stripe.com/docs/apiexternalaccounts) are transfer de…
19 properties
6 required
funding_instructions
object
Each customer has a [balance](https://stripe.com/docs/api/customers/objectcustomerobject-balance) that is automatically applied to future invoices and payments…
5 properties
5 required
DeleteCustomersCustomerCardsIdRequest
object
1 property
DeleteCustomersCustomerBankAccountsIdRequest
object
1 property
SubscriptionList
object
4 properties
4 required
PostCustomersCustomerSourcesIdRequest
object
14 properties
DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscountRequest
object
PostCustomersCustomerSourcesRequest
object
6 properties
deleted_discount
object
11 properties
5 required
customer_balance_transaction
object
Each customer has a [Balance](https://stripe.com/docs/api/customers/objectcustomerobject-balance) value, which denotes a debit or credit that's automatically a…
13 properties
9 required
TaxIDsList
object
4 properties
4 required
GetCustomersCustomerCashBalanceRequest
object
PostCustomersCustomerTaxIdsRequest
object
3 properties
2 required
PostCustomersCustomerBankAccountsIdRequest
object
14 properties
GetCustomersCustomerTaxIdsRequest
object
GetCustomersCustomerSourcesRequest
object
PostCustomersCustomerRequest
object
25 properties
PostCustomersCustomerBalanceTransactionsTransactionRequest
object
3 properties
deleted_tax_id
object
3 properties
3 required
discount
object
A discount represents the actual application of a [coupon](https://stripe.com/docs/apicoupons) or [promotion code](https://stripe.com/docs/apipromotioncodes).…
11 properties
4 required
cash_balance
object
A customer's Cash balance represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment…
5 properties
4 required
GetCustomersCustomerCardsRequest
object
PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequest
object
29 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Stripe publishes across the network.