How do AI agents use Stripe through Open Connector?

Your user connects Stripe once with one of its cataloged authentication methods. Open Connector stores the credential in an encrypted vault and exposes Stripe tools to your agent over MCP or a typed API, with credentials injected server-side on each call.

Is this a Stripe MCP server?

Yes. Open Connector can serve Stripe as a named MCP server with a scoped allowlist and a per-user connection URL, so any MCP client can call Stripe actions with credentials injected server-side.

Where do Stripe credentials live?

In your own infrastructure. Open Connector keeps credentials in its own vault and injects them at call time, so they never leave your environment.

Stripe integration

Stripe integration for AI agents.

Stripe integration for AI agents with secure authentication and server-side credential injection. Open Connector runs the OAuth, seals the token in an encrypted vault, and serves Stripe tools to your agent over MCP or a typed API — credentials injected server-side, every call audited, nothing leaving your infrastructure. Open source (AGPL-3.0) and self-hostable.

View source on GitHub All integrations →

What your agents can do

Real Stripe actions, managed and audited.

Your user connects Stripe once; your agent can then manage Stripe customers, subscriptions, invoices, payments, refunds, and billing operations — scoped to the OAuth permissions you grant and the tool allowlist you configure. Every action is least-privilege and written to a tamper-evident audit trail.

1
Your user grants Stripe access once (OAuth) — the token lands in the vault.
2
Your agent calls a tool over MCP or the typed API; Open Connector injects the credential server-side.
3
Every routed call appends a hash-chained audit record — nothing leaves your infra.

Tools & triggers

Supported Stripe tools.

617 tools are generated from the published Stripe catalog. Descriptions are plain text; each action remains subject to its configured authentication and tool allowlist.

Showing 617 tools. All published catalog entries are included in this page's server-rendered HTML.

