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

The Get API from Stripe — 106 operation(s) for get.

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

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 106 operations across 106 paths, and defines 200 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/.

106 operations 106 paths 200 schemas 106 GET

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

Across 106 paths, the API surfaces 106 operations — 106 GET. Each is listed below with its method, path, parameters, and response codes.

Get 106
GET
/v1/apps/secrets
Stripe Get Apps Secrets
getAppsSecrets 5 params body → 200default
GET
/v1/apps/secrets/find
Stripe Get Apps Secrets Find
getAppsSecretsFind 3 params body → 200default
GET
/v1/balance
Stripe Get Balance
getBalance 1 param body → 200default
GET
/v1/balance/history
Stripe Get Balance History
getBalanceHistory 9 params body → 200default
GET
/v1/balance/history/{id}
Stripe Get Balance History Id
getBalanceHistoryId 2 params body → 200default
GET
/v1/balance_transactions
Stripe Get Balance Transactions
getBalanceTransactions 9 params body → 200default
GET
/v1/balance_transactions/{id}
Stripe Get Balance Transactions Id
getBalanceTransactionsId 2 params body → 200default
GET
/v1/billing_portal/configurations
Stripe Get Billing Portal Configurations
getBillingPortalConfigurations 6 params body → 200default
GET
/v1/billing_portal/configurations/{configuration}
Stripe Get Billing Portal Configurations Configuration
getBillingPortalConfigurationsConfiguration 2 params body → 200default
GET
/v1/checkout/sessions
Stripe Get Checkout Sessions
getCheckoutSessions 11 params body → 200default
GET
/v1/checkout/sessions/{session}
Stripe Get Checkout Sessions Session
getCheckoutSessionsSession 2 params body → 200default
GET
/v1/checkout/sessions/{session}/line_items
Stripe Get Checkout Sessions Session Line Items
getCheckoutSessionsSessionLineItems 5 params body → 200default
GET
/v1/country_specs
Stripe Get Country Specs
getCountrySpecs 4 params body → 200default
GET
/v1/country_specs/{country}
Stripe Get Country Specs Country
getCountrySpecsCountry 2 params body → 200default
GET
/v1/coupons
Stripe Get Coupons
getCoupons 5 params body → 200default
GET
/v1/coupons/{coupon}
Stripe Get Coupons Coupon
getCouponsCoupon 2 params body → 200default
GET
/v1/credit_notes
Stripe Get Credit Notes
getCreditNotes 6 params body → 200default
GET
/v1/credit_notes/preview
Stripe Get Credit Notes Preview
getCreditNotesPreview 13 params body → 200default
GET
/v1/credit_notes/preview/lines
Stripe Get Credit Notes Preview Lines
getCreditNotesPreviewLines 16 params body → 200default
GET
/v1/credit_notes/{credit_note}/lines
Stripe Get Credit Notes Credit Note Lines
getCreditNotesCreditNoteLines 5 params body → 200default
GET
/v1/credit_notes/{id}
Stripe Get Credit Notes Id
getCreditNotesId 2 params body → 200default
GET
/v1/customers
Stripe Get Customers
getCustomers 7 params body → 200default
GET
/v1/customers/search
Stripe Get Customers Search
getCustomersSearch 4 params body → 200default
GET
/v1/customers/{customer}
Stripe Get Customers Customer
getCustomersCustomer 2 params body → 200default
GET
/v1/customers/{customer}/balance_transactions
Stripe Get Customers Customer Balance Transactions
getCustomersCustomerBalanceTransactions 5 params body → 200default
GET
/v1/customers/{customer}/balance_transactions/{transaction}
Stripe Get Customers Customer Balance Transactions Transaction
getCustomersCustomerBalanceTransactionsTransaction 3 params body → 200default
GET
/v1/customers/{customer}/bank_accountsdeprecated
Stripe Get Customers Customer Bank Accounts
getCustomersCustomerBankAccounts 5 params body → 200default
GET
/v1/customers/{customer}/bank_accounts/{id}deprecated
Stripe Get Customers Customer Bank Accounts Id
getCustomersCustomerBankAccountsId 3 params body → 200default
GET
/v1/customers/{customer}/cardsdeprecated
Stripe Get Customers Customer Cards
getCustomersCustomerCards 5 params body → 200default
GET
/v1/customers/{customer}/cards/{id}deprecated
Stripe Get Customers Customer Cards Id
getCustomersCustomerCardsId 3 params body → 200default
GET
/v1/customers/{customer}/cash_balance
Stripe Get Customers Customer Cash Balance
getCustomersCustomerCashBalance 2 params 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
GET
/v1/customers/{customer}/discount
Stripe Get Customers Customer Discount
getCustomersCustomerDiscount 2 params 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
GET
/v1/customers/{customer}/sources/{id}
Stripe Get Customers Customer Sources Id
getCustomersCustomerSourcesId 3 params body → 200default
GET
/v1/customers/{customer}/subscriptions
Stripe Get Customers Customer Subscriptions
getCustomersCustomerSubscriptions 5 params body → 200default
GET
/v1/customers/{customer}/subscriptions/{subscription_exposed_id}
Stripe Get Customers Customer Subscriptions Subscription Exposed Id
getCustomersCustomerSubscriptionsSubscriptionExposedId 3 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
GET
/v1/customers/{customer}/tax_ids/{id}
Stripe Get Customers Customer Tax Ids Id
getCustomersCustomerTaxIdsId 3 params body → 200default
GET
/v1/disputes
Stripe Get Disputes
getDisputes 7 params body → 200default
GET
/v1/disputes/{dispute}
Stripe Get Disputes Dispute
getDisputesDispute 2 params body → 200default
GET
/v1/events
Stripe Get Events
getEvents 8 params body → 200default
GET
/v1/events/{id}
Stripe Get Events Id
getEventsId 2 params body → 200default
GET
/v1/exchange_rates
Stripe Get Exchange Rates
getExchangeRates 4 params body → 200default
GET
/v1/exchange_rates/{rate_id}
Stripe Get Exchange Rates Rate Id
getExchangeRatesRateId 2 params body → 200default
GET
/v1/files
Stripe Get Files
getFiles 6 params body → 200default
GET
/v1/files/{file}
Stripe Get Files File
getFilesFile 2 params body → 200default
GET
/v1/financial_connections/accounts
Stripe Get Financial Connections Accounts
getFinancialConnectionsAccounts 6 params body → 200default
GET
/v1/financial_connections/accounts/{account}
Stripe Get Financial Connections Accounts
getFinancialConnectionsAccountsAccount 2 params body → 200default
GET
/v1/financial_connections/accounts/{account}/owners
Stripe Get Financial Connections Accounts Owners
getFinancialConnectionsAccountsAccountOwners 6 params body → 200default
GET
/v1/financial_connections/sessions/{session}
Stripe Get Financial Connections Sessions Session
getFinancialConnectionsSessionsSession 2 params body → 200default
GET
/v1/financial_connections/transactions
Stripe Get Financial Connections Transactions
getFinancialConnectionsTransactions 7 params body → 200default
GET
/v1/financial_connections/transactions/{transaction}
Stripe Get Financial Connections Transactions Transaction
getFinancialConnectionsTransactionsTransaction 2 params body → 200default
GET
/v1/identity/verification_reports
Stripe Get Identity Verification Reports
getIdentityVerificationReports 7 params body → 200default
GET
/v1/identity/verification_reports/{report}
Stripe Get Identity Verification Reports Report
getIdentityVerificationReportsReport 2 params body → 200default
GET
/v1/identity/verification_sessions
Stripe Get Identity Verification Sessions
getIdentityVerificationSessions 6 params body → 200default
GET
/v1/identity/verification_sessions/{session}
Stripe Get Identity Verification Sessions Session
getIdentityVerificationSessionsSession 2 params body → 200default
GET
/v1/Invoice Items
Stripe Get Invoice Items
getInvoice Items 8 params body → 200default
GET
/v1/Invoice Items/{invoiceitem}
Stripe Get Invoice Items
getInvoice ItemsInvoiceitem 2 params body → 200default
GET
/v1/invoices
Stripe Get Invoices
getInvoices 10 params body → 200default
GET
/v1/invoices/search
Stripe Get Invoices Search
getInvoicesSearch 4 params body → 200default
GET
/v1/invoices/upcoming
Stripe Get Invoices Upcoming
getInvoicesUpcoming 22 params body → 200default
GET
/v1/invoices/upcoming/lines
Stripe Get Invoices Upcoming Lines
getInvoicesUpcomingLines 25 params body → 200default
GET
/v1/invoices/{invoice}
Stripe Get Invoices Invoice
getInvoicesInvoice 2 params body → 200default
GET
/v1/invoices/{invoice}/lines
Stripe Get Invoices Invoice Lines
getInvoicesInvoiceLines 5 params body → 200default
GET
/v1/issuing/authorizations
Stripe Get Issuing Authorizations
getIssuingAuthorizations 8 params body → 200default
GET
/v1/issuing/authorizations/{authorization}
Stripe Get Issuing Authorizations
getIssuingAuthorizationsAuthorization 2 params body → 200default
GET
/v1/issuing/cardholders
Stripe Get Issuing Cardholders
getIssuingCardholders 9 params body → 200default
GET
/v1/issuing/cardholders/{cardholder}
Stripe Get Issuing Cardholders
getIssuingCardholdersCardholder 2 params body → 200default
GET
/v1/issuing/cards
Stripe Get Issuing Cards
getIssuingCards 11 params body → 200default
GET
/v1/issuing/cards/{card}
Stripe Get Issuing Cards Card
getIssuingCardsCard 2 params body → 200default
GET
/v1/issuing/disputes
Stripe Get Issuing Disputes
getIssuingDisputes 7 params body → 200default
GET
/v1/issuing/disputes/{dispute}
Stripe Get Issuing Disputes
getIssuingDisputesDispute 2 params body → 200default
GET
/v1/issuing/settlements
Stripe Get Issuing Settlements
getIssuingSettlements 5 params body → 200default
GET
/v1/issuing/settlements/{settlement}
Stripe Get Issuing Settlements Settlement
getIssuingSettlementsSettlement 2 params body → 200default
GET
/v1/issuing/tokens
Stripe Get Issuing Tokens
getIssuingTokens 7 params body → 200default
GET
/v1/issuing/tokens/{token}
Stripe Get Issuing Tokens
getIssuingTokensToken 2 params body → 200default
GET
/v1/issuing/transactions
Stripe Get Issuing Transactions
getIssuingTransactions 8 params body → 200default
GET
/v1/issuing/transactions/{transaction}
Stripe Get Issuing Transactions
getIssuingTransactionsTransaction 2 params body → 200default
GET
/v1/link_account_sessions/{session}
Stripe Get Link Account Sessions Session
getLinkAccountSessionsSession 2 params body → 200default
GET
/v1/linked_accounts
Stripe Get Linked Accounts
getLinkedAccounts 6 params body → 200default
GET
/v1/linked_accounts/{account}
Stripe Get Linked Accounts
getLinkedAccountsAccount 2 params body → 200default
GET
/v1/linked_accounts/{account}/owners
Stripe Get Linked Accounts Owners
getLinkedAccountsAccountOwners 6 params body → 200default
GET
/v1/payment_intents
Stripe Get Payment Intents
getPaymentIntents 6 params body → 200default
GET
/v1/payment_intents/search
Stripe Get Payment Intents Search
getPaymentIntentsSearch 4 params body → 200default
GET
/v1/payment_intents/{intent}
Stripe Get Payment Intents
getPaymentIntentsIntent 3 params body → 200default
GET
/v1/payment_links
Stripe Get Payment Links
getPaymentLinks 5 params body → 200default
GET
/v1/payment_links/{payment_link}
Stripe Get Payment Links
getPaymentLinksPaymentLink 2 params body → 200default
GET
/v1/payment_links/{payment_link}/line_items
Stripe Get Payment Links Line Items
getPaymentLinksPaymentLinkLineItems 5 params body → 200default
GET
/v1/payment_method_configurations
Stripe Get Payment Method Configurations
getPaymentMethodConfigurations 2 params body → 200default
GET
/v1/payment_method_configurations/{configuration}
Stripe Get Payment Method Configurations
getPaymentMethodConfigurationsConfiguration 2 params body → 200default
GET
/v1/payment_method_domains
Stripe Get Payment Method Domains
getPaymentMethodDomains 6 params body → 200default
GET
/v1/payment_method_domains/{payment_method_domain}
Stripe Get Payment Method Domains
getPaymentMethodDomainsPaymentMethodDomain 2 params body → 200default
GET
/v1/payment_methods
Stripe Get Payment Methods
getPaymentMethods 6 params body → 200default
GET
/v1/payment_methods/{payment_method}
Stripe Get Payment Methods
getPaymentMethodsPaymentMethod 2 params body → 200default
GET
/v1/payouts
Stripe Get Payouts
getPayouts 8 params body → 200default
GET
/v1/payouts/{payout}
Stripe Get Payouts
getPayoutsPayout 2 params body → 200default
GET
/v1/plans
Stripe Get Plans
getPlans 7 params body → 200default
GET
/v1/plans/{plan}
Stripe Get Plans
getPlansPlan 2 params body → 200default
GET
/v1/prices
Stripe Get Prices
getPrices 11 params body → 200default
GET
/v1/prices/search
Stripe Get Prices Search
getPricesSearch 4 params body → 200default
GET
/v1/prices/{price}
Stripe Get Prices
getPricesPrice 2 params body → 200default

Schemas 200

The contract defines 200 schemas that model the data the API accepts and returns. The most detailed are invoice (81 properties), checkout.session (54 properties), subscription (43 properties), payment_method (43 properties). Each schema is shown below with its type and property counts.

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
GetEventsRequest
object
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
GetPayoutsRequest
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
GetFilesRequest
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
GetCouponsRequest
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
payment_source
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
GetBalanceRequest
object
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
GetPricesRequest
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
GetPlansRequest
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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

stripe-get-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 Get 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.