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

The Identifiers API from Stripe — 15 operation(s) for identifiers.

Stripe Identifiers 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 Identifiers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 26 operations across 15 paths, and defines 46 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/.

26 operations 15 paths 46 schemas 6 DELETE11 GET9 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 Identifiers 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 26

Across 15 paths, the API surfaces 26 operations — 6 DELETE, 11 GET, 9 POST. Each is listed below with its method, path, parameters, and response codes.

Identifiers 26
GET
/v1/balance/history/{id}
Stripe Get Balance History Id
getBalanceHistoryId 2 params body → 200default
GET
/v1/balance_transactions/{id}
Stripe Get Balance Transactions Id
getBalanceTransactionsId 2 params body → 200default
GET
/v1/credit_notes/{id}
Stripe Get Credit Notes Id
getCreditNotesId 2 params body → 200default
POST
/v1/credit_notes/{id}
Stripe Post Credit Notes Id
postCreditNotesId 1 param body → 200default
POST
/v1/credit_notes/{id}/void
Stripe Post Credit Notes Id Void
postCreditNotesIdVoid 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
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
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
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
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
GET
/v1/events/{id}
Stripe Get Events Id
getEventsId 2 params body → 200default
GET
/v1/exchange_rates/{rate_id}
Stripe Get Exchange Rates Rate Id
getExchangeRatesRateId 2 params body → 200default
POST
/v1/invoices/{invoice}/lines/{line_item_id}
Stripe Post Invoices Invoice Lines Line Item Id
postInvoicesInvoiceLinesLineItemId 2 params body → 200default

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are invoice (81 properties), payment_method (43 properties), subscription (43 properties), credit_note (30 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
GetCustomersCustomerCardsIdRequest
object
GetEventsIdRequest
object
PostCustomersCustomerSourcesIdVerifyRequest
object
2 properties
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
GetCustomersCustomerBankAccountsIdRequest
object
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
deleted_customer
object
3 properties 3 required
GetCustomersCustomerSourcesIdRequest
object
DeleteCustomersCustomerTaxIdsIdRequest
object
GetBalanceTransactionsIdRequest
object
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
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
GetCreditNotesIdRequest
object
exchange_rate
object
ExchangeRate objects allow you to determine the rates that Stripe is currently using to convert from one currency to another. Since this number is variable thr…
3 properties 3 required
GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscountRequest
object
PostCustomersCustomerCardsIdRequest
object
14 properties
event
object
Events are our way of letting you know when something interesting happens in your account. When an interesting event occurs, we create a new Event object. For…
10 properties 7 required
GetBalanceHistoryIdRequest
object
credit_note
object
Issue a credit note to adjust an invoice's amount after the invoice is finalized. Related guide: [Credit notes](https://stripe.com/docs/billing/invoices/credit…
30 properties 19 required
error
object
An error response from the Stripe API
1 property 1 required
GetCustomersCustomerTaxIdsIdRequest
object
invoice
object
Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription. They contain [invoice i…
81 properties 26 required
DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdRequest
object
3 properties
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
PostCreditNotesIdRequest
object
3 properties
balance_transaction
object
Balance transactions represent funds moving through your Stripe account. Stripe creates them for every type of transaction that enters or leaves your Stripe ac…
15 properties 12 required
DeleteCustomersCustomerCardsIdRequest
object
1 property
DeleteCustomersCustomerBankAccountsIdRequest
object
1 property
PostCustomersCustomerSourcesIdRequest
object
14 properties
DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscountRequest
object
GetExchangeRatesRateIdRequest
object
deleted_discount
object
11 properties 5 required
PostInvoicesInvoiceLinesLineItemIdRequest
object
12 properties
PostCreditNotesIdVoidRequest
object
1 property
line_item
object
23 properties 10 required
payment_source
PostCustomersCustomerBankAccountsIdRequest
object
14 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
invoiceitem
object
Invoice Items represent the component lines of an [invoice](https://stripe.com/docs/api/invoices). An invoice item is added to an invoice by creating or updati…
22 properties 11 required
PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequest
object
29 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

stripe-identifiers-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 Identifiers 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.