Stripe

<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 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.</p> <p>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.</p>

<p>Delete a specified external account for a given account.</p>

<p>Delete a specified external account for a given account.</p>

<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, except if the person is the <code>account_opener</code>. If your integration is using the <code>executive</code> parameter, you cannot delete the only verified <code>executive</code> on file.</p>

<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, except if the person is the <code>account_opener</code>. If your integration is using the <code>executive</code> parameter, you cannot delete the only verified <code>executive</code> on file.</p>

<p>Delete an apple pay domain.</p>

<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 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.</p>

<p>Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.</p>

<p>Delete a specified source for a given customer.</p>

<p>Delete a specified source for a given customer.</p>

<p>Removes the currently applied discount on a customer.</p>

<p>Delete a specified source for a given customer.</p>

<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 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.</p> <p>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.</p> <p>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.</p>

<p>Removes the currently applied discount on a customer.</p>

<p>Deletes an existing <code>tax_id</code> object.</p>

<p>Invalidates a short-lived API key for a given resource.</p>

<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 a draft invoice.</p>

<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 invoice has been finalized or if an invoice is for a subscription, it must be <a href="/api/invoices/void">voided</a>.</p>

<p>Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.</p>

<p>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.</p>

<p>Deletes the feature attachment to a product</p>

<p>Deletes a <code>ValueListItem</code> object, removing it from its parent value list.</p>

<p>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.</p>

<p>Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.</p>

<p>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>.</p> <p>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.</p> <p>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.</p>

<p>Removes the currently applied discount on a subscription.</p>

<p>Deletes an existing account or customer <code>tax_id</code> object.</p>

<p>Deletes a <code>Configuration</code> object.</p>

<p>Deletes a <code>Location</code> object.</p>

<p>Deletes a <code>Reader</code> object.</p>

<p>Deletes a test clock.</p>

<p>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.</p>

<p>Retrieves the details of an account.</p>

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

<p>Retrieves the details of an account.</p>

<p>Retrieve a specified external account for a given account.</p>

<p>Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.</p>

<p>Retrieves information about the specified Account Capability.</p>

<p>List external accounts for an account.</p>

<p>Retrieve a specified external account for a given account.</p>

<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 first.</p>

<p>Retrieves an existing person.</p>

<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 first.</p>

<p>Retrieves an existing person.</p>

<p>List apple pay domains.</p>

<p>Retrieve an apple pay domain.</p>

<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 first.</p>

<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 stored on the application fee.</p>

<p>Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.</p>

<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 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.</p>

<p>List all secrets stored on the given scope.</p>

<p>Finds a secret in the secret store by name and scope.</p>

<p>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>.</p>

<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 sorted order, with the most recent transactions appearing first.</p> <p>The previous name of this endpoint was “Balance history,” and it used the path <code>/v1/balance/history</code>.</p>

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

<p>Retrieves balance settings for a given connected account. Related guide: <a href="/connect/authentication">Making API calls for connected accounts</a></p>

<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 sorted order, with the most recent transactions appearing first.</p> <p>The previous name of this endpoint was “Balance history,” and it used the path <code>/v1/balance/history</code>.</p>

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

<p>Lists billing active and inactive alerts</p>

<p>Retrieves a billing alert given an ID</p>

<p>Retrieves the credit balance summary for a customer.</p>

<p>Retrieve a list of credit balance transactions.</p>

<p>Retrieves a credit balance transaction.</p>

<p>Retrieve a list of credit grants.</p>

<p>Retrieves a credit grant.</p>

<p>Retrieve a list of billing meters.</p>

<p>Retrieves a billing meter given an ID.</p>

<p>Retrieve a list of billing meter event summaries.</p>

<p>Returns a list of configurations that describe the functionality of the customer portal.</p>

<p>Retrieves a configuration that describes the functionality of the customer portal.</p>

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

<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 will return the corresponding charge information. The same information is returned when creating or refunding the charge.</p>

<p>Retrieve a dispute for a specified charge.</p>

<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 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.</p>

<p>Retrieves the details of an existing refund.</p>

<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 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.</p>

<p>Returns a list of Checkout Sessions.</p>

<p>Retrieves a Checkout Session object.</p>

<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 a URL where you can retrieve the full (paginated) list of line items.</p>

