How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Stripe Customer API

The Customer API from Stripe — 24 operation(s) for customer.

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

45 operations 24 paths 70 schemas 8 DELETE20 GET17 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2023-10-16
Server
https://api.stripe.com/
Authentication
HTTP Basic, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 2

Stripe Customer API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (auth-scheme) (bearerAuth). By default, every request must be authenticated.

  • basicAuth — Basic HTTP authentication. Allowed headers-- Authorization: Basic | Authorization: Basic
  • bearerAuth — Bearer HTTP authentication. Allowed headers-- Authorization: Bearer

Paths & Operations 45

Across 24 paths, the API surfaces 45 operations — 8 DELETE, 20 GET, 17 POST. Each is listed below with its method, path, parameters, and response codes.

Customer 45
DELETE
/v1/customers/{customer}
Stripe Delete Customers Customer
deleteCustomersCustomer 1 param body → 200default
GET
/v1/customers/{customer}
Stripe Get Customers Customer
getCustomersCustomer 2 params body → 200default
POST
/v1/customers/{customer}
Stripe Post Customers Customer
postCustomersCustomer 1 param body → 200default
GET
/v1/customers/{customer}/balance_transactions
Stripe Get Customers Customer Balance Transactions
getCustomersCustomerBalanceTransactions 5 params body → 200default
POST
/v1/customers/{customer}/balance_transactions
Stripe Post Customers Customer Balance Transactions
postCustomersCustomerBalanceTransactions 1 param body → 200default
GET
/v1/customers/{customer}/balance_transactions/{transaction}
Stripe Get Customers Customer Balance Transactions Transaction
getCustomersCustomerBalanceTransactionsTransaction 3 params body → 200default
POST
/v1/customers/{customer}/balance_transactions/{transaction}
Stripe Post Customers Customer Balance Transactions Transaction
postCustomersCustomerBalanceTransactionsTransaction 2 params body → 200default
GET
/v1/customers/{customer}/bank_accountsdeprecated
Stripe Get Customers Customer Bank Accounts
getCustomersCustomerBankAccounts 5 params body → 200default
POST
/v1/customers/{customer}/bank_accounts
Stripe Post Customers Customer Bank Accounts
postCustomersCustomerBankAccounts 1 param body → 200default
DELETE
/v1/customers/{customer}/bank_accounts/{id}
Stripe Delete Customers Customer Bank Accounts Id
deleteCustomersCustomerBankAccountsId 2 params body → 200default
GET
/v1/customers/{customer}/bank_accounts/{id}deprecated
Stripe Get Customers Customer Bank Accounts Id
getCustomersCustomerBankAccountsId 3 params body → 200default
POST
/v1/customers/{customer}/bank_accounts/{id}
Stripe Post Customers Customer Bank Accounts Id
postCustomersCustomerBankAccountsId 2 params body → 200default
POST
/v1/customers/{customer}/bank_accounts/{id}/verify
Stripe Post Customers Customer Bank Accounts Id Verify
postCustomersCustomerBankAccountsIdVerify 2 params body → 200default
GET
/v1/customers/{customer}/cardsdeprecated
Stripe Get Customers Customer Cards
getCustomersCustomerCards 5 params body → 200default
POST
/v1/customers/{customer}/cards
Stripe Post Customers Customer Cards
postCustomersCustomerCards 1 param body → 200default
DELETE
/v1/customers/{customer}/cards/{id}
Stripe Delete Customers Customer Cards Id
deleteCustomersCustomerCardsId 2 params body → 200default
GET
/v1/customers/{customer}/cards/{id}deprecated
Stripe Get Customers Customer Cards Id
getCustomersCustomerCardsId 3 params body → 200default
POST
/v1/customers/{customer}/cards/{id}
Stripe Post Customers Customer Cards Id
postCustomersCustomerCardsId 2 params body → 200default
GET
/v1/customers/{customer}/cash_balance
Stripe Get Customers Customer Cash Balance
getCustomersCustomerCashBalance 2 params body → 200default
POST
/v1/customers/{customer}/cash_balance
Stripe Post Customers Customer Cash Balance
postCustomersCustomerCashBalance 1 param body → 200default
GET
/v1/customers/{customer}/cash_balance_transactions
Stripe Get Customers Customer Cash Balance Transactions
getCustomersCustomerCashBalanceTransactions 5 params body → 200default
GET
/v1/customers/{customer}/cash_balance_transactions/{transaction}
Stripe Get Customers Customer Cash Balance Transactions Transaction
getCustomersCustomerCashBalanceTransactionsTransaction 3 params body → 200default
DELETE
/v1/customers/{customer}/discount
Stripe Delete Customers Customer Discount
deleteCustomersCustomerDiscount 1 param body → 200default
GET
/v1/customers/{customer}/discount
Stripe Get Customers Customer Discount
getCustomersCustomerDiscount 2 params body → 200default
POST
/v1/customers/{customer}/funding_instructions
Stripe Post Customers Customer Funding Instructions
postCustomersCustomerFundingInstructions 1 param body → 200default
GET
/v1/customers/{customer}/payment_methods
Stripe Get Customers Customer Payment Methods
getCustomersCustomerPaymentMethods 6 params body → 200default
GET
/v1/customers/{customer}/payment_methods/{payment_method}
Stripe Get Customers Customer Payment Methods Payment Method
getCustomersCustomerPaymentMethodsPaymentMethod 3 params body → 200default
GET
/v1/customers/{customer}/sources
Stripe Get Customers Customer Sources
getCustomersCustomerSources 6 params body → 200default
POST
/v1/customers/{customer}/sources
Stripe Post Customers Customer Sources
postCustomersCustomerSources 1 param body → 200default
DELETE
/v1/customers/{customer}/sources/{id}
Stripe Delete Customers Customer Sources Id
deleteCustomersCustomerSourcesId 2 params body → 200default
GET
/v1/customers/{customer}/sources/{id}
Stripe Get Customers Customer Sources Id
getCustomersCustomerSourcesId 3 params body → 200default
POST
/v1/customers/{customer}/sources/{id}
Stripe Post Customers Customer Sources Id
postCustomersCustomerSourcesId 2 params body → 200default
POST
/v1/customers/{customer}/sources/{id}/verify
Stripe Post Customers Customer Sources Id Verify
postCustomersCustomerSourcesIdVerify 2 params body → 200default
GET
/v1/customers/{customer}/subscriptions
Stripe Get Customers Customer Subscriptions
getCustomersCustomerSubscriptions 5 params body → 200default
POST
/v1/customers/{customer}/subscriptions
Stripe Post Customers Customer Subscriptions
postCustomersCustomerSubscriptions 1 param body → 200default
DELETE
/v1/customers/{customer}/subscriptions/{subscription_exposed_id}
Stripe Delete Customers Customer Subscriptions Subscription Exposed Id
deleteCustomersCustomerSubscriptionsSubscriptionExposedId 2 params body → 200default
GET
/v1/customers/{customer}/subscriptions/{subscription_exposed_id}
Stripe Get Customers Customer Subscriptions Subscription Exposed Id
getCustomersCustomerSubscriptionsSubscriptionExposedId 3 params body → 200default
POST
/v1/customers/{customer}/subscriptions/{subscription_exposed_id}
Stripe Post Customers Customer Subscriptions Subscription Exposed Id
postCustomersCustomerSubscriptionsSubscriptionExposedId 2 params body → 200default
DELETE
/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount
Stripe Delete Customers Customer Subscriptions Subscription Exposed Id Discount
deleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount 2 params body → 200default
GET
/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount
Stripe Get Customers Customer Subscriptions Subscription Exposed Id Discount
getCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount 3 params body → 200default
GET
/v1/customers/{customer}/tax_ids
Stripe Get Customers Customer Tax Ids
getCustomersCustomerTaxIds 5 params body → 200default
POST
/v1/customers/{customer}/tax_ids
Stripe Post Customers Customer Tax Ids
postCustomersCustomerTaxIds 1 param body → 200default
DELETE
/v1/customers/{customer}/tax_ids/{id}
Stripe Delete Customers Customer Tax Ids Id
deleteCustomersCustomerTaxIdsId 2 params body → 200default
GET
/v1/customers/{customer}/tax_ids/{id}
Stripe Get Customers Customer Tax Ids Id
getCustomersCustomerTaxIdsId 3 params body → 200default
POST
/v1/payment_intents/{intent}/apply_customer_balance
Stripe Post Payment Intents Apply Customer Balance
postPaymentIntentsIntentApplyCustomerBalance 1 param body → 200default

Schemas 70

The contract defines 70 schemas that model the data the API accepts and returns. The most detailed are payment_method (43 properties), subscription (43 properties), payment_intent (39 properties), PostCustomersCustomerSubscriptionsRequest (29 properties). Each schema is shown below with its type and property counts.

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

stripe-customer-api-openapi.yml Raw ↑

Other APIs Stripe publishes across the network.

Stripe Accounts API
Stripe Balance API
Stripe Billing API
Stripe Charges API
Stripe Checkout API
Stripe Climate API
Stripe Country API
Stripe Coupons API
Stripe Credit Notes API
Stripe Customers API
Stripe Disputes API
Stripe Ephemeral Keys API
Where this information came from

This is an independent, third-party profile of Stripe Customer API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.