Stripe Post API
The Post API from Stripe — 95 operation(s) for post.
Stripe Post 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 95 operations across 95 paths, and defines 136 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/.
95 operations
95 paths
136 schemas
95 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Stripe Post 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: BasicbearerAuth— Bearer HTTP authentication. Allowed headers-- Authorization: Bearer
Paths & Operations 95
Across 95 paths, the API surfaces 95 operations — 95 POST. Each is listed below with its method, path, parameters, and response codes.
Post 95
POST
/v1/apps/secrets
Stripe Post Apps Secrets
POST
/v1/apps/secrets/delete
Stripe Post Apps Secrets Delete
POST
/v1/billing_portal/configurations
Stripe Post Billing Portal Configurations
POST
/v1/billing_portal/configurations/{configuration}
Stripe Post Billing Portal Configurations Configuration
POST
/v1/billing_portal/sessions
Stripe Post Billing Portal Sessions
POST
/v1/checkout/sessions
Stripe Post Checkout Sessions
POST
/v1/checkout/sessions/{session}/expire
Stripe Post Checkout Sessions Session Expire
POST
/v1/coupons
Stripe Post Coupons
POST
/v1/coupons/{coupon}
Stripe Post Coupons Coupon
POST
/v1/credit_notes
Stripe Post Credit Notes
POST
/v1/credit_notes/{id}
Stripe Post Credit Notes Id
POST
/v1/credit_notes/{id}/void
Stripe Post Credit Notes Id Void
POST
/v1/customers
Stripe Post Customers
POST
/v1/customers/{customer}
Stripe Post Customers Customer
POST
/v1/customers/{customer}/balance_transactions
Stripe Post Customers Customer Balance Transactions
POST
/v1/customers/{customer}/balance_transactions/{transaction}
Stripe Post Customers Customer Balance Transactions Transaction
POST
/v1/customers/{customer}/bank_accounts
Stripe Post Customers Customer Bank Accounts
POST
/v1/customers/{customer}/bank_accounts/{id}
Stripe Post Customers Customer Bank Accounts Id
POST
/v1/customers/{customer}/bank_accounts/{id}/verify
Stripe Post Customers Customer Bank Accounts Id Verify
POST
/v1/customers/{customer}/cards
Stripe Post Customers Customer Cards
POST
/v1/customers/{customer}/cards/{id}
Stripe Post Customers Customer Cards Id
POST
/v1/customers/{customer}/cash_balance
Stripe Post Customers Customer Cash Balance
POST
/v1/customers/{customer}/funding_instructions
Stripe Post Customers Customer Funding Instructions
POST
/v1/customers/{customer}/sources
Stripe Post Customers Customer Sources
POST
/v1/customers/{customer}/sources/{id}
Stripe Post Customers Customer Sources Id
POST
/v1/customers/{customer}/sources/{id}/verify
Stripe Post Customers Customer Sources Id Verify
POST
/v1/customers/{customer}/subscriptions
Stripe Post Customers Customer Subscriptions
POST
/v1/customers/{customer}/subscriptions/{subscription_exposed_id}
Stripe Post Customers Customer Subscriptions Subscription Exposed Id
POST
/v1/customers/{customer}/tax_ids
Stripe Post Customers Customer Tax Ids
POST
/v1/disputes/{dispute}
Stripe Post Disputes Dispute
POST
/v1/disputes/{dispute}/close
Stripe Post Disputes Dispute Close
POST
/v1/ephemeral_keys
Stripe Post Ephemeral Keys
POST
/v1/files
Stripe Post Files
POST
/v1/financial_connections/accounts/{account}/disconnect
Stripe Post Financial Connections Accounts Disconnect
POST
/v1/financial_connections/accounts/{account}/refresh
Stripe Post Financial Connections Accounts Refresh
POST
/v1/financial_connections/accounts/{account}/subscribe
Stripe Post Financial Connections Accounts Subscribe
POST
/v1/financial_connections/accounts/{account}/unsubscribe
Stripe Post Financial Connections Accounts Unsubscribe
POST
/v1/financial_connections/sessions
Stripe Post Financial Connections Sessions
POST
/v1/identity/verification_sessions
Stripe Post Identity Verification Sessions
POST
/v1/identity/verification_sessions/{session}
Stripe Post Identity Verification Sessions Session
POST
/v1/identity/verification_sessions/{session}/cancel
Stripe Post Identity Verification Sessions Session Cancel
POST
/v1/identity/verification_sessions/{session}/redact
Stripe Post Identity Verification Sessions Session Redact
POST
/v1/Invoice Items
Stripe Post Invoice Items
POST
/v1/Invoice Items/{invoiceitem}
Stripe Post Invoice Items
POST
/v1/invoices
Stripe Post Invoices
POST
/v1/invoices/{invoice}
Stripe Post Invoices Invoice
POST
/v1/invoices/{invoice}/finalize
Stripe Post Invoices Invoice Finalize
POST
/v1/invoices/{invoice}/lines/{line_item_id}
Stripe Post Invoices Invoice Lines Line Item Id
POST
/v1/invoices/{invoice}/mark_uncollectible
Stripe Post Invoices Invoice Mark Uncollectible
POST
/v1/invoices/{invoice}/pay
Stripe Post Invoices Invoice Pay
POST
/v1/invoices/{invoice}/send
Stripe Post Invoices Invoice Send
POST
/v1/invoices/{invoice}/void
Stripe Post Invoices Invoice Void
POST
/v1/issuing/authorizations/{authorization}
Stripe Post Issuing Authorizations
POST
/v1/issuing/authorizations/{authorization}/approve
Stripe Post Issuing Authorizations Approve
POST
/v1/issuing/authorizations/{authorization}/decline
Stripe Post Issuing Authorizations Decline
POST
/v1/issuing/cardholders
Stripe Post Issuing Cardholders
POST
/v1/issuing/cardholders/{cardholder}
Stripe Post Issuing Cardholders
POST
/v1/issuing/cards
Stripe Post Issuing Cards
POST
/v1/issuing/cards/{card}
Stripe Post Issuing Cards Card
POST
/v1/issuing/disputes
Stripe Post Issuing Disputes
POST
/v1/issuing/disputes/{dispute}
Stripe Post Issuing Disputes
POST
/v1/issuing/disputes/{dispute}/submit
Stripe Post Issuing DisputesSubmit
POST
/v1/issuing/settlements/{settlement}
Stripe Post Issuing Settlements Settlement
POST
/v1/issuing/tokens/{token}
Stripe Post Issuing Tokens
POST
/v1/issuing/transactions/{transaction}
Stripe Post Issuing Transactions
POST
/v1/link_account_sessions
Stripe Post Link Account Sessions
POST
/v1/linked_accounts/{account}/disconnect
Stripe Post Linked Accounts Disconnect
POST
/v1/linked_accounts/{account}/refresh
Stripe Post Linked Accounts Refresh
POST
/v1/payment_intents
Stripe Post Payment Intents
POST
/v1/payment_intents/{intent}
Stripe Post Payment Intents
POST
/v1/payment_intents/{intent}/apply_customer_balance
Stripe Post Payment Intents Apply Customer Balance
POST
/v1/payment_intents/{intent}/cancel
Stripe Post Payment Intents Cancel
POST
/v1/payment_intents/{intent}/capture
Stripe Post Payment Intents Capture
POST
/v1/payment_intents/{intent}/confirm
Stripe Post Payment Intents Confirm
POST
/v1/payment_intents/{intent}/increment_authorization
Stripe Post Payment Intents Increment Authorization
POST
/v1/payment_intents/{intent}/verify_microdeposits
Stripe Post Payment Intents Verify Microdeposits
POST
/v1/payment_links
Stripe Post Payment Links
POST
/v1/payment_links/{payment_link}
Stripe Post Payment Links
POST
/v1/payment_method_configurations
Stripe Post Payment Method Configurations
POST
/v1/payment_method_configurations/{configuration}
Stripe Post Payment Method Configurations
POST
/v1/payment_method_domains
Stripe Post Payment Method Domains
POST
/v1/payment_method_domains/{payment_method_domain}
Stripe Post Payment Method Domains
POST
/v1/payment_method_domains/{payment_method_domain}/validate
Stripe Post Payment Method Domains Validate
POST
/v1/payment_methods
Stripe Post Payment Methods
POST
/v1/payment_methods/{payment_method}
Stripe Post Payment Methods
POST
/v1/payment_methods/{payment_method}/attach
Stripe Post Payment Methods Attach
POST
/v1/payment_methods/{payment_method}/detach
Stripe Post Payment Methods Detach
POST
/v1/payouts
Stripe Post Payouts
POST
/v1/payouts/{payout}
Stripe Post Payouts
POST
/v1/payouts/{payout}/cancel
Stripe Post Payouts Cancel
POST
/v1/payouts/{payout}/reverse
Stripe Post Payouts Reverse
POST
/v1/plans
Stripe Post Plans
POST
/v1/plans/{plan}
Stripe Post Plans
POST
/v1/prices
Stripe Post Prices
POST
/v1/prices/{price}
Stripe Post Prices
Schemas 136
The contract defines 136 schemas that model the data the API accepts and returns. The most detailed are invoice (81 properties), checkout.session (54 properties), payment_method (43 properties), subscription (43 properties). Each schema is shown below with its type and property counts.
PostIssuingCardholdersCardholderRequest
object
10 properties
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
PostPayoutsPayoutRequest
object
2 properties
PostIssuingTokensTokenRequest
object
2 properties
1 required
PostIssuingCardsRequest
object
11 properties
2 required
PostPaymentIntentsIntentCaptureRequest
object
8 properties
PostCustomersCustomerFundingInstructionsRequest
object
4 properties
3 required
deleted_customer
object
3 properties
3 required
PostCustomersCustomerCardsRequest
object
6 properties
PostPaymentMethodDomainsPaymentMethodDomainValidateRequest
object
1 property
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
PostIssuingCardsCardRequest
object
6 properties
PostIssuingDisputesDisputeSubmitRequest
object
2 properties
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
PostInvoicesInvoiceVoidRequest
object
1 property
PostInvoicesInvoiceMarkUncollectibleRequest
object
1 property
PostPlansRequest
object
18 properties
2 required
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
PostCheckoutSessionsRequest
object
38 properties
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
PostPaymentIntentsIntentVerifyMicrodepositsRequest
object
4 properties
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
PostFinancialConnectionsAccountsAccountSubscribeRequest
object
2 properties
1 required
PostPaymentIntentsIntentCancelRequest
object
2 properties
PostFinancialConnectionsAccountsAccountRefreshRequest
object
2 properties
1 required
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
PostIdentityVerificationSessionsSessionCancelRequest
object
1 property
PostIssuingCardholdersRequest
object
12 properties
2 required
PostIssuingAuthorizationsAuthorizationDeclineRequest
object
2 properties
billing_portal.configuration
object
A portal configuration describes the functionality and behavior of a portal session.
13 properties
10 required
PostCustomersCustomerSourcesRequest
object
6 properties
PostBillingPortalSessionsRequest
object
7 properties
1 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
PostCustomersCustomerTaxIdsRequest
object
3 properties
2 required
PostPaymentMethodDomainsRequest
object
3 properties
1 required
PostCustomersCustomerBalanceTransactionsTransactionRequest
object
3 properties
PostFilesRequest
object
4 properties
2 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
PostCouponsCouponRequest
object
4 properties
PostPayoutsPayoutCancelRequest
object
1 property
PostCheckoutSessionsSessionExpireRequest
object
1 property
PostInvoicesRequest
object
29 properties
PostCustomersCustomerBankAccountsIdVerifyRequest
object
2 properties
PostPaymentIntentsIntentIncrementAuthorizationRequest
object
7 properties
1 required
PostPaymentLinksPaymentLinkRequest
object
19 properties
PostInvoicesInvoiceSendRequest
object
1 property
PostPaymentIntentsIntentApplyCustomerBalanceRequest
object
3 properties
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.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
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
PostBillingPortalConfigurationsConfigurationRequest
object
7 properties
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
PostCustomersCustomerCardsIdRequest
object
14 properties
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
PostInvoice_ItemsInvoiceitemRequest
object
15 properties
ephemeral_key
object
6 properties
5 required
PostPricesRequest
object
19 properties
1 required
PostFinancialConnectionsAccountsAccountUnsubscribeRequest
object
2 properties
1 required
PostFinancialConnectionsSessionsRequest
object
6 properties
2 required
PostFinancialConnectionsAccountsAccountDisconnectRequest
object
1 property
PostEphemeralKeysRequest
object
5 properties
PostPaymentMethodConfigurationsRequest
object
37 properties
PostIdentityVerificationSessionsSessionRedactRequest
object
1 property
PostPaymentMethodDomainsPaymentMethodDomainRequest
object
2 properties
PostPaymentMethodsPaymentMethodRequest
object
6 properties
PostPaymentIntentsIntentConfirmRequest
object
17 properties
PostCustomersCustomerBankAccountsIdRequest
object
14 properties
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
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
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
PostIdentityVerificationSessionsRequest
object
5 properties
1 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
PostInvoicesInvoiceFinalizeRequest
object
2 properties
PostPaymentMethodsPaymentMethodAttachRequest
object
2 properties
1 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
PostPayoutsPayoutReverseRequest
object
2 properties
PostIssuingTransactionsTransactionRequest
object
2 properties
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
PostBillingPortalConfigurationsRequest
object
6 properties
2 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
PostInvoicesInvoiceRequest
object
24 properties
PostCustomersCustomerSubscriptionsRequest
object
29 properties
PostCouponsRequest
object
13 properties
PostIssuingDisputesRequest
object
6 properties
PostLinkedAccountsAccountRefreshRequest
object
2 properties
1 required
PostIssuingDisputesDisputeRequest
object
4 properties
PostDisputesDisputeRequest
object
4 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
PostPayoutsRequest
object
9 properties
2 required
PostCustomersCustomerSourcesIdRequest
object
14 properties
PostIssuingSettlementsSettlementRequest
object
2 properties
PostPaymentIntentsIntentRequest
object
20 properties
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
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
PostIssuingAuthorizationsAuthorizationRequest
object
2 properties
PostInvoicesInvoiceLinesLineItemIdRequest
object
12 properties
PostLinkAccountSessionsRequest
object
6 properties
2 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
PostPaymentMethodsRequest
object
40 properties
PostCustomersCustomerRequest
object
25 properties
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
PostCustomersCustomerBankAccountsRequest
object
6 properties
billing_portal.session
object
The Billing customer portal is a Stripe-hosted UI for subscription and billing management. A portal configuration describes the functionality and features that…
11 properties
7 required
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
PostCustomersCustomerSourcesIdVerifyRequest
object
2 properties
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
PostPaymentMethodsPaymentMethodDetachRequest
object
1 property
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
PostLinkedAccountsAccountDisconnectRequest
object
1 property
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
PostInvoicesInvoicePayRequest
object
7 properties
PostCustomersCustomerCashBalanceRequest
object
2 properties
PostPlansPlanRequest
object
6 properties
PostPaymentIntentsRequest
object
31 properties
2 required
PostPricesPriceRequest
object
8 properties
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
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
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
PostPaymentLinksRequest
object
28 properties
1 required
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
PostCreditNotesIdRequest
object
3 properties
PostPaymentMethodConfigurationsConfigurationRequest
object
37 properties
PostIssuingAuthorizationsAuthorizationApproveRequest
object
3 properties
PostCustomersRequest
object
22 properties
PostIdentityVerificationSessionsSessionRequest
object
4 properties
line_item
object
23 properties
10 required
PostCreditNotesIdVoidRequest
object
1 property
PostCreditNotesRequest
object
13 properties
1 required
PostDisputesDisputeCloseRequest
object
1 property
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
PostInvoice_ItemsRequest
object
19 properties
1 required
PostCustomersCustomerSubscriptionsSubscriptionExposedIdRequest
object
29 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Stripe 12
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 Post 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.