Stripe API (all endpoints)
The Stripe REST API. Please see https://stripe.com/docs/api for more details.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Stripe REST API. Please see https://stripe.com/docs/api for more details.
Endpoints 400
- GETRetrieve account
/v1/account?expand=string<p>Retrieves the details of an account.</p> - POSTCreate an account link
/v1/account_links<p>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… - POSTCreate an Account Session
/v1/account_sessions<p>Creates an AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.</p> - GETList all connected accounts
/v1/accounts?created={"gt":0,"gte":0,"lt":0,"lte":0}&ending_before=string&expand=string&limit=0&starting_after=string<p>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.</p> - POSTCreate an account
/v1/accounts<p>With <a href="/docs/connect">Connect</a>, you can create Stripe accounts for your users. To do this, you’ll first need to <a… - GETRetrieve account
/v1/accounts/:account?expand=string<p>Retrieves the details of an account.</p> - POSTUpdate an account
/v1/accounts/:account<p>Updates a <a href="/connect/accounts">connected account</a> by setting the values of the parameters passed. Any parameters not provided are left… - DELETEDelete an account
/v1/accounts/:account<p>With <a href="/connect">Connect</a>, you can delete accounts you manage.</p> <p>Test-mode accounts can be deleted at any time.</p> <p>Live-mode accounts… - POSTCreate an external account
/v1/accounts/:account/bank_accounts<p>Create an external account for a given account.</p> - GETRetrieve an external account
/v1/accounts/:account/bank_accounts/:id?expand=string<p>Retrieve a specified external account for a given account.</p> - POSTUpdate a bank account
/v1/accounts/:account/bank_accounts/:id<p>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… - DELETEDelete an external account
/v1/accounts/:account/bank_accounts/:id<p>Delete a specified external account for a given account.</p> - GETList all account capabilities
/v1/accounts/:account/capabilities?expand=string<p>Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability… - GETRetrieve an Account Capability
/v1/accounts/:account/capabilities/:capability?expand=string<p>Retrieves information about the specified Account Capability.</p> - POSTUpdate an Account Capability
/v1/accounts/:account/capabilities/:capability<p>Updates an existing Account Capability. Request or remove a capability by updating its <code>requested</code> parameter.</p> - GETList all external accounts
/v1/accounts/:account/external_accounts?ending_before=string&expand=string&limit=0&object=bank_account&starting_after=string<p>List external accounts for an account.</p> - POSTCreate an external account
/v1/accounts/:account/external_accounts<p>Create an external account for a given account.</p> - GETRetrieve an external account
/v1/accounts/:account/external_accounts/:id?expand=string<p>Retrieve a specified external account for a given account.</p> - POSTUpdate a bank account
/v1/accounts/:account/external_accounts/:id<p>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… - DELETEDelete an external account
/v1/accounts/:account/external_accounts/:id<p>Delete a specified external account for a given account.</p> - POSTCreate a login link
/v1/accounts/:account/login_links<p>Creates a login link for a connected account to access the Express Dashboard.</p> <p><strong>You can only create login links for accounts that use the <a… - GETList all persons
/v1/accounts/:account/people?ending_before=string&expand=string&limit=0&relationship={"authorizer":true,"director":true,"executive":true,"legal_guardian":true,"owner":true,"representative":true}&starting_after=string<p>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… - POSTCreate a person
/v1/accounts/:account/people<p>Creates a new person.</p> - GETRetrieve a person
/v1/accounts/:account/people/:person?expand=string<p>Retrieves an existing person.</p> - POSTUpdate a person
/v1/accounts/:account/people/:person<p>Updates an existing person.</p> - DELETEDelete a person
/v1/accounts/:account/people/:person<p>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,… - GETList all persons
/v1/accounts/:account/persons?ending_before=string&expand=string&limit=0&relationship={"authorizer":true,"director":true,"executive":true,"legal_guardian":true,"owner":true,"representative":true}&starting_after=string<p>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… - POSTCreate a person
/v1/accounts/:account/persons<p>Creates a new person.</p> - GETRetrieve a person
/v1/accounts/:account/persons/:person?expand=string<p>Retrieves an existing person.</p> - POSTUpdate a person
/v1/accounts/:account/persons/:person<p>Updates an existing person.</p> - DELETEDelete a person
/v1/accounts/:account/persons/:person<p>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,… - POSTReject an account
/v1/accounts/:account/reject<p>With <a href="/connect">Connect</a>, you can reject accounts that you have flagged as suspicious.</p> <p>Only accounts where your platform is liable for… - POSTUnreject an account
/v1/accounts/:account/unreject<p>With Connect, you can unreject accounts that you have previously rejected.</p> <p>Only accounts that were rejected by your platform can be unrejected. This… - GETGetApplePayDomains
/v1/apple_pay/domains?domain_name=string&ending_before=string&expand=string&limit=0&starting_after=string<p>List apple pay domains.</p> - POSTPostApplePayDomains
/v1/apple_pay/domains<p>Create an apple pay domain.</p> - GETGetApplePayDomainsDomain
/v1/apple_pay/domains/:domain?expand=string<p>Retrieve an apple pay domain.</p> - DELETEDeleteApplePayDomainsDomain
/v1/apple_pay/domains/:domain<p>Delete an apple pay domain.</p> - GETList all application fees
/v1/application_fees?charge=string&created={"gt":0,"gte":0,"lt":0,"lte":0}&ending_before=string&expand=string&limit=0&starting_after=string<p>Returns a list of application fees you’ve previously collected. The application fees are returned in sorted order, with the most recent fees appearing… - GETRetrieve an application fee refund
/v1/application_fees/:fee/refunds/:id?expand=string<p>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… - POSTUpdate an application fee refund
/v1/application_fees/:fee/refunds/:id<p>Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>… - GETRetrieve an application fee
/v1/application_fees/:id?expand=string<p>Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.</p> - POSTPostApplicationFeesIdRefund
/v1/application_fees/:id/refund - GETList all application fee refunds
/v1/application_fees/:id/refunds?ending_before=string&expand=string&limit=0&starting_after=string<p>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… - POSTCreate an application fee refund
/v1/application_fees/:id/refunds<p>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… - GETList all app installs
/v1/apps/installs?account=string&app=string&approval_required=true&channel=private_live&created={"gt":0,"gte":0,"lt":0,"lte":0}&created_by=string&ending_before=string&expand=string&limit=0&starting_after=string&status=install_failed<p>Returns a list of app installs. An app developer or embedding platform filtering by its own app sees the installs across the accounts that installed it;… - POSTCreate an app install
/v1/apps/installs<p>Creates an app install. An account installs its own private app with its own key; public and testing installs are made from the Dashboard. An app developer… - GETRetrieve an app install
/v1/apps/installs/:id?expand=string<p>Retrieves an app install. The installing account, the app’s developer (with the keys of the account that owns the app or of the app’s managed sandbox), and… - POSTUpdate an app install
/v1/apps/installs/:id<p>Reauthorizes an app install. The installer grants the permissions, content security policy entries, and endpoints that the version being installed… - POSTUninstall an app install
/v1/apps/installs/:id/uninstall<p>Uninstalls an app from the account that installed it.</p> - GETList secrets
/v1/apps/secrets?ending_before=string&expand=string&limit=0&scope={"type":"account","user":"string"}&starting_after=string<p>List all secrets stored on the given scope.</p> - POSTSet a Secret
/v1/apps/secrets<p>Create or replace a secret in the secret store.</p> - POSTDelete a Secret
/v1/apps/secrets/delete<p>Deletes a secret from the secret store by name and scope.</p> - GETFind a Secret
/v1/apps/secrets/find?expand=string&name=string&scope={"type":"account","user":"string"}<p>Finds a secret in the secret store by name and scope.</p> - GETRetrieve balance
/v1/balance?expand=string<p>Retrieves the current account balance, based on the authentication that was used to make the request. For a sample request, see <a… - GETList all balance transactions
/v1/balance/history?created={"gt":0,"gte":0,"lt":0,"lte":0}¤cy=string&ending_before=string&expand=string&limit=0&payout=string&source=string&starting_after=string&type=string<p>Returns a list of transactions that have contributed to the Stripe account balance (for example, charges, transfers, and so on). The transactions return in… - GETRetrieve a balance transaction
/v1/balance/history/:id?expand=string<p>Retrieves the balance transaction with the given ID.</p> <p>Note that this endpoint previously used the path <code>/v1/balance/history/:id</code>.</p> - GETRetrieve balance settings
/v1/balance_settings?expand=string<p>Retrieves balance settings for a given connected account. Related guide: <a href="/connect/authentication">Making API calls for connected accounts</a></p> - POSTUpdate balance settings
/v1/balance_settings<p>Updates balance settings for a given connected account. Related guide: <a href="/connect/authentication">Making API calls for connected accounts</a></p> - GETList all balance transactions
/v1/balance_transactions?created={"gt":0,"gte":0,"lt":0,"lte":0}¤cy=string&ending_before=string&expand=string&limit=0&payout=string&source=string&starting_after=string&type=string<p>Returns a list of transactions that have contributed to the Stripe account balance (for example, charges, transfers, and so on). The transactions return in… - GETRetrieve a balance transaction
/v1/balance_transactions/:id?expand=string<p>Retrieves the balance transaction with the given ID.</p> <p>Note that this endpoint previously used the path <code>/v1/balance/history/:id</code>.</p> - GETList billing alerts
/v1/billing/alerts?alert_type=usage_threshold&ending_before=string&expand=string&limit=0&meter=string&starting_after=string<p>Lists billing active and inactive alerts</p> - POSTCreate a billing alert
/v1/billing/alerts<p>Creates a billing alert</p> - GETRetrieve a billing alert
/v1/billing/alerts/:id?expand=string<p>Retrieves a billing alert given an ID</p> - POSTActivate a billing alert
/v1/billing/alerts/:id/activate<p>Reactivates this alert, allowing it to trigger again.</p> - POSTArchive a billing alert
/v1/billing/alerts/:id/archive<p>Archives this alert, removing it from the list view and APIs. This is non-reversible.</p> - POSTDeactivate a billing alert
/v1/billing/alerts/:id/deactivate<p>Deactivates this alert, preventing it from triggering.</p> - GETRetrieve the credit balance summary for a customer
/v1/billing/credit_balance_summary?customer=string&customer_account=string&expand=string&filter={"applicability_scope":{"price_type":"metered","prices":[{"id":"string"}]},"credit_grant":"string","type":"applicability_scope"}<p>Retrieves the credit balance summary for a customer.</p> - GETList credit balance transactions
/v1/billing/credit_balance_transactions?credit_grant=string&customer=string&customer_account=string&ending_before=string&expand=string&limit=0&starting_after=string<p>Retrieve a list of credit balance transactions.</p> - GETRetrieve a credit balance transaction
/v1/billing/credit_balance_transactions/:id?expand=string<p>Retrieves a credit balance transaction.</p> - GETList credit grants
/v1/billing/credit_grants?customer=string&customer_account=string&ending_before=string&expand=string&limit=0&starting_after=string<p>Retrieve a list of credit grants.</p> - POSTCreate a credit grant
/v1/billing/credit_grants<p>Creates a credit grant.</p> - GETRetrieve a credit grant
/v1/billing/credit_grants/:id?expand=string<p>Retrieves a credit grant.</p> - POSTUpdate a credit grant
/v1/billing/credit_grants/:id<p>Updates a credit grant.</p> - POSTExpire a credit grant
/v1/billing/credit_grants/:id/expire<p>Expires a credit grant.</p> - POSTVoid a credit grant
/v1/billing/credit_grants/:id/void<p>Voids a credit grant.</p> - GETList all feedback options
/v1/billing/feedback_options?ending_before=string&expand=string&limit=0&starting_after=string&status=active<p>Returns a list of your feedback options.</p> - POSTCreate a feedback option
/v1/billing/feedback_options<p>Creates a new feedback option.</p> - GETRetrieve a feedback option
/v1/billing/feedback_options/:id?expand=string<p>Retrieves a feedback option object given an ID.</p> - POSTUpdate a feedback option
/v1/billing/feedback_options/:id<p>Updates the description of an existing feedback option.</p> - POSTDeactivate a feedback option
/v1/billing/feedback_options/:id/deactivate<p>Deactivates a feedback option. Deactivated feedback options cannot be used in portal configurations.</p> - POSTCreate a billing meter event adjustment
/v1/billing/meter_event_adjustments<p>Creates a billing meter event adjustment.</p> - POSTCreate a billing meter event
/v1/billing/meter_events<p>Creates a billing meter event.</p> - GETList billing meters
/v1/billing/meters?ending_before=string&expand=string&limit=0&starting_after=string&status=active<p>Retrieve a list of billing meters.</p> - POSTCreate a billing meter
/v1/billing/meters<p>Creates a billing meter.</p> - GETRetrieve a billing meter
/v1/billing/meters/:id?expand=string<p>Retrieves a billing meter given an ID.</p> - POSTUpdate a billing meter
/v1/billing/meters/:id<p>Updates a billing meter.</p> - POSTDeactivate a billing meter
/v1/billing/meters/:id/deactivate<p>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.</p> - GETList billing meter event summaries
/v1/billing/meters/:id/event_summaries?customer=string&end_time=0&ending_before=string&expand=string&limit=0&start_time=0&starting_after=string&value_grouping_window=day<p>Retrieve a list of billing meter event summaries.</p> - POSTReactivate a billing meter
/v1/billing/meters/:id/reactivate<p>When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.</p> - GETList portal configurations
/v1/billing_portal/configurations?active=true&ending_before=string&expand=string&is_default=true&limit=0&starting_after=string<p>Returns a list of configurations that describe the functionality of the customer portal.</p> - POSTCreate a portal configuration
/v1/billing_portal/configurations<p>Creates a configuration that describes the functionality and behavior of a PortalSession</p> - GETRetrieve a portal configuration
/v1/billing_portal/configurations/:configuration?expand=string<p>Retrieves a configuration that describes the functionality of the customer portal.</p> - POSTUpdate a portal configuration
/v1/billing_portal/configurations/:configuration<p>Updates a configuration that describes the functionality of the customer portal.</p> - POSTCreate a portal session
/v1/billing_portal/sessions<p>Creates a session of the customer portal.</p> - GETList all charges
/v1/charges?created={"gt":0,"gte":0,"lt":0,"lte":0}&customer=string&ending_before=string&expand=string&limit=0&payment_intent=string&starting_after=string&transfer_group=string<p>Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.</p> - POSTCreate a charge
/v1/charges<p>This method is deprecated and will be removed soon. If your integration uses it, you need to update it to use a different payment flow, such as <a… - GETSearch charges
/v1/charges/search?expand=string&limit=0&page=string&query=string<p>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… - GETRetrieve a charge
/v1/charges/:charge?expand=string<p>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… - POSTUpdate a charge
/v1/charges/:charge<p>Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p> - POSTCapture a charge
/v1/charges/:charge/capture<p>This method is deprecated and will be removed soon. If your integration uses it, you need to update it to use a different payment flow, such as <a… - GETGetChargesChargeDispute
/v1/charges/:charge/dispute?expand=string<p>Retrieve a dispute for a specified charge.</p> - POSTPostChargesChargeDispute
/v1/charges/:charge/dispute - POSTPostChargesChargeDisputeClose
/v1/charges/:charge/dispute/close - POSTCreate a refund
/v1/charges/:charge/refund<p>When you create a new refund, you must specify either a Charge or a PaymentIntent object.</p> <p>This action refunds a previously created charge that’s not… - GETList all refunds
/v1/charges/:charge/refunds?ending_before=string&expand=string&limit=0&starting_after=string<p>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… - POSTCreate a refund
/v1/charges/:charge/refunds<p>When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.</p> <p>Creating a new refund will refund a charge… - GETGetChargesChargeRefundsRefund
/v1/charges/:charge/refunds/:refund?expand=string<p>Retrieves the details of an existing refund.</p> - POSTPostChargesChargeRefundsRefund
/v1/charges/:charge/refunds/:refund<p>Update a specified refund.</p> - GETList all Checkout Sessions
/v1/checkout/sessions?created={"gt":0,"gte":0,"lt":0,"lte":0}&customer=string&customer_account=string&customer_details={"email":"string"}&ending_before=string&expand=string&limit=0&payment_intent=string&payment_link=string&starting_after=string&status=complete&subscription=string<p>Returns a list of Checkout Sessions.</p> - POSTCreate a Checkout Session
/v1/checkout/sessions<p>Creates a Checkout Session object.</p> - GETRetrieve a Checkout Session
/v1/checkout/sessions/:session?expand=string<p>Retrieves a Checkout Session object.</p> - POSTUpdate a Checkout Session
/v1/checkout/sessions/:session<p>Updates a Checkout Session object.</p> <p>Related guide: <a href="/payments/advanced/dynamic-updates">Dynamically update a Checkout Session</a></p> - POSTExpire a Checkout Session
/v1/checkout/sessions/:session/expire<p>A Checkout Session can be expired when it is in one of these statuses: <code>open</code> </p> <p>After it expires, a customer can’t complete a Checkout… - GETRetrieve a Checkout Session's line items
/v1/checkout/sessions/:session/line_items?ending_before=string&expand=string&limit=0&starting_after=string<p>When retrieving a Checkout Session, there is an includable <strong>line_items</strong> property containing the first handful of those items. There is also… - GETList orders
/v1/climate/orders?ending_before=string&expand=string&limit=0&starting_after=string<p>Lists all Climate order objects. The orders are returned sorted by creation date, with the most recently created orders appearing first.</p> - POSTCreate an order
/v1/climate/orders<p>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… - GETRetrieve an order
/v1/climate/orders/:order?expand=string<p>Retrieves the details of a Climate order object with the given ID.</p> - POSTUpdate an order
/v1/climate/orders/:order<p>Updates the specified order by setting the values of the parameters passed.</p> - POSTCancel an order
/v1/climate/orders/:order/cancel<p>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… - GETList products
/v1/climate/products?ending_before=string&expand=string&limit=0&starting_after=string<p>Lists all available Climate product objects.</p> - GETRetrieve a product
/v1/climate/products/:product?expand=string<p>Retrieves the details of a Climate product with the given ID.</p> - GETList suppliers
/v1/climate/suppliers?ending_before=string&expand=string&limit=0&starting_after=string<p>Lists all available Climate supplier objects.</p> - GETRetrieve a supplier
/v1/climate/suppliers/:supplier?expand=string<p>Retrieves a Climate supplier object.</p> - GETRetrieve a ConfirmationToken
/v1/confirmation_tokens/:confirmation_token?expand=string<p>Retrieves an existing ConfirmationToken object</p> - GETList Country Specs
/v1/country_specs?ending_before=string&expand=string&limit=0&starting_after=string<p>Lists all Country Spec objects available in the API.</p> - GETRetrieve a Country Spec
/v1/country_specs/:country?expand=string<p>Returns a Country Spec for a given Country code.</p> - GETList all coupons
/v1/coupons?created={"gt":0,"gte":0,"lt":0,"lte":0}&ending_before=string&expand=string&limit=0&starting_after=string<p>Returns a list of your coupons.</p> - POSTCreate a coupon
/v1/coupons<p>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… - GETRetrieve a coupon
/v1/coupons/:coupon?expand=string<p>Retrieves the coupon with the given ID.</p> - POSTUpdate a coupon
/v1/coupons/:coupon<p>Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.</p> - DELETEDelete a coupon
/v1/coupons/:coupon<p>You can delete coupons via the <a href="https://dashboard.stripe.com/coupons">coupon management</a> page of the Stripe dashboard. However, deleting a… - GETList all credit notes
/v1/credit_notes?created={"gt":0,"gte":0,"lt":0,"lte":0}&customer=string&customer_account=string&ending_before=string&expand=string&invoice=string&limit=0&starting_after=string<p>Returns a list of credit notes.</p> - POSTCreate a credit note
/v1/credit_notes<p>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… - GETPreview a credit note
/v1/credit_notes/preview?amount=0&credit_amount=0&effective_at=0&email_type=credit_note&expand=string&invoice=string&lines={"amount":0,"description":"string","invoice_line_item":"string","metadata":{"additionalProp1":"string"},"quantity":0,"tax_amounts":[{"amount":0,"tax_rate":"string","taxable_amount":0}],"tax_rates":["string"],"type":"custom_line_item","unit_amount":0,"unit_amount_decimal":"string"}&memo=string&metadata={"additionalProp1":"string"}&out_of_band_amount=0&reason=duplicate&refund_amount=0&refunds={"amount_refunded":0,"payment_record_refund":{"payment_record":"string","refund_group":"string"},"refund":"string","type":"payment_record_refund"}&shipping_cost={"shipping_rate":"string"}<p>Get a preview of a credit note without creating it.</p> - GETRetrieve a credit note preview's line items
/v1/credit_notes/preview/lines?amount=0&credit_amount=0&effective_at=0&email_type=credit_note&ending_before=string&expand=string&invoice=string&limit=0&lines={"amount":0,"description":"string","invoice_line_item":"string","metadata":{"additionalProp1":"string"},"quantity":0,"tax_amounts":[{"amount":0,"tax_rate":"string","taxable_amount":0}],"tax_rates":["string"],"type":"custom_line_item","unit_amount":0,"unit_amount_decimal":"string"}&memo=string&metadata={"additionalProp1":"string"}&out_of_band_amount=0&reason=duplicate&refund_amount=0&refunds={"amount_refunded":0,"payment_record_refund":{"payment_record":"string","refund_group":"string"},"refund":"string","type":"payment_record_refund"}&shipping_cost={"shipping_rate":"string"}&starting_after=string<p>When retrieving a credit note preview, you’ll get a <strong>lines</strong> property containing the first handful of those items. This URL you can retrieve… - GETRetrieve a credit note's line items
/v1/credit_notes/:credit_note/lines?ending_before=string&expand=string&limit=0&starting_after=string<p>When retrieving a credit note, you’ll get a <strong>lines</strong> property containing the first handful of those items. There is also a URL where you can… - GETRetrieve a credit note
/v1/credit_notes/:id?expand=string<p>Retrieves the credit note object with the given identifier.</p> - POSTUpdate a credit note
/v1/credit_notes/:id<p>Updates an existing credit note.</p> - POSTVoid a credit note
/v1/credit_notes/:id/void<p>Marks a credit note as void. Learn more about <a href="/docs/billing/invoices/credit-notes#voiding">voiding credit notes</a>.</p> - POSTCreate a Customer Session
/v1/customer_sessions<p>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… - GETList all customers
/v1/customers?created={"gt":0,"gte":0,"lt":0,"lte":0}&email=string&ending_before=string&expand=string&limit=0&starting_after=string&test_clock=string<p>Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.</p> - POSTCreate a customer
/v1/customers<p>Creates a new customer object.</p> - GETSearch customers
/v1/customers/search?expand=string&limit=0&page=string&query=string<p>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… - GETRetrieve a customer
/v1/customers/:customer?expand=string<p>Retrieves a Customer object.</p> - POSTUpdate a customer
/v1/customers/:customer<p>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… - DELETEDelete a customer
/v1/customers/:customer<p>Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.</p> - GETList customer balance transactions
/v1/customers/:customer/balance_transactions?created={"gt":0,"gte":0,"lt":0,"lte":0}&ending_before=string&expand=string&invoice=string&limit=0&starting_after=string<p>Returns a list of transactions that updated the customer’s <a href="/docs/billing/customer/balance">balances</a>.</p> - POSTCreate a customer balance transaction
/v1/customers/:customer/balance_transactions<p>Creates an immutable transaction that updates the customer’s credit <a href="/docs/billing/customer/balance">balance</a>.</p> - GETRetrieve a customer balance transaction
/v1/customers/:customer/balance_transactions/:transaction?expand=string<p>Retrieves a specific customer balance transaction that updated the customer’s <a href="/docs/billing/customer/balance">balances</a>.</p> - POSTUpdate a customer credit balance transaction
/v1/customers/:customer/balance_transactions/:transaction<p>Most credit balance transaction fields are immutable, but you may update its <code>description</code> and <code>metadata</code>.</p> - GETList all bank accounts
/v1/customers/:customer/bank_accounts?ending_before=string&expand=string&limit=0&starting_after=stringDeprecated. <p>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… - POSTCreate a card
/v1/customers/:customer/bank_accounts<p>When you create a new credit card, you must specify a customer or recipient on which to create it.</p> <p>If the card’s owner has no default card, then the… - GETRetrieve a bank account
/v1/customers/:customer/bank_accounts/:id?expand=stringDeprecated. <p>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… - POSTUpdate a card
/v1/customers/:customer/bank_accounts/:id<p>Update a specified source for a given customer.</p> - DELETEDelete a customer source
/v1/customers/:customer/bank_accounts/:id<p>Delete a specified source for a given customer.</p> - POSTVerify a bank account
/v1/customers/:customer/bank_accounts/:id/verify<p>Verify a specified bank account for a given customer.</p> - GETList all cards
/v1/customers/:customer/cards?ending_before=string&expand=string&limit=0&starting_after=stringDeprecated. <p>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>… - POSTCreate a card
/v1/customers/:customer/cards<p>When you create a new credit card, you must specify a customer or recipient on which to create it.</p> <p>If the card’s owner has no default card, then the… - GETRetrieve a card
/v1/customers/:customer/cards/:id?expand=stringDeprecated. <p>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… - POSTUpdate a card
/v1/customers/:customer/cards/:id<p>Update a specified source for a given customer.</p> - DELETEDelete a customer source
/v1/customers/:customer/cards/:id<p>Delete a specified source for a given customer.</p> - GETRetrieve a cash balance
/v1/customers/:customer/cash_balance?expand=string<p>Retrieves a customer’s cash balance.</p> - POSTUpdate a cash balance's settings
/v1/customers/:customer/cash_balance<p>Changes the settings on a customer’s cash balance.</p> - GETList cash balance transactions
/v1/customers/:customer/cash_balance_transactions?ending_before=string&expand=string&limit=0&starting_after=string<p>Returns a list of transactions that modified the customer’s <a href="/docs/payments/customer-balance">cash balance</a>.</p> - GETRetrieve a cash balance transaction
/v1/customers/:customer/cash_balance_transactions/:transaction?expand=string<p>Retrieves a specific cash balance transaction, which updated the customer’s <a href="/docs/payments/customer-balance">cash balance</a>.</p> - GETGetCustomersCustomerDiscount
/v1/customers/:customer/discount?expand=string - DELETEDelete a customer discount
/v1/customers/:customer/discount<p>Removes the currently applied discount on a customer.</p> - POSTCreate or retrieve funding instructions for a customer cash balance
/v1/customers/:customer/funding_instructions<p>Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new funding instructions will be… - GETList a Customer's PaymentMethods
/v1/customers/:customer/payment_methods?allow_redisplay=always&ending_before=string&expand=string&limit=0&starting_after=string&type=acss_debit<p>Returns a list of PaymentMethods for a given Customer</p> - GETRetrieve a Customer's PaymentMethod
/v1/customers/:customer/payment_methods/:payment_method?expand=string<p>Retrieves a PaymentMethod object for a given Customer.</p> - GETGetCustomersCustomerSources
/v1/customers/:customer/sources?ending_before=string&expand=string&limit=0&object=string&starting_after=string<p>List sources for a specified customer.</p> - POSTCreate a card
/v1/customers/:customer/sources<p>When you create a new credit card, you must specify a customer or recipient on which to create it.</p> <p>If the card’s owner has no default card, then the… - GETGetCustomersCustomerSourcesId
/v1/customers/:customer/sources/:id?expand=string<p>Retrieve a specified source for a given customer.</p> - POSTUpdate a card
/v1/customers/:customer/sources/:id<p>Update a specified source for a given customer.</p> - DELETEDelete a customer source
/v1/customers/:customer/sources/:id<p>Delete a specified source for a given customer.</p> - POSTVerify a bank account
/v1/customers/:customer/sources/:id/verify<p>Verify a specified bank account for a given customer.</p> - GETList active subscriptions
/v1/customers/:customer/subscriptions?ending_before=string&expand=string&limit=0&starting_after=string<p>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… - POSTCreate a subscription
/v1/customers/:customer/subscriptions<p>Creates a new subscription on an existing customer.</p> - GETRetrieve a subscription
/v1/customers/:customer/subscriptions/:subscription_exposed_id?expand=string<p>Retrieves the subscription with the given ID.</p> - POSTUpdate a subscription on a customer
/v1/customers/:customer/subscriptions/:subscription_exposed_id<p>Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price… - DELETECancel a subscription
/v1/customers/:customer/subscriptions/:subscription_exposed_id<p>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… - GETGetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount
/v1/customers/:customer/subscriptions/:subscription_exposed_id/discount?expand=string - DELETEDelete a customer discount
/v1/customers/:customer/subscriptions/:subscription_exposed_id/discount<p>Removes the currently applied discount on a customer.</p> - GETList all Customer tax IDs
/v1/customers/:customer/tax_ids?ending_before=string&expand=string&limit=0&starting_after=string<p>Returns a list of tax IDs for a customer.</p> - POSTCreate a Customer tax ID
/v1/customers/:customer/tax_ids<p>Creates a new <code>tax_id</code> object for a customer.</p> - GETRetrieve a Customer tax ID
/v1/customers/:customer/tax_ids/:id?expand=string<p>Retrieves the <code>tax_id</code> object with the given identifier.</p> - DELETEDelete a Customer tax ID
/v1/customers/:customer/tax_ids/:id<p>Deletes an existing <code>tax_id</code> object.</p> - GETList all disputes
/v1/disputes?charge=string&created={"gt":0,"gte":0,"lt":0,"lte":0}&ending_before=string&expand=string&limit=0&payment_intent=string&starting_after=string<p>Returns a list of your disputes.</p> - GETRetrieve a dispute
/v1/disputes/:dispute?expand=string<p>Retrieves the dispute with the given ID.</p> - POSTUpdate a dispute
/v1/disputes/:dispute<p>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… - POSTClose a dispute
/v1/disputes/:dispute/close<p>Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute (accepting it),… - GETList all active entitlements
/v1/entitlements/active_entitlements?customer=string&ending_before=string&expand=string&limit=0&starting_after=string<p>Retrieve a list of active entitlements for a customer</p> - GETRetrieve an active entitlement
/v1/entitlements/active_entitlements/:id?expand=string<p>Retrieve an active entitlement</p> - GETList all features
/v1/entitlements/features?archived=true&ending_before=string&expand=string&limit=0&lookup_key=string&starting_after=string<p>Retrieve a list of features</p> - POSTCreate a feature
/v1/entitlements/features<p>Creates a feature</p> - GETRetrieve a feature
/v1/entitlements/features/:id?expand=string<p>Retrieves a feature</p> - POSTUpdates a feature
/v1/entitlements/features/:id<p>Update a feature’s metadata or permanently deactivate it.</p> - POSTCreate an ephemeral key
/v1/ephemeral_keys<p>Creates a short-lived API key for a given resource.</p> - DELETEImmediately invalidate an ephemeral key
/v1/ephemeral_keys/:key<p>Invalidates a short-lived API key for a given resource.</p> - GETList all events
/v1/events?created={"gt":0,"gte":0,"lt":0,"lte":0}&delivery_success=true&ending_before=string&expand=string&limit=0&starting_after=string&type=string&types=string<p>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… - GETRetrieve an event
/v1/events/:id?expand=string<p>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… - GETList all exchange rates
/v1/exchange_rates?ending_before=string&expand=string&limit=0&starting_after=string<p>[Deprecated] The <code>ExchangeRate</code> APIs are deprecated. Please use the <a… - GETRetrieve an exchange rate
/v1/exchange_rates/:rate_id?expand=string<p>[Deprecated] The <code>ExchangeRate</code> APIs are deprecated. Please use the <a… - POSTUpdate a bank account
/v1/external_accounts/:id<p>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… - GETList all file links
/v1/file_links?created={"gt":0,"gte":0,"lt":0,"lte":0}&ending_before=string&expand=string&expired=true&file=string&limit=0&starting_after=string<p>Returns a list of file links.</p> - POSTCreate a file link
/v1/file_links<p>Creates a new file link object.</p> - GETRetrieve a file link
/v1/file_links/:link?expand=string<p>Retrieves the file link with the given ID.</p> - POSTUpdate a file link
/v1/file_links/:link<p>Updates an existing file link object. Expired links can no longer be updated.</p> - GETList all files
/v1/files?created={"gt":0,"gte":0,"lt":0,"lte":0}&ending_before=string&expand=string&limit=0&purpose=account_requirement&starting_after=string<p>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… - POSTCreate a file
https://files.stripe.com/v1/files<p>To upload a file to Stripe, you need to send a request of type <code>multipart/form-data</code>. Include the file you want to upload in the request, and… - GETRetrieve a file
/v1/files/:file?expand=string<p>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… - GETList Accounts
/v1/financial_connections/accounts?account_holder={"account":"string","customer":"string","customer_account":"string"}&ending_before=string&expand=string&limit=0&session=string&starting_after=string<p>Returns a list of Financial Connections <code>Account</code> objects.</p> - GETRetrieve an Account
/v1/financial_connections/accounts/:account?expand=string<p>Retrieves the details of a Financial Connections <code>Account</code>.</p> - POSTDisconnect an Account
/v1/financial_connections/accounts/:account/disconnect<p>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,… - GETList Account Owners
/v1/financial_connections/accounts/:account/owners?ending_before=string&expand=string&limit=0&ownership=string&starting_after=string<p>Lists all owners for a given <code>Account</code></p> - POSTRefresh Account data
/v1/financial_connections/accounts/:account/refresh<p>Refreshes the data associated with a Financial Connections <code>Account</code>.</p> - POSTSubscribe to data refreshes for an Account
/v1/financial_connections/accounts/:account/subscribe<p>Subscribes to periodic refreshes of data associated with a Financial Connections <code>Account</code>. When the account status is active, data is typically… - POSTUnsubscribe from data refreshes for an Account
/v1/financial_connections/accounts/:account/unsubscribe<p>Unsubscribes from periodic refreshes of data associated with a Financial Connections <code>Account</code>.</p> - POSTCreate a Session
/v1/financial_connections/sessions<p>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… - GETRetrieve a Session
/v1/financial_connections/sessions/:session?expand=string<p>Retrieves the details of a Financial Connections <code>Session</code></p> - GETList Transactions
/v1/financial_connections/transactions?account=string&ending_before=string&expand=string&limit=0&starting_after=string&transacted_at={"gt":0,"gte":0,"lt":0,"lte":0}&transaction_refresh={"after":"string"}<p>Returns a list of Financial Connections <code>Transaction</code> objects.</p> - GETRetrieve a Transaction
/v1/financial_connections/transactions/:transaction?expand=string<p>Retrieves the details of a Financial Connections <code>Transaction</code></p> - GETList all ForwardingRequests
/v1/forwarding/requests?created={"gt":0,"gte":0,"lt":0,"lte":0}&ending_before=string&expand=string&limit=0&starting_after=string<p>Lists all ForwardingRequest objects.</p> - POSTCreate a ForwardingRequest
/v1/forwarding/requests<p>Creates a ForwardingRequest object.</p> - GETRetrieve a ForwardingRequest
/v1/forwarding/requests/:id?expand=string<p>Retrieves a ForwardingRequest object.</p> - GETList VerificationReports
/v1/identity/verification_reports?client_reference_id=string&created={"gt":0,"gte":0,"lt":0,"lte":0}&ending_before=string&expand=string&limit=0&starting_after=string&type=document&verification_session=string<p>List all verification reports.</p> - GETRetrieve a VerificationReport
/v1/identity/verification_reports/:report?expand=string<p>Retrieves an existing VerificationReport</p> - GETList VerificationSessions
/v1/identity/verification_sessions?client_reference_id=string&created={"gt":0,"gte":0,"lt":0,"lte":0}&ending_before=string&expand=string&limit=0&related_customer=string&related_customer_account=string&starting_after=string&status=canceled<p>Returns a list of VerificationSessions</p> - POSTCreate a VerificationSession
/v1/identity/verification_sessions<p>Creates a VerificationSession object.</p> <p>After the VerificationSession is created, display a verification modal using the session… - GETRetrieve a VerificationSession
/v1/identity/verification_sessions/:session?expand=string<p>Retrieves the details of a VerificationSession that was previously created.</p> <p>When the session status is <code>requires_input</code>, you can use this… - POSTUpdate a VerificationSession
/v1/identity/verification_sessions/:session<p>Updates a VerificationSession object.</p> <p>When the session status is <code>requires_input</code>, you can use this method to update the verification… - POSTCancel a VerificationSession
/v1/identity/verification_sessions/:session/cancel<p>A VerificationSession object can be canceled when it is in <code>requires_input</code> <a href="/docs/identity/how-sessions-work">status</a>.</p> <p>Once… - POSTRedact a VerificationSession
/v1/identity/verification_sessions/:session/redact<p>Redact a VerificationSession to remove all collected information from Stripe. This will redact the VerificationSession and all objects related to it,… - GETList all payments for an invoice
/v1/invoice_payments?created={"gt":0,"gte":0,"lt":0,"lte":0}&ending_before=string&expand=string&invoice=string&limit=0&payment={"payment_intent":"string","payment_record":"string","type":"payment_intent"}&starting_after=string&status=canceled<p>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… - GETRetrieve an InvoicePayment
/v1/invoice_payments/:invoice_payment?expand=string<p>Retrieves the invoice payment with the given ID.</p> - GETList all invoice rendering templates
/v1/invoice_rendering_templates?ending_before=string&expand=string&limit=0&starting_after=string&status=active<p>List all templates, ordered by creation date, with the most recently created template appearing first.</p> - GETRetrieve an invoice rendering template
/v1/invoice_rendering_templates/:template?expand=string&version=0<p>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… - POSTArchive an invoice rendering template
/v1/invoice_rendering_templates/:template/archive<p>Updates the status of an invoice rendering template to ‘archived’ so no new Stripe objects (customers, invoices, etc.) can reference it. The template can… - POSTUnarchive an invoice rendering template
/v1/invoice_rendering_templates/:template/unarchive<p>Unarchive an invoice rendering template so it can be used on new Stripe objects again.</p> - GETList all invoice items
/v1/invoiceitems?created={"gt":0,"gte":0,"lt":0,"lte":0}&customer=string&customer_account=string&ending_before=string&expand=string&invoice=string&limit=0&pending=true&starting_after=string<p>Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.</p> - POSTCreate an invoice item
/v1/invoiceitems<p>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… - GETRetrieve an invoice item
/v1/invoiceitems/:invoiceitem?expand=string<p>Retrieves the invoice item with the given ID.</p> - POSTUpdate an invoice item
/v1/invoiceitems/:invoiceitem<p>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… - DELETEDelete an invoice item
/v1/invoiceitems/:invoiceitem<p>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… - GETList all invoices
/v1/invoices?collection_method=charge_automatically&created={"gt":0,"gte":0,"lt":0,"lte":0}&customer=string&customer_account=string&due_date={"gt":0,"gte":0,"lt":0,"lte":0}&ending_before=string&expand=string&limit=0&starting_after=string&status=draft&subscription=string<p>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… - POSTCreate an invoice
/v1/invoices<p>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… - POSTCreate a preview invoice
/v1/invoices/create_preview<p>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,… - GETSearch invoices
/v1/invoices/search?expand=string&limit=0&page=string&query=string<p>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… - GETRetrieve an invoice
/v1/invoices/:invoice?expand=string<p>Retrieves the invoice with the given ID.</p> - POSTUpdate an invoice
/v1/invoices/:invoice<p>Draft invoices are fully editable. Once an invoice is <a href="/docs/billing/invoices/workflow#finalized">finalized</a>, you can no longer change most of… - DELETEDelete a draft invoice
/v1/invoices/:invoice<p>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… - POSTBulk add invoice line items
/v1/invoices/:invoice/add_lines<p>Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.</p> - POSTAttach a payment to an Invoice
/v1/invoices/:invoice/attach_payment<p>Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of <code>payments</code>.</p> <p>For the PaymentIntent, when the… - POSTFinalize an invoice
/v1/invoices/:invoice/finalize<p>Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you… - GETRetrieve an invoice's line items
/v1/invoices/:invoice/lines?ending_before=string&expand=string&limit=0&starting_after=string<p>When retrieving an invoice, you’ll get a <strong>lines</strong> property containing the total count of line items and the first handful of those items.… - POSTUpdate an invoice's line item
/v1/invoices/:invoice/lines/:line_item_id<p>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… - POSTMark an invoice as uncollectible
/v1/invoices/:invoice/mark_uncollectible<p>Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.</p> - POSTPay an invoice
/v1/invoices/:invoice/pay<p>Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your <a… - POSTBulk remove invoice line items
/v1/invoices/:invoice/remove_lines<p>Removes multiple line items from an invoice. This is only possible when an invoice is still a draft.</p> - POSTSend an invoice for manual payment
/v1/invoices/:invoice/send<p>Stripe will automatically send invoices to customers according to your <a href="https://dashboard.stripe.com/account/billing/automatic">subscriptions… - POSTBulk update invoice line items
/v1/invoices/:invoice/update_lines<p>Updates multiple line items on an invoice. This is only possible when an invoice is still a draft.</p> - POSTVoid an invoice
/v1/invoices/:invoice/void<p>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… - GETList all authorizations
/v1/issuing/authorizations?card=string&cardholder=string&created={"gt":0,"gte":0,"lt":0,"lte":0}&ending_before=string&expand=string&limit=0&starting_after=string&status=closed<p>Returns a list of Issuing <code>Authorization</code> objects. The objects are sorted in descending order by creation date, with the most recently created… - GETRetrieve an authorization
/v1/issuing/authorizations/:authorization?expand=string<p>Retrieves an Issuing <code>Authorization</code> object.</p> - POSTUpdate an authorization
/v1/issuing/authorizations/:authorization<p>Updates the specified Issuing <code>Authorization</code> object by setting the values of the parameters passed. Any parameters not provided will be left… - POSTApprove an authorization
/v1/issuing/authorizations/:authorization/approveDeprecated. <p>[Deprecated] Approves a pending Issuing <code>Authorization</code> object. This request should be made within the timeout window of the <a… - POSTDecline an authorization
/v1/issuing/authorizations/:authorization/declineDeprecated. <p>[Deprecated] Declines a pending Issuing <code>Authorization</code> object. This request should be made within the timeout window of the <a… - GETList all cardholders
/v1/issuing/cardholders?created={"gt":0,"gte":0,"lt":0,"lte":0}&email=string&ending_before=string&expand=string&limit=0&phone_number=string&starting_after=string&status=active&type=company<p>Returns a list of Issuing <code>Cardholder</code> objects. The objects are sorted in descending order by creation date, with the most recently created… - POSTCreate a cardholder
/v1/issuing/cardholders<p>Creates a new Issuing <code>Cardholder</code> object that can be issued cards.</p> - GETRetrieve a cardholder
/v1/issuing/cardholders/:cardholder?expand=string<p>Retrieves an Issuing <code>Cardholder</code> object.</p> - POSTUpdate a cardholder
/v1/issuing/cardholders/:cardholder<p>Updates the specified Issuing <code>Cardholder</code> object by setting the values of the parameters passed. Any parameters not provided will be left… - GETList all cards
/v1/issuing/cards?cardholder=string&created={"gt":0,"gte":0,"lt":0,"lte":0}&ending_before=string&exp_month=0&exp_year=0&expand=string&last4=string&limit=0&personalization_design=string&starting_after=string&status=active&type=physical<p>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… - POSTCreate a card
/v1/issuing/cards<p>Creates an Issuing <code>Card</code> object.</p> - GETRetrieve a card
/v1/issuing/cards/:card?expand=string<p>Retrieves an Issuing <code>Card</code> object.</p> - POSTUpdate a card
/v1/issuing/cards/:card<p>Updates the specified Issuing <code>Card</code> object by setting the values of the parameters passed. Any parameters not provided will be left… - GETList all disputes
/v1/issuing/disputes?created={"gt":0,"gte":0,"lt":0,"lte":0}&ending_before=string&expand=string&limit=0&starting_after=string&status=expired&transaction=string<p>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… - POSTCreate a dispute
/v1/issuing/disputes<p>Creates an Issuing <code>Dispute</code> object. Individual pieces of evidence within the <code>evidence</code> object are optional at this point. Stripe… - GETRetrieve a dispute
/v1/issuing/disputes/:dispute?expand=string<p>Retrieves an Issuing <code>Dispute</code> object.</p> - POSTUpdate a dispute
/v1/issuing/disputes/:dispute<p>Updates the specified Issuing <code>Dispute</code> object by setting the values of the parameters passed. Any parameters not provided will be left… - POSTSubmit a dispute
/v1/issuing/disputes/:dispute/submit<p>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… - GETList all personalization designs
/v1/issuing/personalization_designs?ending_before=string&expand=string&limit=0&lookup_keys=string&preferences={"is_default":true,"is_platform_default":true}&starting_after=string&status=active<p>Returns a list of personalization design objects. The objects are sorted in descending order by creation date, with the most recently created object… - POSTCreate a personalization design
/v1/issuing/personalization_designs<p>Creates a personalization design object.</p> - GETRetrieve a personalization design
/v1/issuing/personalization_designs/:personalization_design?expand=string<p>Retrieves a personalization design object.</p> - POSTUpdate a personalization design
/v1/issuing/personalization_designs/:personalization_design<p>Updates a card personalization object.</p> - GETList all physical bundles
/v1/issuing/physical_bundles?ending_before=string&expand=string&limit=0&starting_after=string&status=active&type=custom<p>Returns a list of physical bundle objects. The objects are sorted in descending order by creation date, with the most recently created object appearing… - GETRetrieve a physical bundle
/v1/issuing/physical_bundles/:physical_bundle?expand=string<p>Retrieves a physical bundle object.</p> - GETRetrieve a settlement
/v1/issuing/settlements/:settlement?expand=string<p>Retrieves an Issuing <code>Settlement</code> object.</p> - POSTUpdate a settlement
/v1/issuing/settlements/:settlement<p>Updates the specified Issuing <code>Settlement</code> object by setting the values of the parameters passed. Any parameters not provided will be left… - GETList all issuing tokens for card
/v1/issuing/tokens?card=string&created={"gt":0,"gte":0,"lt":0,"lte":0}&ending_before=string&expand=string&limit=0&starting_after=string&status=active<p>Lists all Issuing <code>Token</code> objects for a given card.</p> - GETRetrieve an issuing token
/v1/issuing/tokens/:token?expand=string<p>Retrieves an Issuing <code>Token</code> object.</p> - POSTUpdate a token status
/v1/issuing/tokens/:token<p>Attempts to update the specified Issuing <code>Token</code> object to the status specified.</p> - GETList all transactions
/v1/issuing/transactions?card=string&cardholder=string&created={"gt":0,"gte":0,"lt":0,"lte":0}&ending_before=string&expand=string&limit=0&starting_after=string&type=capture<p>Returns a list of Issuing <code>Transaction</code> objects. The objects are sorted in descending order by creation date, with the most recently created… - GETRetrieve a transaction
/v1/issuing/transactions/:transaction?expand=string<p>Retrieves an Issuing <code>Transaction</code> object.</p> - POSTUpdate a transaction
/v1/issuing/transactions/:transaction<p>Updates the specified Issuing <code>Transaction</code> object by setting the values of the parameters passed. Any parameters not provided will be left… - POSTCreate a Session
/v1/link_account_sessions<p>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… - GETRetrieve a Session
/v1/link_account_sessions/:session?expand=string<p>Retrieves the details of a Financial Connections <code>Session</code></p> - GETList Accounts
/v1/linked_accounts?account_holder={"account":"string","customer":"string","customer_account":"string"}&ending_before=string&expand=string&limit=0&session=string&starting_after=string<p>Returns a list of Financial Connections <code>Account</code> objects.</p> - GETRetrieve an Account
/v1/linked_accounts/:account?expand=string<p>Retrieves the details of a Financial Connections <code>Account</code>.</p> - POSTDisconnect an Account
/v1/linked_accounts/:account/disconnect<p>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,… - GETList Account Owners
/v1/linked_accounts/:account/owners?ending_before=string&expand=string&limit=0&ownership=string&starting_after=string<p>Lists all owners for a given <code>Account</code></p>
Showing 300 of 400 endpoints. Fork the collection to see all of them.
API details
- Base URL
https://api.stripe.com- Authentication
- HTTP Basic authentication (username and password)
A bearer token in the Authorization header - Operations
- 612 operations on 431 pathsPOST 307GET 273DELETE 32
6 marked deprecated - Response formats
application/jsonapplication/pdf- Description format
- OpenAPI 3.0.0, API version
2026-09-30.endive - Links
- OpenAPI document · Terms of service · Support
- Listed from
- Stripe's published OpenAPI description (stripe/openapi) (MIT)
How to test the Stripe API (all endpoints) in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Stripe API (all endpoints) collection, without the publisher's secrets.
- Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Retrieve account” (GET /v1/account?expand=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Stripe API (all endpoints)?
The Stripe REST API. Please see https://stripe.com/docs/api for more details. It is listed under Payments and has 612 endpoints.
Who publishes the Stripe API (all endpoints)?
It is listed from Stripe's public API description (an OpenAPI document), not published by Stripe on Swastik Codes. Anyone who controls stripe.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Stripe API (all endpoints)?
Requests go to https://api.stripe.com. Endpoint paths are added to this base URL.
How do I authenticate with the Stripe API (all endpoints)?
It accepts 2 methods: HTTP Basic authentication (username and password); A bearer token in the Authorization header.
How many endpoints does the Stripe API (all endpoints) have?
612 operations on 431 paths (307 POST, 273 GET, 32 DELETE). This listing's collection holds the first 400.
Is forking the Stripe API (all endpoints) free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.