Delete an account: With <a href="/connect">Connect</a>, you can delete accounts you manage. Test-mode accounts can be deleted at any time. Live-mode accounts that have access to the standard dashboard and Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. All other Live-mode accounts, can be deleted when all <a href="/api/balance/balance_object">balances</a> are zero. If you want to delete your own account, use the <a href="https://dashboard.stripe.com/settings/account">account information tab in your account settings</a> instead.; deleteaccountsaccount
Delete an external account: Delete a specified external account for a given account.; deleteaccountsaccountbankaccountsid
Delete an external account: Delete a specified external account for a given account.; deleteaccountsaccountexternalaccountsid
Delete a person: Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the <code>representative</code>. If your integration is using the <code>executive</code> parameter, you cannot delete the only verified <code>executive</code> on file.; deleteaccountsaccountpeopleperson
Delete a person: Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the <code>representative</code>. If your integration is using the <code>executive</code> parameter, you cannot delete the only verified <code>executive</code> on file.; deleteaccountsaccountpersonsperson
DeleteApplePayDomainsDomain: Delete an apple pay domain.; deleteapplepaydomainsdomain
Delete a coupon: You can delete coupons via the <a href="https://dashboard.stripe.com/coupons">coupon management</a> page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can’t redeem the coupon. You can also delete coupons via the API.; deletecouponscoupon
Delete a customer: Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.; deletecustomerscustomer
Delete a customer source: Delete a specified source for a given customer.; deletecustomerscustomerbankaccountsid
Delete a customer source: Delete a specified source for a given customer.; deletecustomerscustomercardsid
Delete a customer discount: Removes the currently applied discount on a customer.; deletecustomerscustomerdiscount
Delete a customer source: Delete a specified source for a given customer.; deletecustomerscustomersourcesid
Cancel a subscription: Cancels a customer’s subscription. If you set the <code>at_period_end</code> parameter to <code>true</code>, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default <code>false</code> value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription. Note, however, that any pending invoice items that you’ve created will still be charged for at the end of the period, unless manually <a href="/api/invoiceitems/delete">deleted</a>. If you’ve set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed. By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.; deletecustomerscustomersubscriptionssubscriptionexposedid
Delete a customer discount: Removes the currently applied discount on a customer.; deletecustomerscustomersubscriptionssubscriptionexposediddiscount
Delete a Customer tax ID: Deletes an existing <code>tax_id</code> object.; deletecustomerscustomertaxidsid
Immediately invalidate an ephemeral key: Invalidates a short-lived API key for a given resource.; deleteephemeralkeyskey
Delete an invoice item: Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they’re not attached to invoices, or if it’s attached to a draft invoice.; deleteinvoiceitemsinvoiceitem
Delete a draft invoice: Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be <a href="/api/invoices/void">voided</a>.; deleteinvoicesinvoice
Delete a plan: Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.; deleteplansplan
Delete a product: Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with <code>type=good</code> is only possible if it has no SKUs associated with it.; deleteproductsid
Remove a feature from a product: Deletes the feature attachment to a product; deleteproductsproductfeaturesid
Delete a value list item: Deletes a <code>ValueListItem</code> object, removing it from its parent value list.; deleteradarvaluelistitemsitem
Delete a value list: Deletes a <code>ValueList</code> object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.; deleteradarvaluelistsvaluelist
Delete a subscription item: Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.; deletesubscriptionitemsitem
Cancel a subscription: Cancels a customer’s subscription immediately. The customer won’t be charged again for the subscription. After it’s canceled, the subscription is largely immutable. You can still update its <a href="/metadata">metadata</a> and <code>cancellation_details</code>. Any pending invoice items that you’ve created are still charged at the end of the period, unless manually <a href="/api/invoiceitems/delete">deleted</a>. If you’ve set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if <code>invoice_now</code> and <code>prorate</code> are both set to false. By default, upon subscription cancellation, Stripe stops automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.; deletesubscriptionssubscriptionexposedid
Delete a subscription discount: Removes the currently applied discount on a subscription.; deletesubscriptionssubscriptionexposediddiscount
Delete a tax ID: Deletes an existing account or customer <code>tax_id</code> object.; deletetaxidsid
Delete a Configuration: Deletes a <code>Configuration</code> object.; deleteterminalconfigurationsconfiguration
Delete a Location: Deletes a <code>Location</code> object.; deleteterminallocationslocation
Delete a Reader: Deletes a <code>Reader</code> object.; deleteterminalreadersreader
Delete a test clock: Deletes a test clock.; deletetesthelperstestclockstestclock
Delete a person: Delete a Person associated with an Account.; deletev2coreaccountsaccountidpersonsid
Delete an Event Destination: Delete an event destination.; deletev2coreeventdestinationsid
Delete a webhook endpoint: You can also delete webhook endpoints via the <a href="https://dashboard.stripe.com/account/webhooks">webhook endpoint management</a> page of the Stripe dashboard.; deletewebhookendpointswebhookendpoint
Retrieve account: Retrieves the details of an account.; getaccount
List all connected accounts: Returns a list of accounts connected to your platform via <a href="/docs/connect">Connect</a>. If you’re not a platform, the list is empty.; getaccounts
Retrieve account: Retrieves the details of an account.; getaccountsaccount
Retrieve an external account: Retrieve a specified external account for a given account.; getaccountsaccountbankaccountsid
List all account capabilities: Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.; getaccountsaccountcapabilities
Retrieve an Account Capability: Retrieves information about the specified Account Capability.; getaccountsaccountcapabilitiescapability
List all external accounts: List external accounts for an account.; getaccountsaccountexternalaccounts
Retrieve an external account: Retrieve a specified external account for a given account.; getaccountsaccountexternalaccountsid
List all persons: Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.; getaccountsaccountpeople
Retrieve a person: Retrieves an existing person.; getaccountsaccountpeopleperson
List all persons: Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.; getaccountsaccountpersons
Retrieve a person: Retrieves an existing person.; getaccountsaccountpersonsperson
GetApplePayDomains: List apple pay domains.; getapplepaydomains
GetApplePayDomainsDomain: Retrieve an apple pay domain.; getapplepaydomainsdomain
List all application fees: Returns a list of application fees you’ve previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.; getapplicationfees
Retrieve an application fee refund: By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.; getapplicationfeesfeerefundsid
Retrieve an application fee: Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.; getapplicationfeesid
List all application fee refunds: You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the <code>limit</code> and <code>starting_after</code> parameters to page through additional refunds.; getapplicationfeesidrefunds
Retrieve balance: Retrieves the current account balance, based on the authentication that was used to make the request. For a sample request, see <a href="/docs/connect/account-balances#accounting-for-negative-balances">Accounting for negative balances</a>.; getbalance
List all balance transactions: Returns a list of transactions that have contributed to the Stripe account balance (for example, charges, transfers, and so on). The transactions return in sorted order, with the most recent transactions appearing first. The previous name of this endpoint was “Balance history,” and it used the path <code>/v1/balance/history</code>.; getbalancehistory
Retrieve a balance transaction: Retrieves the balance transaction with the given ID. Note that this endpoint previously used the path <code>/v1/balance/history/:id</code>.; getbalancehistoryid
Retrieve balance settings: Retrieves balance settings for a given connected account. Related guide: <a href="/connect/authentication">Making API calls for connected accounts</a>; getbalancesettings
List all balance transactions: Returns a list of transactions that have contributed to the Stripe account balance (for example, charges, transfers, and so on). The transactions return in sorted order, with the most recent transactions appearing first. The previous name of this endpoint was “Balance history,” and it used the path <code>/v1/balance/history</code>.; getbalancetransactions
Retrieve a balance transaction: Retrieves the balance transaction with the given ID. Note that this endpoint previously used the path <code>/v1/balance/history/:id</code>.; getbalancetransactionsid
List billing alerts: Lists billing active and inactive alerts; getbillingalerts
Retrieve a billing alert: Retrieves a billing alert given an ID; getbillingalertsid
Retrieve the credit balance summary for a customer: Retrieves the credit balance summary for a customer.; getbillingcreditbalancesummary
List credit balance transactions: Retrieve a list of credit balance transactions.; getbillingcreditbalancetransactions
Retrieve a credit balance transaction: Retrieves a credit balance transaction.; getbillingcreditbalancetransactionsid
List credit grants: Retrieve a list of credit grants.; getbillingcreditgrants
Retrieve a credit grant: Retrieves a credit grant.; getbillingcreditgrantsid
List billing meters: Retrieve a list of billing meters.; getbillingmeters
Retrieve a billing meter: Retrieves a billing meter given an ID.; getbillingmetersid
List billing meter event summaries: Retrieve a list of billing meter event summaries.; getbillingmetersideventsummaries
List portal configurations: Returns a list of configurations that describe the functionality of the customer portal.; getbillingportalconfigurations
Retrieve a portal configuration: Retrieves a configuration that describes the functionality of the customer portal.; getbillingportalconfigurationsconfiguration
List all charges: Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.; getcharges
Retrieve a charge: Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.; getchargescharge
GetChargesChargeDispute: Retrieve a dispute for a specified charge.; getchargeschargedispute
List all refunds: You can see a list of the refunds belonging to a specific charge. Note that the 10 most recent refunds are always available by default on the charge object. If you need more than those 10, you can use this API method and the <code>limit</code> and <code>starting_after</code> parameters to page through additional refunds.; getchargeschargerefunds
GetChargesChargeRefundsRefund: Retrieves the details of an existing refund.; getchargeschargerefundsrefund
Search charges: Search for charges you’ve previously created using Stripe’s <a href="/docs/search#search-query-language">Search Query Language</a>. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.; getchargessearch
List all Checkout Sessions: Returns a list of Checkout Sessions.; getcheckoutsessions
Retrieve a Checkout Session: Retrieves a Checkout Session object.; getcheckoutsessionssession
Retrieve a Checkout Session's line items: When retrieving a Checkout Session, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.; getcheckoutsessionssessionlineitems
List orders: Lists all Climate order objects. The orders are returned sorted by creation date, with the most recently created orders appearing first.; getclimateorders
Retrieve an order: Retrieves the details of a Climate order object with the given ID.; getclimateordersorder
List products: Lists all available Climate product objects.; getclimateproducts
Retrieve a product: Retrieves the details of a Climate product with the given ID.; getclimateproductsproduct
List suppliers: Lists all available Climate supplier objects.; getclimatesuppliers
Retrieve a supplier: Retrieves a Climate supplier object.; getclimatesupplierssupplier
Retrieve a ConfirmationToken: Retrieves an existing ConfirmationToken object; getconfirmationtokensconfirmationtoken
List Country Specs: Lists all Country Spec objects available in the API.; getcountryspecs
Retrieve a Country Spec: Returns a Country Spec for a given Country code.; getcountryspecscountry
List all coupons: Returns a list of your coupons.; getcoupons
Retrieve a coupon: Retrieves the coupon with the given ID.; getcouponscoupon
List all credit notes: Returns a list of credit notes.; getcreditnotes
Retrieve a credit note's line items: When retrieving a credit note, you’ll get a lines property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.; getcreditnotescreditnotelines
Retrieve a credit note: Retrieves the credit note object with the given identifier.; getcreditnotesid
Preview a credit note: Get a preview of a credit note without creating it.; getcreditnotespreview
Retrieve a credit note preview's line items: When retrieving a credit note preview, you’ll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.; getcreditnotespreviewlines
List all customers: Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.; getcustomers
Retrieve a customer: Retrieves a Customer object.; getcustomerscustomer
List customer balance transactions: Returns a list of transactions that updated the customer’s <a href="/docs/billing/customer/balance">balances</a>.; getcustomerscustomerbalancetransactions
Retrieve a customer balance transaction: Retrieves a specific customer balance transaction that updated the customer’s <a href="/docs/billing/customer/balance">balances</a>.; getcustomerscustomerbalancetransactionstransaction
List all bank accounts: You can see a list of the bank accounts belonging to a Customer. Note that the 10 most recent sources are always available by default on the Customer. If you need more than those 10, you can use this API method and the <code>limit</code> and <code>starting_after</code> parameters to page through additional bank accounts.; getcustomerscustomerbankaccounts
Retrieve a bank account: By default, you can see the 10 most recent sources stored on a Customer directly on the object, but you can also retrieve details about a specific bank account stored on the Stripe account.; getcustomerscustomerbankaccountsid
List all cards: You can see a list of the cards belonging to a customer. Note that the 10 most recent sources are always available on the <code>Customer</code> object. If you need more than those 10, you can use this API method and the <code>limit</code> and <code>starting_after</code> parameters to page through additional cards.; getcustomerscustomercards
Retrieve a card: You can always see the 10 most recent cards directly on a customer; this method lets you retrieve details about a specific card stored on the customer.; getcustomerscustomercardsid
Retrieve a cash balance: Retrieves a customer’s cash balance.; getcustomerscustomercashbalance
List cash balance transactions: Returns a list of transactions that modified the customer’s <a href="/docs/payments/customer-balance">cash balance</a>.; getcustomerscustomercashbalancetransactions
Retrieve a cash balance transaction: Retrieves a specific cash balance transaction, which updated the customer’s <a href="/docs/payments/customer-balance">cash balance</a>.; getcustomerscustomercashbalancetransactionstransaction
GetCustomersCustomerDiscount: GetCustomersCustomerDiscount; getcustomerscustomerdiscount
List a Customer's PaymentMethods: Returns a list of PaymentMethods for a given Customer; getcustomerscustomerpaymentmethods
Retrieve a Customer's PaymentMethod: Retrieves a PaymentMethod object for a given Customer.; getcustomerscustomerpaymentmethodspaymentmethod
GetCustomersCustomerSources: List sources for a specified customer.; getcustomerscustomersources
GetCustomersCustomerSourcesId: Retrieve a specified source for a given customer.; getcustomerscustomersourcesid
List active subscriptions: You can see a list of the customer’s active subscriptions. Note that the 10 most recent active subscriptions are always available by default on the customer object. If you need more than those 10, you can use the limit and starting_after parameters to page through additional subscriptions.; getcustomerscustomersubscriptions
Retrieve a subscription: Retrieves the subscription with the given ID.; getcustomerscustomersubscriptionssubscriptionexposedid
GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount: GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount; getcustomerscustomersubscriptionssubscriptionexposediddiscount
List all Customer tax IDs: Returns a list of tax IDs for a customer.; getcustomerscustomertaxids
Retrieve a Customer tax ID: Retrieves the <code>tax_id</code> object with the given identifier.; getcustomerscustomertaxidsid
Search customers: Search for customers you’ve previously created using Stripe’s <a href="/docs/search#search-query-language">Search Query Language</a>. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.; getcustomerssearch
List all disputes: Returns a list of your disputes.; getdisputes
Retrieve a dispute: Retrieves the dispute with the given ID.; getdisputesdispute
List all active entitlements: Retrieve a list of active entitlements for a customer; getentitlementsactiveentitlements
Retrieve an active entitlement: Retrieve an active entitlement; getentitlementsactiveentitlementsid
List all features: Retrieve a list of features; getentitlementsfeatures
Retrieve a feature: Retrieves a feature; getentitlementsfeaturesid
List all events: List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in <a href="https://docs.stripe.com/api/events/object">event object</a> <code>api_version</code> attribute (not according to your current Stripe API version or <code>Stripe-Version</code> header).; getevents
Retrieve an event: Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook.; geteventsid
List all exchange rates: [Deprecated] The <code>ExchangeRate</code> APIs are deprecated. Please use the <a href="https://docs.stripe.com/payments/currencies/localize-prices/fx-quotes-api">FX Quotes API</a> instead. Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.; getexchangerates
Retrieve an exchange rate: [Deprecated] The <code>ExchangeRate</code> APIs are deprecated. Please use the <a href="https://docs.stripe.com/payments/currencies/localize-prices/fx-quotes-api">FX Quotes API</a> instead. Retrieves the exchange rates from the given currency to every supported currency.; getexchangeratesrateid
List all file links: Returns a list of file links.; getfilelinks
Retrieve a file link: Retrieves the file link with the given ID.; getfilelinkslink
List all files: Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.; getfiles
Retrieve a file: Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to <a href="/docs/file-upload#download-file-contents">access file contents</a>.; getfilesfile
List Accounts: Returns a list of Financial Connections <code>Account</code> objects.; getfinancialconnectionsaccounts
Retrieve an Account: Retrieves the details of an Financial Connections <code>Account</code>.; getfinancialconnectionsaccountsaccount
List Account Owners: Lists all owners for a given <code>Account</code>; getfinancialconnectionsaccountsaccountowners
Retrieve a Session: Retrieves the details of a Financial Connections <code>Session</code>; getfinancialconnectionssessionssession
List Transactions: Returns a list of Financial Connections <code>Transaction</code> objects.; getfinancialconnectionstransactions
Retrieve a Transaction: Retrieves the details of a Financial Connections <code>Transaction</code>; getfinancialconnectionstransactionstransaction
List all ForwardingRequests: Lists all ForwardingRequest objects.; getforwardingrequests
Retrieve a ForwardingRequest: Retrieves a ForwardingRequest object.; getforwardingrequestsid
List VerificationReports: List all verification reports.; getidentityverificationreports
Retrieve a VerificationReport: Retrieves an existing VerificationReport; getidentityverificationreportsreport
List VerificationSessions: Returns a list of VerificationSessions; getidentityverificationsessions
Retrieve a VerificationSession: Retrieves the details of a VerificationSession that was previously created. When the session status is <code>requires_input</code>, you can use this method to retrieve a valid <code>client_secret</code> or <code>url</code> to allow re-submission.; getidentityverificationsessionssession
List all payments for an invoice: When retrieving an invoice, there is an includable payments property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of payments.; getinvoicepayments
Retrieve an InvoicePayment: Retrieves the invoice payment with the given ID.; getinvoicepaymentsinvoicepayment
List all invoice rendering templates: List all templates, ordered by creation date, with the most recently created template appearing first.; getinvoicerenderingtemplates
Retrieve an invoice rendering template: Retrieves an invoice rendering template with the given ID. It by default returns the latest version of the template. Optionally, specify a version to see previous versions.; getinvoicerenderingtemplatestemplate
List all invoice items: Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.; getinvoiceitems
Retrieve an invoice item: Retrieves the invoice item with the given ID.; getinvoiceitemsinvoiceitem
List all invoices: You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.; getinvoices
Retrieve an invoice: Retrieves the invoice with the given ID.; getinvoicesinvoice
Retrieve an invoice's line items: When retrieving an invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.; getinvoicesinvoicelines
Search invoices: Search for invoices you’ve previously created using Stripe’s <a href="/docs/search#search-query-language">Search Query Language</a>. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.; getinvoicessearch
List all authorizations: Returns a list of Issuing <code>Authorization</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.; getissuingauthorizations
Retrieve an authorization: Retrieves an Issuing <code>Authorization</code> object.; getissuingauthorizationsauthorization
List all cardholders: Returns a list of Issuing <code>Cardholder</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.; getissuingcardholders
Retrieve a cardholder: Retrieves an Issuing <code>Cardholder</code> object.; getissuingcardholderscardholder
List all cards: Returns a list of Issuing <code>Card</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.; getissuingcards
Retrieve a card: Retrieves an Issuing <code>Card</code> object.; getissuingcardscard
List all disputes: Returns a list of Issuing <code>Dispute</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.; getissuingdisputes
Retrieve a dispute: Retrieves an Issuing <code>Dispute</code> object.; getissuingdisputesdispute
List all personalization designs: Returns a list of personalization design objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.; getissuingpersonalizationdesigns
Retrieve a personalization design: Retrieves a personalization design object.; getissuingpersonalizationdesignspersonalizationdesign
List all physical bundles: Returns a list of physical bundle objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.; getissuingphysicalbundles
Retrieve a physical bundle: Retrieves a physical bundle object.; getissuingphysicalbundlesphysicalbundle
Retrieve a settlement: Retrieves an Issuing <code>Settlement</code> object.; getissuingsettlementssettlement
List all issuing tokens for card: Lists all Issuing <code>Token</code> objects for a given card.; getissuingtokens
Retrieve an issuing token: Retrieves an Issuing <code>Token</code> object.; getissuingtokenstoken
List all transactions: Returns a list of Issuing <code>Transaction</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.; getissuingtransactions
Retrieve a transaction: Retrieves an Issuing <code>Transaction</code> object.; getissuingtransactionstransaction
Retrieve a Session: Retrieves the details of a Financial Connections <code>Session</code>; getlinkaccountsessionssession
List Accounts: Returns a list of Financial Connections <code>Account</code> objects.; getlinkedaccounts
Retrieve an Account: Retrieves the details of an Financial Connections <code>Account</code>.; getlinkedaccountsaccount
List Account Owners: Lists all owners for a given <code>Account</code>; getlinkedaccountsaccountowners
Retrieve a Mandate: Retrieves a Mandate object.; getmandatesmandate
List Payment Attempt Records: List all the Payment Attempt Records attached to the specified Payment Record.; getpaymentattemptrecords
Retrieve a Payment Attempt Record: Retrieves a Payment Attempt Record with the given ID; getpaymentattemptrecordsid
List all PaymentIntents: Returns a list of PaymentIntents.; getpaymentintents
Retrieve a PaymentIntent: Retrieves the details of a PaymentIntent that has previously been created. You can retrieve a PaymentIntent client-side using a publishable key when the <code>client_secret</code> is in the query string. If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the <a href="#payment_intent_object">payment intent</a> object reference for more details.; getpaymentintentsintent
List all PaymentIntent LineItems: Lists all LineItems of a given PaymentIntent.; getpaymentintentsintentamountdetailslineitems
Search PaymentIntents: Search for PaymentIntents you’ve previously created using Stripe’s <a href="/docs/search#search-query-language">Search Query Language</a>. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.; getpaymentintentssearch
List all payment links: Returns a list of your payment links.; getpaymentlinks
Retrieve payment link: Retrieve a payment link.; getpaymentlinkspaymentlink
Retrieve a payment link's line items: When retrieving a payment link, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.; getpaymentlinkspaymentlinklineitems
List payment method configurations: List payment method configurations; getpaymentmethodconfigurations
Retrieve payment method configuration: Retrieve payment method configuration; getpaymentmethodconfigurationsconfiguration
List payment method domains: Lists the details of existing payment method domains.; getpaymentmethoddomains
Retrieve a payment method domain: Retrieves the details of an existing payment method domain.; getpaymentmethoddomainspaymentmethoddomain
List PaymentMethods: Returns a list of all PaymentMethods.; getpaymentmethods
Retrieve a PaymentMethod: Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use <a href="/docs/api/payment_methods/customer">Retrieve a Customer’s PaymentMethods</a>; getpaymentmethodspaymentmethod
List Payment Records: List all the Payment Records for a given merchant.; getpaymentrecords
Retrieve a Payment Record: Retrieves a Payment Record with the given ID; getpaymentrecordsid
List all payouts: Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.; getpayouts
Retrieve a payout: Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.; getpayoutspayout
List all plans: Returns a list of your plans.; getplans
Retrieve a plan: Retrieves the plan with the given ID.; getplansplan
List all prices: Returns a list of your active prices, excluding <a href="/docs/products-prices/pricing-models#inline-pricing">inline prices</a>. For the list of inactive prices, set <code>active</code> to false.; getprices
Retrieve a price: Retrieves the price with the given ID.; getpricesprice
Search prices: Search for prices you’ve previously created using Stripe’s <a href="/docs/search#search-query-language">Search Query Language</a>. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.; getpricessearch
List all products: Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.; getproducts
Retrieve a product: Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.; getproductsid
List all features attached to a product: Retrieve a list of features for a product; getproductsproductfeatures
Retrieve a product_feature: Retrieves a product_feature, which represents a feature attachment to a product; getproductsproductfeaturesid
Search products: Search for products you’ve previously created using Stripe’s <a href="/docs/search#search-query-language">Search Query Language</a>. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.; getproductssearch
List all promotion codes: Returns a list of your promotion codes.; getpromotioncodes
Retrieve a promotion code: Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing <code>code</code> use <a href="/docs/api/promotion_codes/list">list</a> with the desired <code>code</code>.; getpromotioncodespromotioncode
List all quotes: Returns a list of your quotes.; getquotes
Retrieve a quote: Retrieves the quote with the given ID.; getquotesquote
Retrieve a quote's upfront line items: When retrieving a quote, there is an includable <a href="https://stripe.com/docs/api/quotes/object#quote_object-computed-upfront-line_items">computed.upfront.line_items</a> property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.; getquotesquotecomputedupfrontlineitems
Retrieve a quote's line items: When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.; getquotesquotelineitems
Download quote PDF: Download the PDF for a finalized quote. Explanation for special handling can be found <a href="https://docs.stripe.com/quotes/overview#quote_pdf">here</a>; getquotesquotepdf
List all early fraud warnings: Returns a list of early fraud warnings.; getradarearlyfraudwarnings
Retrieve an early fraud warning: Retrieves the details of an early fraud warning that has previously been created. Please refer to the <a href="#early_fraud_warning_object">early fraud warning</a> object reference for more details.; getradarearlyfraudwarningsearlyfraudwarning
List all value list items: Returns a list of <code>ValueListItem</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.; getradarvaluelistitems
Retrieve a value list item: Retrieves a <code>ValueListItem</code> object.; getradarvaluelistitemsitem
List all value lists: Returns a list of <code>ValueList</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.; getradarvaluelists
Retrieve a value list: Retrieves a <code>ValueList</code> object.; getradarvaluelistsvaluelist
List all refunds: Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object.; getrefunds
Retrieve a refund: Retrieves the details of an existing refund.; getrefundsrefund
List all Report Runs: Returns a list of Report Runs, with the most recent appearing first.; getreportingreportruns
Retrieve a Report Run: Retrieves the details of an existing Report Run.; getreportingreportrunsreportrun
List all Report Types: Returns a full list of Report Types.; getreportingreporttypes
Retrieve a Report Type: Retrieves the details of a Report Type. (Certain report types require a <a href="https://stripe.com/docs/keys#test-live-modes">live-mode API key</a>.); getreportingreporttypesreporttype
List all open reviews: Returns a list of <code>Review</code> objects that have <code>open</code> set to <code>true</code>. The objects are sorted in descending order by creation date, with the most recently created object appearing first.; getreviews
Retrieve a review: Retrieves a <code>Review</code> object.; getreviewsreview
List all SetupAttempts: Returns a list of SetupAttempts that associate with a provided SetupIntent.; getsetupattempts
List all SetupIntents: Returns a list of SetupIntents.; getsetupintents
Retrieve a SetupIntent: Retrieves the details of a SetupIntent that has previously been created. Client-side retrieval using a publishable key is allowed when the <code>client_secret</code> is provided in the query string. When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the <a href="#setup_intent_object">SetupIntent</a> object reference for more details.; getsetupintentsintent
List all shipping rates: Returns a list of your shipping rates.; getshippingrates
Retrieve a shipping rate: Returns the shipping rate object with the given ID.; getshippingratesshippingratetoken
List all scheduled query runs: Returns a list of scheduled query runs.; getsigmascheduledqueryruns
Retrieve a scheduled query run: Retrieves the details of an scheduled query run.; getsigmascheduledqueryrunsscheduledqueryrun
Retrieve a source: Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.; getsourcessource
Retrieve a Source MandateNotification: Retrieves a new Source MandateNotification.; getsourcessourcemandatenotificationsmandatenotification
GetSourcesSourceSourceTransactions: List source transactions for a given source.; getsourcessourcesourcetransactions
Retrieve a source transaction: Retrieve an existing source transaction object. Supply the unique source ID from a source creation request and the source transaction ID and Stripe will return the corresponding up-to-date source object information.; getsourcessourcesourcetransactionssourcetransaction
List all subscription items: Returns a list of your subscription items for a given subscription.; getsubscriptionitems
Retrieve a subscription item: Retrieves the subscription item with the given ID.; getsubscriptionitemsitem
List all schedules: Retrieves the list of your subscription schedules.; getsubscriptionschedules
Retrieve a schedule: Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.; getsubscriptionschedulesschedule
List subscriptions: By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify <code>status=canceled</code>.; getsubscriptions
Search subscriptions: Search for subscriptions you’ve previously created using Stripe’s <a href="/docs/search#search-query-language">Search Query Language</a>. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.; getsubscriptionssearch
Retrieve a subscription: Retrieves the subscription with the given ID.; getsubscriptionssubscriptionexposedid
Find a Tax Association: Finds a tax association object by PaymentIntent id.; gettaxassociationsfind
Retrieve a Calculation: Retrieves a Tax <code>Calculation</code> object, if the calculation hasn’t expired.; gettaxcalculationscalculation
Retrieve a Calculation's line items: Retrieves the line items of a tax calculation as a collection, if the calculation hasn’t expired.; gettaxcalculationscalculationlineitems
List all tax codes: A list of <a href="https://stripe.com/docs/tax/tax-categories">all tax codes available</a> to add to Products in order to allow specific tax calculations.; gettaxcodes
Retrieve a tax code: Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.; gettaxcodesid
List all tax IDs: Returns a list of tax IDs.; gettaxids
Retrieve a tax ID: Retrieves an account or customer <code>tax_id</code> object.; gettaxidsid
List all tax rates: Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.; gettaxrates
Retrieve a tax rate: Retrieves a tax rate with the given ID; gettaxratestaxrate
List registrations: Returns a list of Tax <code>Registration</code> objects.; gettaxregistrations
Retrieve a registration: Returns a Tax <code>Registration</code> object.; gettaxregistrationsid
Retrieve settings: Retrieves Tax <code>Settings</code> for a merchant.; gettaxsettings
Retrieve a Transaction: Retrieves a Tax <code>Transaction</code> object.; gettaxtransactionstransaction
Retrieve a Transaction's line items: Retrieves the line items of a committed standalone transaction as a collection.; gettaxtransactionstransactionlineitems
List all Configurations: Returns a list of <code>Configuration</code> objects.; getterminalconfigurations
Retrieve a Configuration: Retrieves a <code>Configuration</code> object.; getterminalconfigurationsconfiguration
List all Locations: Returns a list of <code>Location</code> objects.; getterminallocations
Retrieve a Location: Retrieves a <code>Location</code> object.; getterminallocationslocation
List all Readers: Returns a list of <code>Reader</code> objects.; getterminalreaders
Retrieve a Reader: Retrieves a <code>Reader</code> object.; getterminalreadersreader
List all test clocks: Returns a list of your test clocks.; gettesthelperstestclocks
Retrieve a test clock: Retrieves a test clock.; gettesthelperstestclockstestclock
Retrieve a token: Retrieves the token with the given ID.; gettokenstoken
List all top-ups: Returns a list of top-ups.; gettopups
Retrieve a top-up: Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.; gettopupstopup
List all transfers: Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.; gettransfers
List all reversals: You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the <code>limit</code> and <code>starting_after</code> parameters to page through additional reversals.; gettransfersidreversals
Retrieve a transfer: Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.; gettransferstransfer
Retrieve a reversal: By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.; gettransferstransferreversalsid
List all CreditReversals: Returns a list of CreditReversals.; gettreasurycreditreversals
Retrieve a CreditReversal: Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list; gettreasurycreditreversalscreditreversal
List all DebitReversals: Returns a list of DebitReversals.; gettreasurydebitreversals
Retrieve a DebitReversal: Retrieves a DebitReversal object.; gettreasurydebitreversalsdebitreversal
List all FinancialAccounts: Returns a list of FinancialAccounts.; gettreasuryfinancialaccounts
Retrieve a FinancialAccount: Retrieves the details of a FinancialAccount.; gettreasuryfinancialaccountsfinancialaccount
Retrieve FinancialAccount Features: Retrieves Features information associated with the FinancialAccount.; gettreasuryfinancialaccountsfinancialaccountfeatures
List all InboundTransfers: Returns a list of InboundTransfers sent from the specified FinancialAccount.; gettreasuryinboundtransfers
Retrieve an InboundTransfer: Retrieves the details of an existing InboundTransfer.; gettreasuryinboundtransfersid
List all OutboundPayments: Returns a list of OutboundPayments sent from the specified FinancialAccount.; gettreasuryoutboundpayments
Retrieve an OutboundPayment: Retrieves the details of an existing OutboundPayment by passing the unique OutboundPayment ID from either the OutboundPayment creation request or OutboundPayment list.; gettreasuryoutboundpaymentsid
List all OutboundTransfers: Returns a list of OutboundTransfers sent from the specified FinancialAccount.; gettreasuryoutboundtransfers
Retrieve an OutboundTransfer: Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.; gettreasuryoutboundtransfersoutboundtransfer
List all ReceivedCredits: Returns a list of ReceivedCredits.; gettreasuryreceivedcredits
Retrieve a ReceivedCredit: Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.; gettreasuryreceivedcreditsid
List all ReceivedDebits: Returns a list of ReceivedDebits.; gettreasuryreceiveddebits
Retrieve a ReceivedDebit: Retrieves the details of an existing ReceivedDebit by passing the unique ReceivedDebit ID from the ReceivedDebit list; gettreasuryreceiveddebitsid
List all TransactionEntries: Retrieves a list of TransactionEntry objects.; gettreasurytransactionentries
Retrieve a TransactionEntry: Retrieves a TransactionEntry object.; gettreasurytransactionentriesid
List all Transactions: Retrieves a list of Transaction objects.; gettreasurytransactions
Retrieve a Transaction: Retrieves the details of an existing Transaction.; gettreasurytransactionsid
List Product Catalog Imports: Returns a list of ProductCatalogImport objects.; getv2commerceproductcatalogimports
Retrieve a Product Catalog Import: Retrieves a ProductCatalogImport by ID.; getv2commerceproductcatalogimportsid
Retrieve an account token: Retrieves an Account Token.; getv2coreaccounttokensid
List accounts: Returns a list of Accounts.; getv2coreaccounts
Retrieve a person token: Retrieves a Person Token associated with an Account.; getv2coreaccountsaccountidpersontokensid
List persons: Returns a paginated list of Persons associated with an Account.; getv2coreaccountsaccountidpersons
Retrieve a person: Retrieves a Person associated with an Account.; getv2coreaccountsaccountidpersonsid
Retrieve an account: Retrieves the details of an Account.; getv2coreaccountsid
List Event Destinations: Lists all event destinations.; getv2coreeventdestinations
Retrieve an Event Destination: Retrieves the details of an event destination.; getv2coreeventdestinationsid
List Events: List events, going back up to 30 days.; getv2coreevents
Retrieve an Event: Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which might have been delivered to your event destination.; getv2coreeventsid
List all webhook endpoints: Returns a list of your webhook endpoints.; getwebhookendpoints
Retrieve a webhook endpoint: Retrieves the webhook endpoint with the given ID.; getwebhookendpointswebhookendpoint
Create an account link: Creates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow.; postaccountlinks
Create an Account Session: Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.; postaccountsessions
Create an account: With <a href="/docs/connect">Connect</a>, you can create Stripe accounts for your users. To do this, you’ll first need to <a href="https://dashboard.stripe.com/account/applications/settings">register your platform</a>. If you’ve already collected information for your connected accounts, you <a href="/connect/marketplace/tasks/create#prefill-account-information">can prefill that information</a> when creating the account. Connect Onboarding won’t ask for the prefilled information during account onboarding. You can prefill any information on the account.; postaccounts
Update an account: Updates a <a href="/connect/accounts">connected account</a> by setting the values of the parameters passed. Any parameters not provided are left unchanged. For accounts where <a href="/api/accounts/object#account_object-controller-requirement_collection">controller.requirement_collection</a> is <code>application</code>, which includes Custom accounts, you can update any information on the account. For accounts where <a href="/api/accounts/object#account_object-controller-requirement_collection">controller.requirement_collection</a> is <code>stripe</code>, which includes Standard and Express accounts, you can update all information until you create an <a href="/api/account_links">Account Link</a> or <a href="/api/account_sessions">Account Session</a> to start Connect onboarding, after which some properties can no longer be updated. To update your own account, use the <a href="https://dashboard.stripe.com/settings/account">Dashboard</a>. Refer to our <a href="/docs/connect/updating-accounts">Connect</a> documentation to learn more about updating accounts.; postaccountsaccount
Create an external account: Create an external account for a given account.; postaccountsaccountbankaccounts
Update a bank account: Updates the metadata, account holder name, account holder type of a bank account belonging to a connected account and optionally sets it as the default for its currency. Other bank account details are not editable by design. You can only update bank accounts when <a href="/api/accounts/object#account_object-controller-requirement_collection">account.controller.requirement_collection</a> is <code>application</code>, which includes <a href="/connect/custom-accounts">Custom accounts</a>. You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.; postaccountsaccountbankaccountsid
Update an Account Capability: Updates an existing Account Capability. Request or remove a capability by updating its <code>requested</code> parameter.; postaccountsaccountcapabilitiescapability
Create an external account: Create an external account for a given account.; postaccountsaccountexternalaccounts
Update a bank account: Updates the metadata, account holder name, account holder type of a bank account belonging to a connected account and optionally sets it as the default for its currency. Other bank account details are not editable by design. You can only update bank accounts when <a href="/api/accounts/object#account_object-controller-requirement_collection">account.controller.requirement_collection</a> is <code>application</code>, which includes <a href="/connect/custom-accounts">Custom accounts</a>. You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.; postaccountsaccountexternalaccountsid
Create a login link: Creates a login link for a connected account to access the Express Dashboard. You can only create login links for accounts that use the <a href="/connect/express-dashboard">Express Dashboard</a> and are connected to your platform.; postaccountsaccountloginlinks
Create a person: Creates a new person.; postaccountsaccountpeople
Update a person: Updates an existing person.; postaccountsaccountpeopleperson
Create a person: Creates a new person.; postaccountsaccountpersons
Update a person: Updates an existing person.; postaccountsaccountpersonsperson
Reject an account: With <a href="/connect">Connect</a>, you can reject accounts that you have flagged as suspicious. Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected.; postaccountsaccountreject
Unreject an account: With Connect, you can unreject accounts that you have previously rejected. Only accounts that were rejected by your platform can be unrejected. This API cannot be used to unreject accounts that were rejected by Stripe. Unreject will only enable charges and/or payouts if there are no other restrictions other than those placed by a previous rejection. If you have separately paused charges and/or payouts outside of rejection, those pauses will remain in place after unrejection.; postaccountsaccountunreject
PostApplePayDomains: Create an apple pay domain.; postapplepaydomains
Update an application fee refund: Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request only accepts metadata as an argument.; postapplicationfeesfeerefundsid
PostApplicationFeesIdRefund: PostApplicationFeesIdRefund; postapplicationfeesidrefund
Create an application fee refund: Refunds an application fee that has previously been collected but not yet refunded. Funds will be refunded to the Stripe account from which the fee was originally collected. You can optionally refund only part of an application fee. You can do so multiple times, until the entire fee has been refunded. Once entirely refunded, an application fee can’t be refunded again. This method will raise an error when called on an already-refunded application fee, or when trying to refund more money than is left on an application fee.; postapplicationfeesidrefunds
Update balance settings: Updates balance settings for a given connected account. Related guide: <a href="/connect/authentication">Making API calls for connected accounts</a>; postbalancesettings
Create a billing alert: Creates a billing alert; postbillingalerts
Activate a billing alert: Reactivates this alert, allowing it to trigger again.; postbillingalertsidactivate
Archive a billing alert: Archives this alert, removing it from the list view and APIs. This is non-reversible.; postbillingalertsidarchive
Deactivate a billing alert: Deactivates this alert, preventing it from triggering.; postbillingalertsiddeactivate
Create a credit grant: Creates a credit grant.; postbillingcreditgrants
Update a credit grant: Updates a credit grant.; postbillingcreditgrantsid
Expire a credit grant: Expires a credit grant.; postbillingcreditgrantsidexpire
Void a credit grant: Voids a credit grant.; postbillingcreditgrantsidvoid
Create a billing meter event adjustment: Creates a billing meter event adjustment.; postbillingmetereventadjustments
Create a billing meter event: Creates a billing meter event.; postbillingmeterevents
Create a billing meter: Creates a billing meter.; postbillingmeters
Update a billing meter: Updates a billing meter.; postbillingmetersid
Deactivate a billing meter: When a meter is deactivated, no more meter events will be accepted for this meter. You can’t attach a deactivated meter to a price.; postbillingmetersiddeactivate
Reactivate a billing meter: When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.; postbillingmetersidreactivate
Create a portal configuration: Creates a configuration that describes the functionality and behavior of a PortalSession; postbillingportalconfigurations
Update a portal configuration: Updates a configuration that describes the functionality of the customer portal.; postbillingportalconfigurationsconfiguration
Create a portal session: Creates a session of the customer portal.; postbillingportalsessions
Create a charge: This method is no longer recommended—use the <a href="/docs/api/payment_intents">Payment Intents API</a> to initiate a new payment instead. Confirmation of the PaymentIntent creates the <code>Charge</code> object used to request payment.; postcharges
Update a charge: Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.; postchargescharge
Capture a charge: Capture the payment of an existing, uncaptured charge that was created with the <code>capture</code> option set to false. Uncaptured payments expire a set number of days after they are created (<a href="/docs/charges/placing-a-hold">7 by default</a>), after which they are marked as refunded and capture attempts will fail. Don’t use this method to capture a PaymentIntent-initiated charge. Use <a href="/docs/api/payment_intents/capture">Capture a PaymentIntent</a>.; postchargeschargecapture
PostChargesChargeDispute: PostChargesChargeDispute; postchargeschargedispute
PostChargesChargeDisputeClose: PostChargesChargeDisputeClose; postchargeschargedisputeclose
Create a refund: When you create a new refund, you must specify either a Charge or a PaymentIntent object. This action refunds a previously created charge that’s not refunded yet. Funds are refunded to the credit or debit card that’s originally charged. You can optionally refund only part of a charge. You can repeat this until the entire charge is refunded. After you entirely refund a charge, you can’t refund it again. This method raises an error when it’s called on an already-refunded charge, or when you attempt to refund more money than is left on a charge.; postchargeschargerefund
Create a refund: When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it. Creating a new refund will refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged. You can optionally refund only part of a charge. You can do so multiple times, until the entire charge has been refunded. Once entirely refunded, a charge can’t be refunded again. This method will raise an error when called on an already-refunded charge, or when trying to refund more money than is left on a charge.; postchargeschargerefunds
PostChargesChargeRefundsRefund: Update a specified refund.; postchargeschargerefundsrefund
Create a Checkout Session: Creates a Checkout Session object.; postcheckoutsessions
Update a Checkout Session: Updates a Checkout Session object. Related guide: <a href="/payments/advanced/dynamic-updates">Dynamically update a Checkout Session</a>; postcheckoutsessionssession
Expire a Checkout Session: A Checkout Session can be expired when it is in one of these statuses: <code>open</code> After it expires, a customer can’t complete a Checkout Session and customers loading the Checkout Session see a message saying the Checkout Session is expired.; postcheckoutsessionssessionexpire
Create an order: Creates a Climate order object for a given Climate product. The order will be processed immediately after creation and payment will be deducted your Stripe balance.; postclimateorders
Update an order: Updates the specified order by setting the values of the parameters passed.; postclimateordersorder
Cancel an order: Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the reservation <code>amount_subtotal</code>, but not the <code>amount_fees</code> for user-triggered cancellations. Frontier might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe provides 90 days advance notice and refunds the <code>amount_total</code>.; postclimateordersordercancel
Create a coupon: You can create coupons easily via the <a href="https://dashboard.stripe.com/coupons">coupon management</a> page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly. A coupon has either a <code>percent_off</code> or an <code>amount_off</code> and <code>currency</code>. If you set an <code>amount_off</code>, that amount will be subtracted from any invoice’s subtotal. For example, an invoice with a subtotal of <currency>100</currency> will have a final total of <currency>0</currency> if a coupon with an <code>amount_off</code> of <amount>200</amount> is applied to it and an invoice with a subtotal of <currency>300</currency> will have a final total of <currency>100</currency> if a coupon with an <code>amount_off</code> of <amount>200</amount> is applied to it.; postcoupons
Update a coupon: Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.; postcouponscoupon
Create a credit note: Issue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice’s <code>amount_remaining</code> (and <code>amount_due</code>), but not below zero. This amount is indicated by the credit note’s <code>pre_payment_amount</code>. The excess amount is indicated by <code>post_payment_amount</code>, and it can result in any combination of the following: <ul> <li>Refunds: create a new refund (using <code>refund_amount</code>) or link existing refunds (using <code>refunds</code>).</li> <li>Customer balance credit: credit the customer’s balance (using <code>credit_amount</code>) which will be automatically applied to their next invoice when it’s finalized.</li> <li>Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using <code>out_of_band_amount</code>).</li> </ul> The sum of refunds, customer balance credits, and outside of Stripe credits must equal the <code>post_payment_amount</code>. You may issue multiple credit notes for an invoice. Each credit note may increment the invoice’s <code>pre_payment_credit_notes_amount</code>, <code>post_payment_credit_notes_amount</code>, or both, depending on the invoice’s <code>amount_remaining</code> at the time of credit note creation. For invoices that also have refunds created through the <a href="/docs/api/refunds">Refund API</a>, the credit note API subtracts those refund amounts from the maximum creditable amount. This prevents the combined credit notes and refunds from exceeding the invoice amount. If you use both, ensure the combined total does not exceed the invoice’s paid amount.; postcreditnotes
Update a credit note: Updates an existing credit note.; postcreditnotesid
Void a credit note: Marks a credit note as void. Learn more about <a href="/docs/billing/invoices/credit-notes#voiding">voiding credit notes</a>.; postcreditnotesidvoid
Create a Customer Session: Creates a Customer Session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.; postcustomersessions
Create a customer: Creates a new customer object.; postcustomers
Update a customer: Updates the specified customer by setting the values of the parameters passed. Any parameters not provided are left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (such as a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the <code>past_due</code> state, then the latest open invoice for the subscription with automatic collection enabled is retried. This retry doesn’t count as an automatic retry, and doesn’t affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer doesn’t trigger this behavior. This request accepts mostly the same arguments as the customer creation call.; postcustomerscustomer
Create a customer balance transaction: Creates an immutable transaction that updates the customer’s credit <a href="/docs/billing/customer/balance">balance</a>.; postcustomerscustomerbalancetransactions
Update a customer credit balance transaction: Most credit balance transaction fields are immutable, but you may update its <code>description</code> and <code>metadata</code>.; postcustomerscustomerbalancetransactionstransaction
Create a card: When you create a new credit card, you must specify a customer or recipient on which to create it. If the card’s owner has no default card, then the new card will become the default. However, if the owner already has a default, then it will not change. To change the default, you should <a href="/api/customers/update">update the customer</a> to have a new <code>default_source</code>.; postcustomerscustomerbankaccounts
Update a card: Update a specified source for a given customer.; postcustomerscustomerbankaccountsid
Verify a bank account: Verify a specified bank account for a given customer.; postcustomerscustomerbankaccountsidverify
Create a card: When you create a new credit card, you must specify a customer or recipient on which to create it. If the card’s owner has no default card, then the new card will become the default. However, if the owner already has a default, then it will not change. To change the default, you should <a href="/api/customers/update">update the customer</a> to have a new <code>default_source</code>.; postcustomerscustomercards
Update a card: Update a specified source for a given customer.; postcustomerscustomercardsid
Update a cash balance's settings: Changes the settings on a customer’s cash balance.; postcustomerscustomercashbalance
Create or retrieve funding instructions for a customer cash balance: Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new funding instructions will be created. If funding instructions have already been created for a given customer, the same funding instructions will be retrieved. In other words, we will return the same funding instructions each time.; postcustomerscustomerfundinginstructions
Create a card: When you create a new credit card, you must specify a customer or recipient on which to create it. If the card’s owner has no default card, then the new card will become the default. However, if the owner already has a default, then it will not change. To change the default, you should <a href="/api/customers/update">update the customer</a> to have a new <code>default_source</code>.; postcustomerscustomersources
Update a card: Update a specified source for a given customer.; postcustomerscustomersourcesid
Verify a bank account: Verify a specified bank account for a given customer.; postcustomerscustomersourcesidverify
Create a subscription: Creates a new subscription on an existing customer.; postcustomerscustomersubscriptions
Update a subscription on a customer: Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the <a href="#upcoming_invoice">upcoming invoice</a> endpoint.; postcustomerscustomersubscriptionssubscriptionexposedid
Create a Customer tax ID: Creates a new <code>tax_id</code> object for a customer.; postcustomerscustomertaxids
Update a dispute: When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your <a href="https://dashboard.stripe.com/disputes">dashboard</a>, but if you prefer, you can use the API to submit evidence programmatically. Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our <a href="/docs/disputes/categories">guide to dispute types</a>.; postdisputesdispute
Close a dispute: Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute (accepting it), acknowledging it as lost. The status of the dispute will change from <code>needs_response</code> to <code>lost</code>. Closing a dispute is irreversible.; postdisputesdisputeclose
Create a feature: Creates a feature; postentitlementsfeatures
Updates a feature: Update a feature’s metadata or permanently deactivate it.; postentitlementsfeaturesid
Create an ephemeral key: Creates a short-lived API key for a given resource.; postephemeralkeys
Update a bank account: Updates the metadata, account holder name, account holder type of a bank account belonging to a connected account and optionally sets it as the default for its currency. Other bank account details are not editable by design. You can only update bank accounts when <a href="/api/accounts/object#account_object-controller-requirement_collection">account.controller.requirement_collection</a> is <code>application</code>, which includes <a href="/connect/custom-accounts">Custom accounts</a>. You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.; postexternalaccountsid
Create a file link: Creates a new file link object.; postfilelinks
Update a file link: Updates an existing file link object. Expired links can no longer be updated.; postfilelinkslink
Create a file from URL: Downloads a file from a public HTTPS URL with redirect, timeout, and size guards, then uploads it to Stripe as multipart/form-data.; filesuploadpostfiles
Disconnect an Account: Disables your access to a Financial Connections <code>Account</code>. You will no longer be able to access data associated with the account (e.g. balances, transactions).; postfinancialconnectionsaccountsaccountdisconnect
Refresh Account data: Refreshes the data associated with a Financial Connections <code>Account</code>.; postfinancialconnectionsaccountsaccountrefresh
Subscribe to data refreshes for an Account: Subscribes to periodic refreshes of data associated with a Financial Connections <code>Account</code>. When the account status is active, data is typically refreshed once a day.; postfinancialconnectionsaccountsaccountsubscribe
Unsubscribe from data refreshes for an Account: Unsubscribes from periodic refreshes of data associated with a Financial Connections <code>Account</code>.; postfinancialconnectionsaccountsaccountunsubscribe
Create a Session: To launch the Financial Connections authorization flow, create a <code>Session</code>. The session’s <code>client_secret</code> can be used to launch the flow using Stripe.js.; postfinancialconnectionssessions
Create a ForwardingRequest: Creates a ForwardingRequest object.; postforwardingrequests
Create a VerificationSession: Creates a VerificationSession object. After the VerificationSession is created, display a verification modal using the session <code>client_secret</code> or send your users to the session’s <code>url</code>. If your API key is in test mode, verification checks won’t actually process, though everything else will occur as if in live mode. Related guide: <a href="/docs/identity/verify-identity-documents">Verify your users’ identity documents</a>; postidentityverificationsessions
Update a VerificationSession: Updates a VerificationSession object. When the session status is <code>requires_input</code>, you can use this method to update the verification check and options.; postidentityverificationsessionssession
Cancel a VerificationSession: A VerificationSession object can be canceled when it is in <code>requires_input</code> <a href="/docs/identity/how-sessions-work">status</a>. Once canceled, future submission attempts are disabled. This cannot be undone. <a href="/docs/identity/verification-sessions#cancel">Learn more</a>.; postidentityverificationsessionssessioncancel
Redact a VerificationSession: Redact a VerificationSession to remove all collected information from Stripe. This will redact the VerificationSession and all objects related to it, including VerificationReports, Events, request logs, etc. A VerificationSession object can be redacted when it is in <code>requires_input</code> or <code>verified</code> <a href="/docs/identity/how-sessions-work">status</a>. Redacting a VerificationSession in <code>requires_action</code> state will automatically cancel it. The redaction process may take up to four days. When the redaction process is in progress, the VerificationSession’s <code>redaction.status</code> field will be set to <code>processing</code>; when the process is finished, it will change to <code>redacted</code> and an <code>identity.verification_session.redacted</code> event will be emitted. Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the fields that contain personal data will be replaced by the string <code>[redacted]</code> or a similar placeholder. The <code>metadata</code> field will also be erased. Redacted objects cannot be updated or used for any purpose. <a href="/docs/identity/verification-sessions#redact">Learn more</a>.; postidentityverificationsessionssessionredact
Archive an invoice rendering template: Updates the status of an invoice rendering template to ‘archived’ so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.; postinvoicerenderingtemplatestemplatearchive
Unarchive an invoice rendering template: Unarchive an invoice rendering template so it can be used on new Stripe objects again.; postinvoicerenderingtemplatestemplateunarchive
Create an invoice item: Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified.; postinvoiceitems
Update an invoice item: Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it’s attached to is closed.; postinvoiceitemsinvoiceitem
Create an invoice: This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you <a href="/api/invoices/finalize">finalize</a> the invoice, which allows you to <a href="/api/invoices/pay">pay</a> or <a href="/api/invoices/send">send</a> the invoice to your customers.; postinvoices
Create a preview invoice: At any time, you can preview the upcoming invoice for a subscription or subscription schedule. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice. You can also preview the effects of creating or updating a subscription or subscription schedule, including a preview of any prorations that will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the <code>subscription_details.proration_date</code> parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed on the invoice is to consider line items where <code>parent.subscription_item_details.proration</code> is <code>true</code>. Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount. Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. <a href="https://docs.stripe.com/currencies/conversions">Learn more</a>; postinvoicescreatepreview
Update an invoice: Draft invoices are fully editable. Once an invoice is <a href="/docs/billing/invoices/workflow#finalized">finalized</a>, monetary values, as well as <code>collection_method</code>, become uneditable. If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on, sending reminders for, or <a href="/docs/billing/invoices/reconciliation">automatically reconciling</a> invoices, pass <code>auto_advance=false</code>.; postinvoicesinvoice
Bulk add invoice line items: Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.; postinvoicesinvoiceaddlines
Attach a payment to an Invoice: Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of <code>payments</code>. For the PaymentIntent, when the PaymentIntent’s status changes to <code>succeeded</code>, the payment is credited to the invoice, increasing its <code>amount_paid</code>. When the invoice is fully paid, the invoice’s status becomes <code>paid</code>. If the PaymentIntent’s status is already <code>succeeded</code> when it’s attached, it’s credited to the invoice immediately. See: <a href="/docs/invoicing/partial-payments">Partial payments</a> to learn more.; postinvoicesinvoiceattachpayment
Finalize an invoice: Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method.; postinvoicesinvoicefinalize
Update an invoice's line item: Updates an invoice’s line item. Some fields, such as <code>tax_amounts</code>, only live on the invoice line item, so they can only be updated through this endpoint. Other fields, such as <code>amount</code>, live on both the invoice item and the invoice line item, so updates on this endpoint will propagate to the invoice item as well. Updating an invoice’s line item is only possible before the invoice is finalized.; postinvoicesinvoicelineslineitemid
Mark an invoice as uncollectible: Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.; postinvoicesinvoicemarkuncollectible
Pay an invoice: Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your <a href="https://dashboard.stripe.com/account/billing/automatic">subscriptions settings</a>. However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.; postinvoicesinvoicepay
Bulk remove invoice line items: Removes multiple line items from an invoice. This is only possible when an invoice is still a draft.; postinvoicesinvoiceremovelines
Send an invoice for manual payment: Stripe will automatically send invoices to customers according to your <a href="https://dashboard.stripe.com/account/billing/automatic">subscriptions settings</a>. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email. Requests made in test-mode result in no emails being sent, despite sending an <code>invoice.sent</code> event.; postinvoicesinvoicesend
Bulk update invoice line items: Updates multiple line items on an invoice. This is only possible when an invoice is still a draft.; postinvoicesinvoiceupdatelines
Void an invoice: Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to <a href="/api/invoices/delete">deletion</a>, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found. Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you’re doing business in. You might need to <a href="/api/invoices/create">issue another invoice</a> or <a href="/api/credit_notes/create">credit note</a> instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.; postinvoicesinvoicevoid
Update an authorization: Updates the specified Issuing <code>Authorization</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.; postissuingauthorizationsauthorization
Approve an authorization: [Deprecated] Approves a pending Issuing <code>Authorization</code> object. This request should be made within the timeout window of the <a href="/docs/issuing/controls/real-time-authorizations">real-time authorization</a> flow. This method is deprecated. Instead, <a href="/docs/issuing/controls/real-time-authorizations#authorization-handling">respond directly to the webhook request to approve an authorization</a>.; postissuingauthorizationsauthorizationapprove
Decline an authorization: [Deprecated] Declines a pending Issuing <code>Authorization</code> object. This request should be made within the timeout window of the <a href="/docs/issuing/controls/real-time-authorizations">real time authorization</a> flow. This method is deprecated. Instead, <a href="/docs/issuing/controls/real-time-authorizations#authorization-handling">respond directly to the webhook request to decline an authorization</a>.; postissuingauthorizationsauthorizationdecline
Create a cardholder: Creates a new Issuing <code>Cardholder</code> object that can be issued cards.; postissuingcardholders
Update a cardholder: Updates the specified Issuing <code>Cardholder</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.; postissuingcardholderscardholder
Create a card: Creates an Issuing <code>Card</code> object.; postissuingcards
Update a card: Updates the specified Issuing <code>Card</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.; postissuingcardscard
Create a dispute: Creates an Issuing <code>Dispute</code> object. Individual pieces of evidence within the <code>evidence</code> object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to <a href="/docs/issuing/purchases/disputes#dispute-reasons-and-evidence">Dispute reasons and evidence</a> for more details about evidence requirements.; postissuingdisputes
Update a dispute: Updates the specified Issuing <code>Dispute</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the <code>evidence</code> object can be unset by passing in an empty string.; postissuingdisputesdispute
Submit a dispute: Submits an Issuing <code>Dispute</code> to the card network. Stripe validates that all evidence fields required for the dispute’s reason are present. For more details, see <a href="/docs/issuing/purchases/disputes#dispute-reasons-and-evidence">Dispute reasons and evidence</a>.; postissuingdisputesdisputesubmit
Create a personalization design: Creates a personalization design object.; postissuingpersonalizationdesigns
Update a personalization design: Updates a card personalization object.; postissuingpersonalizationdesignspersonalizationdesign
Update a settlement: Updates the specified Issuing <code>Settlement</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.; postissuingsettlementssettlement
Update a token status: Attempts to update the specified Issuing <code>Token</code> object to the status specified.; postissuingtokenstoken
Update a transaction: Updates the specified Issuing <code>Transaction</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.; postissuingtransactionstransaction
Create a Session: To launch the Financial Connections authorization flow, create a <code>Session</code>. The session’s <code>client_secret</code> can be used to launch the flow using Stripe.js.; postlinkaccountsessions
Disconnect an Account: Disables your access to a Financial Connections <code>Account</code>. You will no longer be able to access data associated with the account (e.g. balances, transactions).; postlinkedaccountsaccountdisconnect
Refresh Account data: Refreshes the data associated with a Financial Connections <code>Account</code>.; postlinkedaccountsaccountrefresh
Create a PaymentIntent: Creates a PaymentIntent object. After the PaymentIntent is created, attach a payment method and <a href="/docs/api/payment_intents/confirm">confirm</a> to continue the payment. Learn more about <a href="/docs/payments/payment-intents">the available payment flows with the Payment Intents API</a>. When you use <code>confirm=true</code> during creation, it’s equivalent to creating and confirming the PaymentIntent in the same call. You can use any parameters available in the <a href="/docs/api/payment_intents/confirm">confirm API</a> when you supply <code>confirm=true</code>.; postpaymentintents
Update a PaymentIntent: Updates properties on a PaymentIntent object without confirming. Depending on which properties you update, you might need to confirm the PaymentIntent again. For example, updating the <code>payment_method</code> always requires you to confirm the PaymentIntent again. If you prefer to update and confirm at the same time, we recommend updating properties through the <a href="/docs/api/payment_intents/confirm">confirm API</a> instead.; postpaymentintentsintent
Reconcile a customer_balance PaymentIntent: Manually reconcile the remaining amount for a <code>customer_balance</code> PaymentIntent.; postpaymentintentsintentapplycustomerbalance
Cancel a PaymentIntent: You can cancel a PaymentIntent object when it’s in one of these statuses: <code>requires_payment_method</code>, <code>requires_capture</code>, <code>requires_confirmation</code>, <code>requires_action</code> or, <a href="/docs/payments/intents">in rare cases</a>, <code>processing</code>. After it’s canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a <code>status</code> of <code>requires_capture</code>, the remaining <code>amount_capturable</code> is automatically refunded. You can directly cancel the PaymentIntent for a Checkout Session only when the PaymentIntent has a status of <code>requires_capture</code>. Otherwise, you must <a href="/docs/api/checkout/sessions/expire">expire the Checkout Session</a>.; postpaymentintentsintentcancel
Capture a PaymentIntent: Capture the funds of an existing uncaptured PaymentIntent when its status is <code>requires_capture</code>. Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation. Learn more about <a href="/docs/payments/capture-later">separate authorization and capture</a>.; postpaymentintentsintentcapture
Confirm a PaymentIntent: Confirm that your customer intends to pay with current or provided payment method. Upon confirmation, the PaymentIntent will attempt to initiate a payment. If the selected payment method requires additional authentication steps, the PaymentIntent will transition to the <code>requires_action</code> status and suggest additional actions via <code>next_action</code>. If payment fails, the PaymentIntent transitions to the <code>requires_payment_method</code> status or the <code>canceled</code> status if the confirmation limit is reached. If payment succeeds, the PaymentIntent will transition to the <code>succeeded</code> status (or <code>requires_capture</code>, if <code>capture_method</code> is set to <code>manual</code>). If the <code>confirmation_method</code> is <code>automatic</code>, payment may be attempted using our <a href="/docs/stripe-js/reference#stripe-handle-card-payment">client SDKs</a> and the PaymentIntent’s <a href="#payment_intent_object-client_secret">client_secret</a>. After <code>next_action</code>s are handled by the client, no additional confirmation is required to complete the payment. If the <code>confirmation_method</code> is <code>manual</code>, all payment attempts must be initiated using a secret key. If any actions are required for the payment, the PaymentIntent will return to the <code>requires_confirmation</code> state after those actions are completed. Your server needs to then explicitly re-confirm the PaymentIntent to initiate the next payment attempt. There is a variable upper limit on how many times a PaymentIntent can be confirmed. After this limit is reached, any further calls to this endpoint will transition the PaymentIntent to the <code>canceled</code> state.; postpaymentintentsintentconfirm
Increment an authorization: Perform an incremental authorization on an eligible <a href="/docs/api/payment_intents/object">PaymentIntent</a>. To be eligible, the PaymentIntent’s status must be <code>requires_capture</code> and <a href="/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported">incremental_authorization_supported</a> must be <code>true</code>. Incremental authorizations attempt to increase the authorized amount on your customer’s card to the new, higher <code>amount</code> provided. Similar to the initial authorization, incremental authorizations can be declined. A single PaymentIntent can call this endpoint multiple times to further increase the authorized amount. If the incremental authorization succeeds, the PaymentIntent object returns with the updated <a href="/docs/api/payment_intents/object#payment_intent_object-amount">amount</a>. If the incremental authorization fails, a <a href="/docs/error-codes#card-declined">card_declined</a> error returns, and no other fields on the PaymentIntent or Charge update. The PaymentIntent object remains capturable for the previously authorized amount. Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines. After it’s captured, a PaymentIntent can no longer be incremented. Learn more about incremental authorizations with <a href="/docs/terminal/features/incremental-authorizations">in-person payments</a> and <a href="/docs/payments/incremental-authorization?platform=web&ui=elements">online payments</a>.; postpaymentintentsintentincrementauthorization
Verify microdeposits on a PaymentIntent: Verifies microdeposits on a PaymentIntent object.; postpaymentintentsintentverifymicrodeposits
Create a payment link: Creates a payment link.; postpaymentlinks
Update a payment link: Updates a payment link.; postpaymentlinkspaymentlink
Create a payment method configuration: Creates a payment method configuration; postpaymentmethodconfigurations
Update payment method configuration: Update payment method configuration; postpaymentmethodconfigurationsconfiguration
Create a payment method domain: Creates a payment method domain.; postpaymentmethoddomains
Update a payment method domain: Updates an existing payment method domain.; postpaymentmethoddomainspaymentmethoddomain
Validate an existing payment method domain: Some payment methods might require additional steps to register a domain. If the requirements weren’t satisfied when the domain was created, the payment method will be inactive on the domain. The payment method doesn’t appear in Elements or Embedded Checkout for this domain until it is active. To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint. Related guides: <a href="/docs/payments/payment-methods/pmd-registration">Payment method domains</a>.; postpaymentmethoddomainspaymentmethoddomainvalidate
Create a PaymentMethod: Creates a PaymentMethod object. Read the <a href="/docs/stripe-js/reference#stripe-create-payment-method">Stripe.js reference</a> to learn how to create PaymentMethods via Stripe.js. Instead of creating a PaymentMethod directly, we recommend using the <a href="/docs/payments/accept-a-payment">PaymentIntents</a> API to accept a payment immediately or the <a href="/docs/payments/save-and-reuse">SetupIntent</a> API to collect payment method details ahead of a future payment.; postpaymentmethods
Update a PaymentMethod: Updates a PaymentMethod object. A PaymentMethod must be attached to a customer to be updated.; postpaymentmethodspaymentmethod
Attach a PaymentMethod to a Customer: Attaches a PaymentMethod object to a Customer. To attach a new PaymentMethod to a customer for future payments, we recommend you use a <a href="/docs/api/setup_intents">SetupIntent</a> or a PaymentIntent with <a href="/docs/api/payment_intents/create#create_payment_intent-setup_future_usage">setup_future_usage</a>. These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the <code>/v1/payment_methods/:id/attach</code> endpoint without first using a SetupIntent or PaymentIntent with <code>setup_future_usage</code> does not optimize the PaymentMethod for future use, which makes later declines and payment friction more likely. See <a href="/docs/payments/payment-intents#future-usage">Optimizing cards for future payments</a> for more information about setting up future payments. To use this PaymentMethod as the default for invoice or subscription payments, set <a href="/docs/api/customers/update#update_customer-invoice_settings-default_payment_method"><code>invoice_settings.default_payment_method</code></a>, on the Customer to the PaymentMethod’s ID.; postpaymentmethodspaymentmethodattach
Detach a PaymentMethod from a Customer: Detaches a PaymentMethod object from a Customer. Detachment is permanent and irreversible — once detached, a PaymentMethod can no longer be used for payments or re-attached to a Customer.; postpaymentmethodspaymentmethoddetach
Report a payment attempt: Report a new payment attempt on the specified Payment Record. A new payment attempt can only be specified if all other payment attempts are canceled or failed.; postpaymentrecordsidreportpaymentattempt
Report payment attempt canceled: Report that the most recent payment attempt on the specified Payment Record was canceled.; postpaymentrecordsidreportpaymentattemptcanceled
Report payment attempt failed: Report that the most recent payment attempt on the specified Payment Record failed or errored.; postpaymentrecordsidreportpaymentattemptfailed
Report payment attempt guaranteed: Report that the most recent payment attempt on the specified Payment Record was guaranteed.; postpaymentrecordsidreportpaymentattemptguaranteed
Report payment attempt informational: Report informational updates on the specified Payment Record.; postpaymentrecordsidreportpaymentattemptinformational
Report a refund: Report that the most recent payment attempt on the specified Payment Record was refunded.; postpaymentrecordsidreportrefund
Report a payment: Report a new Payment Record. You may report a Payment Record as it is initialized and later report updates through the other report_* methods, or report Payment Records in a terminal state directly, through this method.; postpaymentrecordsreportpayment
Create a payout: To send funds to your own bank account, create a new payout object. Your <a href="#balance">Stripe balance</a> must cover the payout amount. If it doesn’t, you receive an “Insufficient Funds” error. If your API key is in test mode, money won’t actually be sent, though every other action occurs as if you’re in live mode. If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The <a href="/api/balances/object">balance object</a> details available and pending amounts by source type.; postpayouts
Update a payout: Updates the specified payout by setting the values of the parameters you pass. We don’t change parameters that you don’t provide. This request only accepts the metadata as arguments.; postpayoutspayout
Cancel a payout: You can cancel a previously created payout if its status is <code>pending</code>. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.; postpayoutspayoutcancel
Reverse a payout: Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US and Canadian bank accounts. If the payout is manual and in the <code>pending</code> status, use <code>/v1/payouts/:id/cancel</code> instead. By requesting a reversal through <code>/v1/payouts/:id/reverse</code>, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required.; postpayoutspayoutreverse
Create a plan: You can now model subscriptions more flexibly using the <a href="#prices">Prices API</a>. It replaces the Plans API and is backwards compatible to simplify your migration.; postplans
Update a plan: Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan’s ID, amount, currency, or billing cycle.; postplansplan
Create a price: Creates a new <a href="https://docs.stripe.com/api/prices">Price</a> for an existing <a href="https://docs.stripe.com/api/products">Product</a>. The Price can be recurring or one-time.; postprices
Update a price: Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.; postpricesprice
Create a product: Creates a new product object.; postproducts
Update a product: Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.; postproductsid
Attach a feature to a product: Creates a product_feature, which represents a feature attachment to a product; postproductsproductfeatures
Create a promotion code: A promotion code points to an underlying promotion. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.; postpromotioncodes
Update a promotion code: Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.; postpromotioncodespromotioncode
Create a quote: A quote models prices and services for a customer. Default options for <code>header</code>, <code>description</code>, <code>footer</code>, and <code>expires_at</code> can be set in the dashboard via the <a href="https://dashboard.stripe.com/settings/billing/quote">quote template</a>.; postquotes
Update a quote: A quote models prices and services for a customer.; postquotesquote
Accept a quote: Accepts the specified quote.; postquotesquoteaccept
Cancel a quote: Cancels the quote.; postquotesquotecancel
Finalize a quote: Finalizes the quote.; postquotesquotefinalize
Create a Payment Evaluation: Request a Radar API fraud risk score from Stripe for a payment before sending it for external processor authorization.; postradarpaymentevaluations
Create a value list item: Creates a new <code>ValueListItem</code> object, which is added to the specified parent value list.; postradarvaluelistitems
Create a value list: Creates a new <code>ValueList</code> object, which can then be referenced in rules.; postradarvaluelists
Update a value list: Updates a <code>ValueList</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that <code>item_type</code> is immutable.; postradarvaluelistsvaluelist
Create a refund: When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it. Creating a new refund will refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged. You can optionally refund only part of a charge. You can do so multiple times, until the entire charge has been refunded. Once entirely refunded, a charge can’t be refunded again. This method will raise an error when called on an already-refunded charge, or when trying to refund more money than is left on a charge.; postrefunds
Update a refund: Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don’t provide remain unchanged. This request only accepts <code>metadata</code> as an argument.; postrefundsrefund
Cancel a refund: Cancels a refund with a status of <code>requires_action</code>. You can’t cancel refunds in other states. Only refunds for payment methods that require customer action can enter the <code>requires_action</code> state.; postrefundsrefundcancel
Create a Report Run: Creates a new object and begin running the report. (Certain report types require a <a href="https://stripe.com/docs/keys#test-live-modes">live-mode API key</a>.); postreportingreportruns
Approve a review: Approves a <code>Review</code> object, closing it and removing it from the list of reviews.; postreviewsreviewapprove
Create a SetupIntent: Creates a SetupIntent object. After you create the SetupIntent, attach a payment method and <a href="/docs/api/setup_intents/confirm">confirm</a> it to collect any required permissions to charge the payment method later.; postsetupintents
Update a SetupIntent: Updates a SetupIntent object.; postsetupintentsintent
Cancel a SetupIntent: You can cancel a SetupIntent object when it’s in one of these statuses: <code>requires_payment_method</code>, <code>requires_confirmation</code>, or <code>requires_action</code>. After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can’t cancel the SetupIntent for a Checkout Session. <a href="/docs/api/checkout/sessions/expire">Expire the Checkout Session</a> instead.; postsetupintentsintentcancel
Confirm a SetupIntent: Confirm that your customer intends to set up the current or provided payment method. For example, you would confirm a SetupIntent when a customer hits the “Save” button on a payment method management page on your website. If the selected payment method does not require any additional steps from the customer, the SetupIntent will transition to the <code>succeeded</code> status. Otherwise, it will transition to the <code>requires_action</code> status and suggest additional actions via <code>next_action</code>. If setup fails, the SetupIntent will transition to the <code>requires_payment_method</code> status or the <code>canceled</code> status if the confirmation limit is reached.; postsetupintentsintentconfirm
Verify microdeposits on a SetupIntent: Verifies microdeposits on a SetupIntent object.; postsetupintentsintentverifymicrodeposits
Create a shipping rate: Creates a new shipping rate object.; postshippingrates
Update a shipping rate: Updates an existing shipping rate object.; postshippingratesshippingratetoken
Update an existing Sigma Query: Update an existing Sigma query that previously exists; postsigmasavedqueriesid
Create a source: Creates a new source object.; postsources
Update a source: Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts the <code>metadata</code> and <code>owner</code> as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our <a href="/docs/sources">payment method guides</a> for more detail.; postsourcessource
PostSourcesSourceVerify: Verify a given source.; postsourcessourceverify
Create a subscription item: Adds a new item to an existing subscription. No existing items will be changed or replaced.; postsubscriptionitems
Update a subscription item: Updates the plan or quantity of an item on a current subscription.; postsubscriptionitemsitem
Create a schedule: Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.; postsubscriptionschedules
Update a schedule: Updates an existing subscription schedule.; postsubscriptionschedulesschedule
Cancel a schedule: Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is <code>not_started</code> or <code>active</code>.; postsubscriptionschedulesschedulecancel
Release a schedule: Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is <code>not_started</code> or <code>active</code>. If the subscription schedule is currently associated with a subscription, releasing it will remove its <code>subscription</code> property and set the subscription’s ID to the <code>released_subscription</code> property.; postsubscriptionschedulesschedulerelease
Create a subscription: Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions. When you create a subscription with <code>collection_method=charge_automatically</code>, the first invoice is finalized as part of the request. The <code>payment_behavior</code> parameter determines the exact behavior of the initial payment. To start subscriptions where the first invoice always begins in a <code>draft</code> status, use <a href="/docs/billing/subscriptions/subscription-schedules#managing">subscription schedules</a> instead. Schedules provide the flexibility to model more complex billing configurations that change over time.; postsubscriptions
Update a subscription: Updates an existing subscription to match the specified parameters. When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes. To preview how the proration is calculated, use the <a href="/docs/api/invoices/create_preview">create preview</a> endpoint. By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a <currency>100</currency> price, they’ll be billed <currency>100</currency> immediately. If on May 15 they switch to a <currency>200</currency> price, then on June 1 they’ll be billed <currency>250</currency> (<currency>200</currency> for a renewal of her subscription, plus a <currency>50</currency> prorating adjustment for half of the previous month’s <currency>100</currency> difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes. Switching prices does not normally change the billing date or generate an immediate charge unless: <ul> <li>The billing interval is changed (for example, from monthly to yearly).</li> <li>The subscription moves from free to paid.</li> <li>A trial starts or ends.</li> </ul> In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how <a href="/docs/billing/subscriptions/upgrade-downgrade#immediate-payment">Stripe immediately attempts payment for subscription changes</a>. If you want to charge for an upgrade immediately, pass <code>proration_behavior</code> as <code>always_invoice</code> to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass <code>create_prorations</code>, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription’s renewal date, you need to manually <a href="/docs/api/invoices/create">invoice the customer</a>. If you don’t want to prorate, set the <code>proration_behavior</code> option to <code>none</code>. With this option, the customer is billed <currency>100</currency> on May 1 and <currency>200</currency> on June 1. Similarly, if you set <code>proration_behavior</code> to <code>none</code> when switching between different billing intervals (for example, from monthly to yearly), we don’t generate any credits for the old subscription’s unused time. We still reset the billing date and bill immediately for the new subscription. Updating the quantity on a subscription many times in an hour may result in <a href="/docs/rate-limits">rate limiting</a>. If you need to bill for a frequently changing quantity, consider integrating <a href="/docs/billing/subscriptions/usage-based">usage-based billing</a> instead.; postsubscriptionssubscriptionexposedid
Migrate a subscription: Upgrade the billing_mode of an existing subscription.; postsubscriptionssubscriptionmigrate
Resume a subscription: Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. Resume is only available for subscriptions that use <code>charge_automatically</code> collection. If Stripe doesn’t generate a resumption invoice, the subscription becomes <code>active</code> immediately. When a resumption invoice is generated, Stripe finalizes it immediately. If the invoice is paid or marked uncollectible, the subscription becomes <code>active</code>. If the invoice is manually voided, the subscription stays <code>paused</code>. If there is no payment attempt within 23 hours, Stripe voids the invoice and the subscription stays <code>paused</code>. Learn more about <a href="/docs/billing/subscriptions/pause#resume-subscriptions">resuming subscriptions</a>.; postsubscriptionssubscriptionresume
Create a Calculation: Calculates tax based on the input and returns a Tax <code>Calculation</code> object.; posttaxcalculations
Create a tax ID: Creates a new account or customer <code>tax_id</code> object.; posttaxids
Create a tax rate: Creates a new tax rate.; posttaxrates
Update a tax rate: Updates an existing tax rate.; posttaxratestaxrate
Create a registration: Creates a new Tax <code>Registration</code> object.; posttaxregistrations
Update a registration: Updates an existing Tax <code>Registration</code> object. A registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting <code>expires_at</code>.; posttaxregistrationsid
Update settings: Updates Tax <code>Settings</code> parameters used in tax calculations. All parameters are editable but none can be removed once set.; posttaxsettings
Create a Transaction from a Calculation: Creates a Tax Transaction from a calculation, if that calculation hasn’t expired. Calculations expire after 90 days.; posttaxtransactionscreatefromcalculation
Create a reversal Transaction: Partially or fully reverses a previously created <code>Transaction</code>.; posttaxtransactionscreatereversal
Create a Configuration: Creates a new <code>Configuration</code> object.; postterminalconfigurations
Update a Configuration: Updates a new <code>Configuration</code> object.; postterminalconfigurationsconfiguration
Create a Connection Token: To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.; postterminalconnectiontokens
Create a Location: Creates a new <code>Location</code> object. For further details, including which address fields are required in each country, see the <a href="/docs/terminal/fleet/locations">Manage locations</a> guide.; postterminallocations
Update a Location: Updates a <code>Location</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.; postterminallocationslocation
Create an Onboarding Link: Creates a new <code>OnboardingLink</code> object that contains a redirect_url used for onboarding onto Tap to Pay on iPhone.; postterminalonboardinglinks
Create a Reader: Creates a new <code>Reader</code> object.; postterminalreaders
Update a Reader: Updates a <code>Reader</code> object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.; postterminalreadersreader
Cancel the current reader action: Cancels the current reader action. See <a href="/docs/terminal/payments/collect-card-payment?terminal-sdk-platform=server-driven#programmatic-cancellation">Programmatic Cancellation</a> for more details.; postterminalreadersreadercancelaction
Collect inputs using a Reader: Initiates an <a href="/docs/terminal/features/collect-inputs">input collection flow</a> on a Reader to display input forms and collect information from your customers.; postterminalreadersreadercollectinputs
Hand off a PaymentIntent to a Reader and collect card details: Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation. See <a href="/docs/terminal/payments/collect-card-payment?terminal-sdk-platform=server-driven&process=inspect#collect-a-paymentmethod">Collecting a Payment method</a> for more details.; postterminalreadersreadercollectpaymentmethod
Confirm a PaymentIntent on the Reader: Finalizes a payment on a Reader. See <a href="/docs/terminal/payments/collect-card-payment?terminal-sdk-platform=server-driven&process=inspect#confirm-the-paymentintent">Confirming a Payment</a> for more details.; postterminalreadersreaderconfirmpaymentintent
Hand-off a PaymentIntent to a Reader: Initiates a payment flow on a Reader. See <a href="/docs/terminal/payments/collect-card-payment?terminal-sdk-platform=server-driven&process=immediately#process-payment">process the payment</a> for more details.; postterminalreadersreaderprocesspaymentintent
Hand-off a SetupIntent to a Reader: Initiates a SetupIntent flow on a Reader. See <a href="/docs/terminal/features/saving-payment-details/save-directly">Save directly without charging</a> for more details.; postterminalreadersreaderprocesssetupintent
Refund a Charge or a PaymentIntent in-person: Initiates an in-person refund on a Reader. See <a href="/docs/terminal/payments/regional?integration-country=CA#refund-an-interac-payment">Refund an Interac Payment</a> for more details.; postterminalreadersreaderrefundpayment
Set reader display: Sets the reader display to show <a href="/docs/terminal/features/display">cart details</a>.; postterminalreadersreadersetreaderdisplay
Create a refund using a Terminal-supported device.: Internal endpoint for terminal use to create a refund for a card_present or card charge. You can optionally refund only part of a charge.; postterminalrefunds
Create a test Confirmation Token: Creates a test mode Confirmation Token server side for your integration tests.; posttesthelpersconfirmationtokens
Fund a test mode cash balance: Create an incoming testmode bank transfer; posttesthelperscustomerscustomerfundcashbalance
Create a test-mode authorization: Create a test-mode authorization.; posttesthelpersissuingauthorizations
Capture a test-mode authorization: Capture a test-mode authorization.; posttesthelpersissuingauthorizationsauthorizationcapture
Expire a test-mode authorization: Expire a test-mode Authorization.; posttesthelpersissuingauthorizationsauthorizationexpire
Finalize a test-mode authorization's amount: Finalize the amount on an Authorization prior to capture, when the initial authorization was for an estimated amount.; posttesthelpersissuingauthorizationsauthorizationfinalizeamount
Respond to fraud challenge: Respond to a fraud challenge on a testmode Issuing authorization, simulating either a confirmation of fraud or a correction of legitimacy.; posttesthelpersissuingauthorizationsauthorizationfraudchallengesrespond
Increment a test-mode authorization: Increment a test-mode Authorization.; posttesthelpersissuingauthorizationsauthorizationincrement
Reverse a test-mode authorization: Reverse a test-mode Authorization.; posttesthelpersissuingauthorizationsauthorizationreverse
Deliver a testmode card: Updates the shipping status of the specified Issuing <code>Card</code> object to <code>delivered</code>.; posttesthelpersissuingcardscardshippingdeliver
Fail a testmode card: Updates the shipping status of the specified Issuing <code>Card</code> object to <code>failure</code>.; posttesthelpersissuingcardscardshippingfail
Return a testmode card: Updates the shipping status of the specified Issuing <code>Card</code> object to <code>returned</code>.; posttesthelpersissuingcardscardshippingreturn
Ship a testmode card: Updates the shipping status of the specified Issuing <code>Card</code> object to <code>shipped</code>.; posttesthelpersissuingcardscardshippingship
Submit a testmode card: Updates the shipping status of the specified Issuing <code>Card</code> object to <code>submitted</code>. This method requires Stripe Version ‘2024-09-30.acacia’ or later.; posttesthelpersissuingcardscardshippingsubmit
Activate a testmode personalization design: Updates the <code>status</code> of the specified testmode personalization design object to <code>active</code>.; posttesthelpersissuingpersonalizationdesignspersonalizationdesignactivate
Deactivate a testmode personalization design: Updates the <code>status</code> of the specified testmode personalization design object to <code>inactive</code>.; posttesthelpersissuingpersonalizationdesignspersonalizationdesigndeactivate
Reject a testmode personalization design: Updates the <code>status</code> of the specified testmode personalization design object to <code>rejected</code>.; posttesthelpersissuingpersonalizationdesignspersonalizationdesignreject
Create a test-mode settlement: Allows the user to create an Issuing settlement.; posttesthelpersissuingsettlements
Complete a test-mode settlement: Allows the user to mark an Issuing settlement as complete.; posttesthelpersissuingsettlementssettlementcomplete
Create a test-mode force capture: Allows the user to capture an arbitrary amount, also known as a forced capture.; posttesthelpersissuingtransactionscreateforcecapture
Create a test-mode unlinked refund: Allows the user to refund an arbitrary amount, also known as a unlinked refund.; posttesthelpersissuingtransactionscreateunlinkedrefund
Refund a test-mode transaction: Refund a test-mode Transaction.; posttesthelpersissuingtransactionstransactionrefund
Expire a pending refund.: Expire a refund with a status of <code>requires_action</code>.; posttesthelpersrefundsrefundexpire
Simulate presenting a payment method: Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction.; posttesthelpersterminalreadersreaderpresentpaymentmethod
Simulate a successful input collection: Use this endpoint to trigger a successful input collection on a simulated reader.; posttesthelpersterminalreadersreadersucceedinputcollection
Simulate an input collection timeout: Use this endpoint to complete an input collection with a timeout error on a simulated reader.; posttesthelpersterminalreadersreadertimeoutinputcollection
Create a test clock: Creates a new test clock that can be attached to new customers and quotes.; posttesthelperstestclocks
Advance a test clock: Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to <code>Ready</code>.; posttesthelperstestclockstestclockadvance
Test mode: Fail an InboundTransfer: Transitions a test mode created InboundTransfer to the <code>failed</code> status. The InboundTransfer must already be in the <code>processing</code> state.; posttesthelperstreasuryinboundtransfersidfail
Test mode: Return an InboundTransfer: Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the <code>succeeded</code> state.; posttesthelperstreasuryinboundtransfersidreturn
Test mode: Succeed an InboundTransfer: Transitions a test mode created InboundTransfer to the <code>succeeded</code> status. The InboundTransfer must already be in the <code>processing</code> state.; posttesthelperstreasuryinboundtransfersidsucceed
Test mode: Update an OutboundPayment: Updates a test mode created OutboundPayment with tracking details. The OutboundPayment must not be cancelable, and cannot be in the <code>canceled</code> or <code>failed</code> states.; posttesthelperstreasuryoutboundpaymentsid
Test mode: Fail an OutboundPayment: Transitions a test mode created OutboundPayment to the <code>failed</code> status. The OutboundPayment must already be in the <code>processing</code> state.; posttesthelperstreasuryoutboundpaymentsidfail
Test mode: Post an OutboundPayment: Transitions a test mode created OutboundPayment to the <code>posted</code> status. The OutboundPayment must already be in the <code>processing</code> state.; posttesthelperstreasuryoutboundpaymentsidpost
Test mode: Return an OutboundPayment: Transitions a test mode created OutboundPayment to the <code>returned</code> status. The OutboundPayment must already be in the <code>processing</code> state.; posttesthelperstreasuryoutboundpaymentsidreturn
Test mode: Update an OutboundTransfer: Updates a test mode created OutboundTransfer with tracking details. The OutboundTransfer must not be cancelable, and cannot be in the <code>canceled</code> or <code>failed</code> states.; posttesthelperstreasuryoutboundtransfersoutboundtransfer
Test mode: Fail an OutboundTransfer: Transitions a test mode created OutboundTransfer to the <code>failed</code> status. The OutboundTransfer must already be in the <code>processing</code> state.; posttesthelperstreasuryoutboundtransfersoutboundtransferfail
Test mode: Post an OutboundTransfer: Transitions a test mode created OutboundTransfer to the <code>posted</code> status. The OutboundTransfer must already be in the <code>processing</code> state.; posttesthelperstreasuryoutboundtransfersoutboundtransferpost
Test mode: Return an OutboundTransfer: Transitions a test mode created OutboundTransfer to the <code>returned</code> status. The OutboundTransfer must already be in the <code>processing</code> state.; posttesthelperstreasuryoutboundtransfersoutboundtransferreturn
Test mode: Create a ReceivedCredit: Use this endpoint to simulate a test mode ReceivedCredit initiated by a third party. In live mode, you can’t directly create ReceivedCredits initiated by third parties.; posttesthelperstreasuryreceivedcredits
Test mode: Create a ReceivedDebit: Use this endpoint to simulate a test mode ReceivedDebit initiated by a third party. In live mode, you can’t directly create ReceivedDebits initiated by third parties.; posttesthelperstreasuryreceiveddebits
Create a bank account token: Creates a single-use token that represents a bank account’s details. You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a <a href="#accounts">connected account</a> where <a href="/api/accounts/object#account_object-controller-requirement_collection">controller.requirement_collection</a> is <code>application</code>, which includes Custom accounts.; posttokens
Create a top-up: Top up the balance of an account; posttopups
Update a top-up: Updates the metadata of a top-up. Other top-up details are not editable by design.; posttopupstopup
Cancel a top-up: Cancels a top-up. Only pending top-ups can be canceled.; posttopupstopupcancel
Create a transfer: To send funds from your Stripe account to a connected account, you create a new transfer object. Your <a href="#balance">Stripe balance</a> must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error.; posttransfers
Create a transfer reversal: When you create a new reversal, you must specify a transfer to create it on. When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until the entire transfer has been reversed. Once entirely reversed, a transfer can’t be reversed again. This method will return an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer.; posttransfersidreversals
Update a transfer: Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only metadata as an argument.; posttransferstransfer
Update a reversal: Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request only accepts metadata and description as arguments.; posttransferstransferreversalsid
Create a CreditReversal: Reverses a ReceivedCredit and creates a CreditReversal object.; posttreasurycreditreversals
Create a DebitReversal: Reverses a ReceivedDebit and creates a DebitReversal object.; posttreasurydebitreversals
Create a FinancialAccount: Creates a new FinancialAccount. Each connected account can have up to three FinancialAccounts by default.; posttreasuryfinancialaccounts
Update a FinancialAccount: Updates the details of a FinancialAccount.; posttreasuryfinancialaccountsfinancialaccount
Close a FinancialAccount: Closes a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards.; posttreasuryfinancialaccountsfinancialaccountclose
Update FinancialAccount Features: Updates the Features associated with a FinancialAccount.; posttreasuryfinancialaccountsfinancialaccountfeatures
Create an InboundTransfer: Creates an InboundTransfer.; posttreasuryinboundtransfers
Cancel an InboundTransfer: Cancels an InboundTransfer.; posttreasuryinboundtransfersinboundtransfercancel
Create an OutboundPayment: Creates an OutboundPayment.; posttreasuryoutboundpayments
Cancel an OutboundPayment: Cancel an OutboundPayment.; posttreasuryoutboundpaymentsidcancel
Create an OutboundTransfer: Creates an OutboundTransfer.; posttreasuryoutboundtransfers
Cancel an OutboundTransfer: An OutboundTransfer can be canceled if the funds have not yet been paid out.; posttreasuryoutboundtransfersoutboundtransfercancel
Create a Meter Event Adjustment: Creates a meter event adjustment to cancel a previously sent meter event.; postv2billingmetereventadjustments
Create a Meter Event Stream Authentication Session: Creates a meter event session to send usage on the high-throughput meter event stream. Authentication tokens are only valid for 15 minutes, so you need to create a new meter event session when your token expires.; postv2billingmetereventsession
Create a Meter Event with asynchronous validation: Creates meter events. Events are processed asynchronously, including validation. Requires a meter event session for authentication. Supports up to 10,000 requests per second in livemode. For even higher rate-limits, contact sales.; postv2billingmetereventstream
Create a Meter Event with synchronous validation: Creates a meter event. Events are validated synchronously, but are processed asynchronously. Supports up to 1,000 events per second in livemode. For higher rate-limits, please use meter event streams instead.; postv2billingmeterevents
Create a Product Catalog Import: Creates a ProductCatalogImport.; postv2commerceproductcatalogimports
Create an account link: Creates an AccountLink object that includes a single-use URL that an account can use to access a Stripe-hosted flow for collecting or updating required information.; postv2coreaccountlinks
Create an account token: Create an account token with a publishable key and pass it to the Accounts v2 API to create or update an account without its data touching your server. Learn more about [account tokens](https://docs.stripe.com/connect/account-tokens). In live mode, you can only create account tokens with your application's publishable key. In test mode, you can create account tokens with your secret key or publishable key.; postv2coreaccounttokens
Create an account: Create an Account that represents a company, individual, or other entity that your business interacts with. Accounts contain identifying information about the entity, and configurations that store the features an account has access to. An account can be configured as any or all of the following configurations: Customer, Merchant and/or Recipient.; postv2coreaccounts
Create a person token: Creates a single-use token that represents the details for a person. Use this when you create or update persons associated with an Account v2. Learn more about [account tokens](https://docs.stripe.com/connect/account-tokens). You can only create person tokens with your application's publishable key and in live mode. You can use your application's secret key to create person tokens only in test mode.; postv2coreaccountsaccountidpersontokens
Create a person: Create a Person. Adds an individual to an Account's identity. You can set relationship attributes and identity information at creation.; postv2coreaccountsaccountidpersons
Update a person: Updates a Person associated with an Account.; postv2coreaccountsaccountidpersonsid
Update an account: Updates the details of an Account.; postv2coreaccountsid
Close an account: Removes access to the Account and its associated resources. Closed Accounts can no longer be operated on, but limited information can still be retrieved through the API in order to be able to track their history.; postv2coreaccountsidclose
Create an Event Destination: Create a new event destination.; postv2coreeventdestinations
Update an Event Destination: Update the details of an event destination.; postv2coreeventdestinationsid
Disable an Event Destination: Disable an event destination.; postv2coreeventdestinationsiddisable
Enable an Event Destination: Enable an event destination.; postv2coreeventdestinationsidenable
Ping an Event Destination: Send a `ping` event to an event destination.; postv2coreeventdestinationsidping
Create a webhook endpoint: A webhook endpoint must have a <code>url</code> and a list of <code>enabled_events</code>. You may optionally specify the Boolean <code>connect</code> parameter. If set to true, then a Connect webhook endpoint that notifies the specified <code>url</code> about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified <code>url</code> only about events from your account is created. You can also create webhook endpoints in the <a href="https://dashboard.stripe.com/account/webhooks">webhooks settings</a> section of the Dashboard.; postwebhookendpoints
Update a webhook endpoint: Updates the webhook endpoint. You may edit the <code>url</code>, the list of <code>enabled_events</code>, and the status of your endpoint.; postwebhookendpointswebhookendpoint

FAQ

Stripe integration, answered

How do AI agents use Stripe through Open Connector?: Your user connects Stripe once with one of its cataloged authentication methods. Open Connector stores the credential in an encrypted vault and exposes Stripe tools to your agent over MCP or a typed API, with credentials injected server-side on each call.
Is this a Stripe MCP server?: Yes. Open Connector can serve Stripe as a named MCP server with a scoped allowlist and a per-user connection URL, so any MCP client can call Stripe actions with credentials injected server-side.
Where do Stripe credentials live?: In your own infrastructure. Open Connector keeps credentials in its own vault and injects them at call time, so they never leave your environment.

Give your agents Stripe — keep the keys.

Open source, self-hostable, with Stripe credentials that never leave your infrastructure. Run it from source today.

View source on GitHub How the MCP gateway works →