<p>Lists all Climate order objects. The orders are returned sorted by creation date, with the most recently created orders appearing first.</p>

<p>Retrieves the details of a Climate order object with the given ID.</p>

<p>Lists all available Climate product objects.</p>

<p>Retrieves the details of a Climate product with the given ID.</p>

<p>Lists all available Climate supplier objects.</p>

<p>Retrieves a Climate supplier object.</p>

<p>Retrieves an existing ConfirmationToken object</p>

<p>Lists all Country Spec objects available in the API.</p>

<p>Returns a Country Spec for a given Country code.</p>

<p>Returns a list of your coupons.</p>

<p>Retrieves the coupon with the given ID.</p>

<p>Returns a list of credit notes.</p>

<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 retrieve the full (paginated) list of line items.</p>

<p>Retrieves the credit note object with the given identifier.</p>

<p>Get a preview of a credit note without creating it.</p>

<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 the full (paginated) list of line items.</p>

<p>Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.</p>

<p>Retrieves a Customer object.</p>

<p>Returns a list of transactions that updated the customer’s <a href="/docs/billing/customer/balance">balances</a>.</p>

<p>Retrieves a specific customer balance transaction that updated the customer’s <a href="/docs/billing/customer/balance">balances</a>.</p>

<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 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.</p>

<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 specific bank account stored on the Stripe account.</p>

<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> 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.</p>

<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 customer.</p>

<p>Retrieves a customer’s cash balance.</p>

<p>Returns a list of transactions that modified the customer’s <a href="/docs/payments/customer-balance">cash balance</a>.</p>

<p>Retrieves a specific cash balance transaction, which updated the customer’s <a href="/docs/payments/customer-balance">cash balance</a>.</p>

GetCustomersCustomerDiscount

<p>Returns a list of PaymentMethods for a given Customer</p>

<p>Retrieves a PaymentMethod object for a given Customer.</p>

<p>List sources for a specified customer.</p>

<p>Retrieve a specified source for a given customer.</p>

<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 customer object. If you need more than those 10, you can use the limit and starting_after parameters to page through additional subscriptions.</p>

<p>Retrieves the subscription with the given ID.</p>

GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount

<p>Returns a list of tax IDs for a customer.</p>

<p>Retrieves the <code>tax_id</code> object with the given identifier.</p>

<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 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.</p>

<p>Returns a list of your disputes.</p>

<p>Retrieves the dispute with the given ID.</p>

<p>Retrieve a list of active entitlements for a customer</p>

<p>Retrieve an active entitlement</p>

<p>Retrieve a list of features</p>

<p>Retrieves a feature</p>

<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 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).</p>

<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 webhook.</p>

