The identity and technical contract details declared by the specification.
PortalPublicResourceConfigurationList
object
4 properties
4 required
GetCustomersCustomerBalanceTransactionsRequest
object
issuing.transaction
object
Any use of an [issued card](https://stripe.com/docs/issuing) that results in funds entering or leaving your Stripe account, such as a completed purchase or ref…
22 properties
12 required
GetIssuingCardholdersRequest
object
CustomerCashBalanceTransactionList
object
4 properties
4 required
GetIssuingAuthorizationsAuthorizationRequest
object
GetCustomersCustomerBankAccountsIdRequest
object
BankAccountList
object
4 properties
4 required
GetIssuingSettlementsRequest
object
deleted_customer
object
3 properties
3 required
CustomerResourceCustomerList
object
4 properties
4 required
IssuingSettlementList
object
4 properties
4 required
SearchResult_2
object
6 properties
4 required
GetBalanceTransactionsIdRequest
object
GetInvoicesUpcomingLinesRequest
object
checkout.session
object
A Checkout Session represents your customer's session as they pay for one-time purchases or subscriptions through [Checkout](https://stripe.com/docs/payments/c…
54 properties
12 required
PlanList
object
4 properties
4 required
GetCustomersCustomerSubscriptionsSubscriptionExposedIdRequest
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
CustomerPaymentMethodResourceList
object
4 properties
4 required
coupon
object
A coupon contains information about a percent-off or amount-off discount you might want to apply to a customer. Coupons may be applied to [subscriptions](https…
17 properties
7 required
GetPaymentMethodDomainsPaymentMethodDomainRequest
object
GetCheckoutSessionsSessionRequest
object
apps.secret
object
Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends. The primary resource in Secret…
9 properties
6 required
IssuingDisputeList
object
4 properties
4 required
error
object
An error response from the Stripe API
1 property
1 required
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
GetPaymentLinksPaymentLinkRequest
object
SearchResult_3
object
6 properties
4 required
GetLinkAccountSessionsSessionRequest
object
PaymentMethodConfigResourcePaymentMethodConfigurationsList
object
4 properties
4 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
GetPricesSearchRequest
object
issuing.card
object
You can [create physical or virtual cards](https://stripe.com/docs/issuing/cards) that are issued to cardholders.
23 properties
14 required
GetFinancialConnectionsTransactionsRequest
object
GetCreditNotesRequest
object
payout
object
A Payout object is created when you receive funds from Stripe, or when you initiate a payout to either a bank account or debit card of a [connected Stripe acco…
23 properties
13 required
GetPaymentIntentsSearchRequest
object
GetFinancialConnectionsAccountsAccountOwnersRequest
object
PaymentLinksResourcePaymentLinkList
object
4 properties
4 required
billing_portal.configuration
object
A portal configuration describes the functionality and behavior of a portal session.
13 properties
10 required
GetCustomersSearchRequest
object
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
GetIssuingCardsCardRequest
object
CreditNotesList
object
4 properties
4 required
IssuingAuthorizationList
object
4 properties
4 required
GetBalanceHistoryRequest
object
BalanceTransactionsList
object
4 properties
4 required
PaymentPagesCheckoutSessionList
object
4 properties
4 required
GetIdentityVerificationSessionsRequest
object
TaxIDsList
object
4 properties
4 required
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
BankConnectionsResourceOwnerList
object
4 properties
4 required
balance
object
This is an object representing your Stripe balance. You can retrieve it to see the balance currently on your Stripe account. You can also retrieve the balance…
7 properties
4 required
SearchResult
object
6 properties
4 required
CreditNoteLinesList
object
4 properties
4 required
IssuingTransactionList
object
4 properties
4 required
NotificationEventList
object
4 properties
4 required
GetPaymentMethodConfigurationsRequest
object
GetPaymentLinksPaymentLinkLineItemsRequest
object
GetFilesFileRequest
object
GetInvoice_ItemsRequest
object
GetPaymentIntentsIntentRequest
object
GetIdentityVerificationReportsRequest
object
GetCustomersCustomerSubscriptionsRequest
object
GetCustomersCustomerDiscountRequest
object
GetBalanceTransactionsRequest
object
GetCreditNotesPreviewLinesRequest
object
GetBillingPortalConfigurationsConfigurationRequest
object
ApmsSourcesSourceList
object
4 properties
4 required
GetCustomersCustomerCashBalanceTransactionsRequest
object
GetIssuingCardsRequest
object
CouponsResourceCouponList
object
4 properties
4 required
GetCreditNotesIdRequest
object
CustomerBalanceTransactionList
object
4 properties
4 required
PayoutList
object
4 properties
4 required
dispute
object
A dispute occurs when a customer questions your charge with their card issuer. When this happens, you have the opportunity to respond to the dispute with evide…
16 properties
14 required
financial_connections.account
object
A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.
19 properties
9 required
identity.verification_session
object
A VerificationSession guides you through the process of collecting and verifying the identities of your users. It contains details about the type of verificati…
14 properties
6 required
financial_connections.session
object
A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.
10 properties
6 required
financial_connections.transaction
object
A Transaction represents a real transaction that affects a Financial Connections Account balance.
12 properties
12 required
GetInvoice_ItemsInvoiceitemRequest
object
GetDisputesDisputeRequest
object
file
object
This object represents files hosted on Stripe's servers. You can upload files with the [create file](https://stripe.com/docs/apicreatefile) request (for exampl…
11 properties
5 required
PaymentLinksResourceListLineItems
object
4 properties
4 required
GetPaymentMethodDomainsRequest
object
PriceList
object
4 properties
4 required
PaymentFlowsPaymentMethodList
object
4 properties
4 required
FileResourceFileList
object
4 properties
4 required
GetCustomersCustomerTaxIdsIdRequest
object
GetFinancialConnectionsSessionsSessionRequest
object
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
GetCouponsCouponRequest
object
ExchangeRateList
object
4 properties
4 required
GetDisputesRequest
object
GetIssuingDisputesDisputeRequest
object
GetIssuingTokensRequest
object
InvoiceLinesList
object
4 properties
4 required
GetPaymentIntentsRequest
object
GetIdentityVerificationReportsReportRequest
object
GetIssuingTransactionsRequest
object
GetCustomersCustomerSourcesRequest
object
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
GetLinkedAccountsRequest
object
GetCustomersCustomerBalanceTransactionsTransactionRequest
object
IssuingCardList
object
4 properties
4 required
payment_method_domain
object
A payment method domain represents a web domain that you have registered with Stripe. Stripe Elements use registered payment method domains to control where ce…
10 properties
10 required
InvoicesList
object
4 properties
4 required
GetLinkedAccountsAccountRequest
object
SearchResult_4
object
6 properties
4 required
GetIdentityVerificationSessionsSessionRequest
object
GelatoVerificationSessionList
object
4 properties
4 required
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
price
object
Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. [Products](https://stripe.com/docs/a…
21 properties
10 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
GetInvoicesInvoiceLinesRequest
object
GetPaymentMethodsRequest
object
GetCustomersCustomerRequest
object
CardList
object
4 properties
4 required
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
plan
object
You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/apiprices). It replaces the Plans API and is backwards compatible…
20 properties
10 required
IssuingNetworkTokenList
object
4 properties
4 required
GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscountRequest
object
GetCustomersCustomerPaymentMethodsRequest
object
PaymentMethodDomainResourcePaymentMethodDomainList
object
4 properties
4 required
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
GetCountrySpecsRequest
object
DisputeList
object
4 properties
4 required
GetCustomersCustomerPaymentMethodsPaymentMethodRequest
object
GetCreditNotesCreditNoteLinesRequest
object
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
GetFinancialConnectionsAccountsRequest
object
GetCheckoutSessionsSessionLineItemsRequest
object
GetPaymentMethodsPaymentMethodRequest
object
issuing.token
object
An issuing token object is created when an issued card is added to a digital wallet. As a [card issuer](https://stripe.com/docs/issuing), you can [view and man…
12 properties
8 required
GetPaymentLinksRequest
object
payment_link
object
A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times. When a customer…
33 properties
19 required
BankConnectionsResourceLinkedAccountList
object
4 properties
4 required
issuing.dispute
object
As a [card issuer](https://stripe.com/docs/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has oth…
12 properties
10 required
GetInvoicesUpcomingRequest
object
GetLinkedAccountsAccountOwnersRequest
object
GetCheckoutSessionsRequest
object
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
GetIssuingAuthorizationsRequest
object
GetCustomersCustomerCardsIdRequest
object
GetPlansPlanRequest
object
GetEventsIdRequest
object
issuing.cardholder
object
An Issuing Cardholder object represents an individual or business entity who is [issued](https://stripe.com/docs/issuing) cards. Related guide: [How to create…
16 properties
10 required
GetCreditNotesPreviewRequest
object
issuing.authorization
object
When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing Authorization object is created. [Authorizations](https://stripe.…
25 properties
18 required
GetCustomersRequest
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
GetCustomersCustomerBankAccountsRequest
object
country_spec
object
Stripe needs to collect certain pieces of information about each account created. These requirements can differ depending on the account's country. The Country…
8 properties
8 required
GetCustomersCustomerSourcesIdRequest
object
GetIssuingCardholdersCardholderRequest
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
InvoicesItemsList
object
4 properties
4 required
IssuingCardholderList
object
4 properties
4 required
GetCountrySpecsCountryRequest
object
issuing.settlement
object
When a non-stripe BIN is used, any use of an [issued card](https://stripe.com/docs/issuing) must be settled directly with the card network. The net amount owed…
16 properties
16 required
PaymentPagesCheckoutSessionListLineItems
object
4 properties
4 required
payment_method_configuration
object
PaymentMethodConfigurations control which payment methods are displayed to your customers when you don't explicitly specify payment method types. You can have…
41 properties
6 required
GetPricesPriceRequest
object
GetIssuingTokensTokenRequest
object
GetBillingPortalConfigurationsRequest
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
BankConnectionsResourceTransactionList
object
4 properties
4 required
GetFinancialConnectionsTransactionsTransactionRequest
object
GetCustomersCustomerCashBalanceTransactionsTransactionRequest
object
identity.verification_report
object
A VerificationReport is the result of an attempt to collect and verify data from a user. The collection of verification checks performed is determined from the…
10 properties
4 required
GetFinancialConnectionsAccountsAccountRequest
object
GetInvoicesRequest
object
GetInvoicesInvoiceRequest
object
SubscriptionList
object
4 properties
4 required
GetExchangeRatesRateIdRequest
object
GetIssuingTransactionsTransactionRequest
object
PaymentFlowsPaymentIntentList
object
4 properties
4 required
GetIssuingDisputesRequest
object
GetPaymentMethodConfigurationsConfigurationRequest
object
CountrySpecList
object
4 properties
4 required
GetExchangeRatesRequest
object
GetCustomersCustomerCashBalanceRequest
object
GetIssuingSettlementsSettlementRequest
object
GetInvoicesSearchRequest
object
GelatoVerificationReportList
object
4 properties
4 required
line_item
object
23 properties
10 required
GetCustomersCustomerTaxIdsRequest
object
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
GetPayoutsPayoutRequest
object
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Stripe publishes across the network.