<p>[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.</p> <p>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.</p>

<p>[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.</p> <p>Retrieves the exchange rates from the given currency to every supported currency.</p>

<p>Returns a list of file links.</p>

<p>Retrieves the file link with the given ID.</p>

<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 files at the top.</p>

<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 href="/docs/file-upload#download-file-contents">access file contents</a>.</p>

<p>Returns a list of Financial Connections <code>Account</code> objects.</p>

<p>Retrieves the details of an Financial Connections <code>Account</code>.</p>

<p>Lists all owners for a given <code>Account</code></p>

<p>Retrieves the details of a Financial Connections <code>Session</code></p>

<p>Returns a list of Financial Connections <code>Transaction</code> objects.</p>

<p>Retrieves the details of a Financial Connections <code>Transaction</code></p>

<p>Lists all ForwardingRequest objects.</p>

<p>Retrieves a ForwardingRequest object.</p>

<p>List all verification reports.</p>

<p>Retrieves an existing VerificationReport</p>

<p>Returns a list of VerificationSessions</p>

<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 method to retrieve a valid <code>client_secret</code> or <code>url</code> to allow re-submission.</p>

<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 retrieve the full (paginated) list of payments.</p>

<p>Retrieves the invoice payment with the given ID.</p>

<p>List all templates, ordered by creation date, with the most recently created template appearing first.</p>

<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 previous versions.</p>

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

<p>Retrieves the invoice item with the given ID.</p>

<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 invoices appearing first.</p>

<p>Retrieves the invoice with the given ID.</p>

<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. There is also a URL where you can retrieve the full (paginated) list of line items.</p>

<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 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.</p>

<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 object appearing first.</p>

<p>Retrieves an Issuing <code>Authorization</code> object.</p>

<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 object appearing first.</p>

<p>Retrieves an Issuing <code>Cardholder</code> object.</p>

<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 appearing first.</p>

<p>Retrieves an Issuing <code>Card</code> object.</p>

<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 appearing first.</p>

<p>Retrieves an Issuing <code>Dispute</code> object.</p>

<p>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.</p>

<p>Retrieves a personalization design object.</p>

<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 first.</p>

<p>Retrieves a physical bundle object.</p>

<p>Retrieves an Issuing <code>Settlement</code> object.</p>

<p>Lists all Issuing <code>Token</code> objects for a given card.</p>

<p>Retrieves an Issuing <code>Token</code> object.</p>

<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 object appearing first.</p>

<p>Retrieves an Issuing <code>Transaction</code> object.</p>

<p>Retrieves the details of a Financial Connections <code>Session</code></p>

<p>Returns a list of Financial Connections <code>Account</code> objects.</p>

<p>Retrieves the details of an Financial Connections <code>Account</code>.</p>

<p>Lists all owners for a given <code>Account</code></p>

<p>Retrieves a Mandate object.</p>

<p>List all the Payment Attempt Records attached to the specified Payment Record.</p>

<p>Retrieves a Payment Attempt Record with the given ID</p>

<p>Returns a list of PaymentIntents.</p>

<p>Retrieves the details of a PaymentIntent that has previously been created. </p> <p>You can retrieve a PaymentIntent client-side using a publishable key when the <code>client_secret</code> is in the query string. </p> <p>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.</p>

<p>Lists all LineItems of a given PaymentIntent.</p>

<p>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.</p>

<p>Returns a list of your payment links.</p>

<p>Retrieve a payment link.</p>

<p>When retrieving a payment link, there is an includable <strong>line_items</strong> property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.</p>

<p>List payment method configurations</p>

<p>Retrieve payment method configuration</p>

<p>Lists the details of existing payment method domains.</p>

<p>Retrieves the details of an existing payment method domain.</p>

<p>Returns a list of all PaymentMethods.</p>

<p>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></p>

<p>Retrieves a Payment Record with the given ID</p>

<p>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.</p>

<p>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.</p>

<p>Returns a list of your plans.</p>

<p>Retrieves the plan with the given ID.</p>

<p>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.</p>

<p>Retrieves the price with the given ID.</p>

<p>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.</p>

<p>Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.</p>

<p>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.</p>

<p>Retrieve a list of features for a product</p>

<p>Retrieves a product_feature, which represents a feature attachment to a product</p>

<p>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.</p>

<p>Returns a list of your promotion codes.</p>

<p>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>.</p>

<p>Returns a list of your quotes.</p>

<p>Retrieves the quote with the given ID.</p>

<p>When retrieving a quote, there is an includable <a href="https://stripe.com/docs/api/quotes/object#quote_object-computed-upfront-line_items"><strong>computed.upfront.line_items</strong></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.</p>

<p>When retrieving a quote, there is an includable <strong>line_items</strong> property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.</p>

<p>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></p>

<p>Returns a list of early fraud warnings.</p>

<p>Retrieves the details of an early fraud warning that has previously been created. </p> <p>Please refer to the <a href="#early_fraud_warning_object">early fraud warning</a> object reference for more details.</p>

<p>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.</p>

<p>Retrieves a <code>ValueListItem</code> object.</p>

<p>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.</p>

<p>Retrieves a <code>ValueList</code> object.</p>

<p>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.</p>

<p>Retrieves the details of an existing refund.</p>

<p>Returns a list of Report Runs, with the most recent appearing first.</p>

<p>Retrieves the details of an existing Report Run.</p>

<p>Returns a full list of Report Types.</p>

<p>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>.)</p>

<p>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.</p>

<p>Retrieves a <code>Review</code> object.</p>

<p>Returns a list of SetupAttempts that associate with a provided SetupIntent.</p>

<p>Returns a list of SetupIntents.</p>

<p>Retrieves the details of a SetupIntent that has previously been created. </p> <p>Client-side retrieval using a publishable key is allowed when the <code>client_secret</code> is provided in the query string. </p> <p>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.</p>

<p>Returns a list of your shipping rates.</p>

<p>Returns the shipping rate object with the given ID.</p>

<p>Returns a list of scheduled query runs.</p>

<p>Retrieves the details of an scheduled query run.</p>

<p>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.</p>

<p>Retrieves a new Source MandateNotification.</p>

<p>List source transactions for a given source.</p>

<p>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.</p>

<p>Returns a list of your subscription items for a given subscription.</p>

<p>Retrieves the subscription item with the given ID.</p>

<p>Retrieves the list of your subscription schedules.</p>

<p>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.</p>

<p>By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify <code>status=canceled</code>.</p>

<p>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.</p>

<p>Retrieves the subscription with the given ID.</p>

<p>Finds a tax association object by PaymentIntent id.</p>

<p>Retrieves a Tax <code>Calculation</code> object, if the calculation hasn’t expired.</p>

<p>Retrieves the line items of a tax calculation as a collection, if the calculation hasn’t expired.</p>

<p>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.</p>

<p>Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.</p>

<p>Returns a list of tax IDs.</p>

<p>Retrieves an account or customer <code>tax_id</code> object.</p>

<p>Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.</p>

<p>Retrieves a tax rate with the given ID</p>

<p>Returns a list of Tax <code>Registration</code> objects.</p>

<p>Returns a Tax <code>Registration</code> object.</p>

<p>Retrieves Tax <code>Settings</code> for a merchant.</p>

<p>Retrieves a Tax <code>Transaction</code> object.</p>

<p>Retrieves the line items of a committed standalone transaction as a collection.</p>

<p>Returns a list of <code>Configuration</code> objects.</p>

<p>Retrieves a <code>Configuration</code> object.</p>

<p>Returns a list of <code>Location</code> objects.</p>

<p>Retrieves a <code>Location</code> object.</p>

<p>Returns a list of <code>Reader</code> objects.</p>

<p>Retrieves a <code>Reader</code> object.</p>

<p>Returns a list of your test clocks.</p>

<p>Retrieves a test clock.</p>

<p>Retrieves the token with the given ID.</p>

<p>Returns a list of top-ups.</p>

<p>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.</p>

<p>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.</p>

<p>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.</p>

<p>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.</p>

<p>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.</p>

<p>Returns a list of CreditReversals.</p>

<p>Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list</p>

<p>Returns a list of DebitReversals.</p>

<p>Retrieves a DebitReversal object.</p>

<p>Returns a list of FinancialAccounts.</p>

<p>Retrieves the details of a FinancialAccount.</p>

<p>Retrieves Features information associated with the FinancialAccount.</p>

<p>Returns a list of InboundTransfers sent from the specified FinancialAccount.</p>

<p>Retrieves the details of an existing InboundTransfer.</p>

<p>Returns a list of OutboundPayments sent from the specified FinancialAccount.</p>

<p>Retrieves the details of an existing OutboundPayment by passing the unique OutboundPayment ID from either the OutboundPayment creation request or OutboundPayment list.</p>

<p>Returns a list of OutboundTransfers sent from the specified FinancialAccount.</p>

<p>Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.</p>

<p>Returns a list of ReceivedCredits.</p>

<p>Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.</p>

<p>Returns a list of ReceivedDebits.</p>

<p>Retrieves the details of an existing ReceivedDebit by passing the unique ReceivedDebit ID from the ReceivedDebit list</p>

<p>Retrieves a list of TransactionEntry objects.</p>

<p>Retrieves a TransactionEntry object.</p>

<p>Retrieves a list of Transaction objects.</p>

<p>Retrieves the details of an existing Transaction.</p>

<p>Returns a list of your webhook endpoints.</p>

<p>Retrieves the webhook endpoint with the given ID.</p>

<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 Onboarding flow.</p>

<p>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.</p>

<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 href="https://dashboard.stripe.com/account/applications/settings">register your platform</a>.</p> <p>If you’ve already collected information for your connected accounts, you <a href="/docs/connect/best-practices#onboarding">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.</p>

<p>Updates a <a href="/connect/accounts">connected account</a> by setting the values of the parameters passed. Any parameters not provided are left unchanged.</p> <p>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.</p> <p>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.</p> <p>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.</p>

<p>Create an external account for a given account.</p>

<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 its currency. Other bank account details are not editable by design.</p> <p>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>.</p> <p>You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.</p>

<p>Updates an existing Account Capability. Request or remove a capability by updating its <code>requested</code> parameter.</p>

<p>Create an external account for a given account.</p>

<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 its currency. Other bank account details are not editable by design.</p> <p>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>.</p> <p>You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.</p>

<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 href="/connect/express-dashboard">Express Dashboard</a> and are connected to your platform</strong>.</p>

<p>Creates a new person.</p>

<p>Updates an existing person.</p>

<p>Creates a new person.</p>

<p>Updates an existing person.</p>

<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 negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.</p>

<p>Create an apple pay domain.</p>

<p>Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p> <p>This request only accepts metadata as an argument.</p>

PostApplicationFeesIdRefund

<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 originally collected.</p> <p>You can optionally refund only part of an application fee. You can do so multiple times, until the entire fee has been refunded.</p> <p>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.</p>

<p>Create or replace a secret in the secret store.</p>

<p>Deletes a secret from the secret store by name and scope.</p>

<p>Updates balance settings for a given connected account. Related guide: <a href="/connect/authentication">Making API calls for connected accounts</a></p>

<p>Creates a billing alert</p>

<p>Reactivates this alert, allowing it to trigger again.</p>

<p>Archives this alert, removing it from the list view and APIs. This is non-reversible.</p>

<p>Deactivates this alert, preventing it from triggering.</p>

<p>Creates a credit grant.</p>

<p>Updates a credit grant.</p>

<p>Expires a credit grant.</p>

<p>Voids a credit grant.</p>

<p>Creates a billing meter event adjustment.</p>

<p>Creates a billing meter event.</p>

<p>Creates a billing meter.</p>

<p>Updates a billing meter.</p>

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

<p>When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.</p>

<p>Creates a configuration that describes the functionality and behavior of a PortalSession</p>

<p>Updates a configuration that describes the functionality of the customer portal.</p>

<p>Creates a session of the customer portal.</p>

<p>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.</p>

<p>Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>

<p>Capture the payment of an existing, uncaptured charge that was created with the <code>capture</code> option set to false.</p> <p>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.</p> <p>Don’t use this method to capture a PaymentIntent-initiated charge. Use <a href="/docs/api/payment_intents/capture">Capture a PaymentIntent</a>.</p>

PostChargesChargeDispute

PostChargesChargeDisputeClose

<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 refunded yet. Funds are refunded to the credit or debit card that’s originally charged.</p> <p>You can optionally refund only part of a charge. You can repeat this until the entire charge is refunded.</p> <p>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.</p>

<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 that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged.</p> <p>You can optionally refund only part of a charge. You can do so multiple times, until the entire charge has been refunded.</p> <p>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.</p>

<p>Update a specified refund.</p>

<p>Creates a Checkout Session object.</p>

<p>Updates a Checkout Session object.</p> <p>Related guide: <a href="/payments/advanced/dynamic-updates">Dynamically update a Checkout Session</a></p>

<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 Session and customers loading the Checkout Session see a message saying the Checkout Session is expired.</p>

<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 balance.</p>

<p>Updates the specified order by setting the values of the parameters passed.</p>

<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 <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>.</p>

<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 also accessible via the API if you need to create coupons on the fly.</p> <p>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.</p>

<p>Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.</p>

<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 <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:</p> <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> <p>The sum of refunds, customer balance credits, and outside of Stripe credits must equal the <code>post_payment_amount</code>.</p> <p>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.</p> <p>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.</p>

<p>Updates an existing credit note.</p>

<p>Marks a credit note as void. Learn more about <a href="/docs/billing/invoices/credit-notes#voiding">voiding credit notes</a>.</p>

<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 customer resources.</p>

<p>Creates a new customer object.</p>

<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 <strong>source</strong> 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 <strong>source</strong> 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 <strong>default_source</strong> for a customer doesn’t trigger this behavior.</p> <p>This request accepts mostly the same arguments as the customer creation call.</p>

<p>Creates an immutable transaction that updates the customer’s credit <a href="/docs/billing/customer/balance">balance</a>.</p>

<p>Most credit balance transaction fields are immutable, but you may update its <code>description</code> and <code>metadata</code>.</p>

<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 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>.</p>

<p>Update a specified source for a given customer.</p>