Stripe API

Tools (448)

Extracted live via the executor SDK.

• account.getAccount

  Retrieves the details of an account.

• accountLinks.postAccountLinks

  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.

• accounts.deleteAccountsAccount

  With Connect, you can delete accounts you manage.

  Accounts created using test-mode keys can be deleted at any time. Standard accounts created using live-mode keys cannot be deleted. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero.

  If you want to delete your own account, use the account information tab in your account settings instead.

• accounts.deleteAccountsAccountBankAccountsId

  Delete a specified external account for a given account.

• accounts.deleteAccountsAccountExternalAccountsId

  Delete a specified external account for a given account.

• accounts.deleteAccountsAccountPeoplePerson

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

• accounts.deleteAccountsAccountPersonsPerson

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

• accounts.getAccounts

  Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.

• accounts.getAccountsAccount

  Retrieves the details of an account.

• accounts.getAccountsAccountBankAccountsId

  Retrieve a specified external account for a given account.

• accounts.getAccountsAccountCapabilities

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

• accounts.getAccountsAccountCapabilitiesCapability

  Retrieves information about the specified Account Capability.

• accounts.getAccountsAccountExternalAccounts

  List external accounts for an account.

• accounts.getAccountsAccountExternalAccountsId

  Retrieve a specified external account for a given account.

• accounts.getAccountsAccountPeople

  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.

• accounts.getAccountsAccountPeoplePerson

  Retrieves an existing person.

• accounts.getAccountsAccountPersons

  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.

• accounts.getAccountsAccountPersonsPerson

  Retrieves an existing person.

• accounts.postAccounts

  With Connect, you can create Stripe accounts for your users. To do this, you’ll first need to register your platform.

  If you’ve already collected information for your connected accounts, you can pre-fill that information when creating the account. Connect Onboarding won’t ask for the pre-filled information during account onboarding. You can pre-fill any information on the account.

• accounts.postAccountsAccount

  Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged.

  For Custom accounts, you can update any information on the account. For other accounts, you can update all information until that account has started to go through Connect Onboarding. Once you create an Account Link for a Standard or Express account, some parameters can no longer be changed. These are marked as Custom Only or Custom and Express below.

  To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

• accounts.postAccountsAccountBankAccounts

  Create an external account for a given account.

• accounts.postAccountsAccountBankAccountsId

  Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

  You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

• accounts.postAccountsAccountCapabilitiesCapability

  Updates an existing Account Capability.

• accounts.postAccountsAccountExternalAccounts

  Create an external account for a given account.

• accounts.postAccountsAccountExternalAccountsId

  Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

  You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

• accounts.postAccountsAccountLoginLinks

  Creates a single-use login link for an Express account to access their Stripe dashboard.

  You may only create login links for Express accounts connected to your platform.

• accounts.postAccountsAccountPeople

  Creates a new person.

• accounts.postAccountsAccountPeoplePerson

  Updates an existing person.

• accounts.postAccountsAccountPersons

  Creates a new person.

• accounts.postAccountsAccountPersonsPerson

  Updates an existing person.

• accounts.postAccountsAccountReject

  With Connect, you may flag accounts as suspicious.

  Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero.

• applePay.deleteApplePayDomainsDomain

  Delete an apple pay domain.

• applePay.getApplePayDomains

  List apple pay domains.

• applePay.getApplePayDomainsDomain

  Retrieve an apple pay domain.

• applePay.postApplePayDomains

  Create an apple pay domain.

• applicationFees.getApplicationFees

  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.

• applicationFees.getApplicationFeesFeeRefundsId

  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.

• applicationFees.getApplicationFeesId

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

• applicationFees.getApplicationFeesIdRefunds

  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 limit and starting_after parameters to page through additional refunds.

• applicationFees.postApplicationFeesFeeRefundsId

  Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

  This request only accepts metadata as an argument.

• applicationFees.postApplicationFeesIdRefund
• applicationFees.postApplicationFeesIdRefunds

  Refunds an application fee that has previously been collected but not yet refunded. Funds will be refunded to the Stripe account from which the fee was originally collected.

  You can optionally refund only part of an application fee. You can do so multiple times, until the entire fee has been refunded.

  Once entirely refunded, an application fee can’t be refunded again. This method will raise an error when called on an already-refunded application fee, or when trying to refund more money than is left on an application fee.

• apps.getAppsSecrets

  List all secrets stored on the given scope.

• apps.getAppsSecretsFind

  Finds a secret in the secret store by name and scope.

• apps.postAppsSecrets

  Create or replace a secret in the secret store.

• apps.postAppsSecretsDelete

  Deletes a secret from the secret store by name and scope.

• balance.getBalance

  Retrieves the current account balance, based on the authentication that was used to make the request. For a sample request, see Accounting for negative balances.

• balance.getBalanceHistory

  Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

  Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

• balance.getBalanceHistoryId

  Retrieves the balance transaction with the given ID.

  Note that this endpoint previously used the path /v1/balance/history/:id.

• balanceTransactions.getBalanceTransactions

  Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.

  Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

• balanceTransactions.getBalanceTransactionsId

  Retrieves the balance transaction with the given ID.

  Note that this endpoint previously used the path /v1/balance/history/:id.

• billingPortal.getBillingPortalConfigurations

  Returns a list of configurations that describe the functionality of the customer portal.

• billingPortal.getBillingPortalConfigurationsConfiguration

  Retrieves a configuration that describes the functionality of the customer portal.

• billingPortal.postBillingPortalConfigurations

  Creates a configuration that describes the functionality and behavior of a PortalSession

• billingPortal.postBillingPortalConfigurationsConfiguration

  Updates a configuration that describes the functionality of the customer portal.

• billingPortal.postBillingPortalSessions

  Creates a session of the customer portal.

• charges.getCharges

  Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.

• charges.getChargesCharge

  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.

• charges.getChargesChargeDispute

  Retrieve a dispute for a specified charge.

• charges.getChargesChargeRefunds

  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 limit and starting_after parameters to page through additional refunds.

• charges.getChargesChargeRefundsRefund

  Retrieves the details of an existing refund.

• charges.getChargesSearch

  Search for charges you’ve previously created using Stripe’s Search Query Language. 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.

• charges.postCharges

  To charge a credit card or other payment source, you create a Charge object. If your API key is in test mode, the supplied payment source (e.g., card) won’t actually be charged, although everything else will occur as if in live mode. (Stripe assumes that the charge would have completed successfully).

• charges.postChargesCharge

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

• charges.postChargesChargeCapture

  Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step payment flow, where first you created a charge with the capture option set to false.

  Uncaptured payments expire a set number of days after they are created (7 by default). If they are not captured by that point in time, they will be marked as refunded and will no longer be capturable.

• charges.postChargesChargeDispute
• charges.postChargesChargeDisputeClose
• charges.postChargesChargeRefund

  When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.

  Creating a new refund will refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged.

  You can optionally refund only part of a charge. You can do so multiple times, until the entire charge has been refunded.

  Once entirely refunded, a charge can’t be refunded again. This method will raise an error when called on an already-refunded charge, or when trying to refund more money than is left on a charge.

• charges.postChargesChargeRefunds

  Create a refund.

• charges.postChargesChargeRefundsRefund

  Update a specified refund.

• checkout.getCheckoutSessions

  Returns a list of Checkout Sessions.

• checkout.getCheckoutSessionsSession

  Retrieves a Session object.

• checkout.getCheckoutSessionsSessionLineItems

  When retrieving a Checkout Session, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

• checkout.postCheckoutSessions

  Creates a Session object.

• checkout.postCheckoutSessionsSessionExpire

  A Session can be expired when it is in one of these statuses: open

  After it expires, a customer can’t complete a Session and customers loading the Session see a message saying the Session is expired.

• countrySpecs.getCountrySpecs

  Lists all Country Spec objects available in the API.

• countrySpecs.getCountrySpecsCountry

  Returns a Country Spec for a given Country code.

• coupons.deleteCouponsCoupon

  You can delete coupons via the coupon management 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.

• coupons.getCoupons

  Returns a list of your coupons.

• coupons.getCouponsCoupon

  Retrieves the coupon with the given ID.

• coupons.postCoupons

  You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.

  A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice’s subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.

• coupons.postCouponsCoupon

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

• creditNotes.getCreditNotes

  Returns a list of credit notes.

• creditNotes.getCreditNotesCreditNoteLines

  When retrieving a credit note, you’ll get a lines property containing the the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

• creditNotes.getCreditNotesId

  Retrieves the credit note object with the given identifier.

• creditNotes.getCreditNotesPreview

  Get a preview of a credit note without creating it.

• creditNotes.getCreditNotesPreviewLines

  When retrieving a credit note preview, you’ll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.

• creditNotes.postCreditNotes

  Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result in any combination of the following:

  • Refund: create a new refund (using refund_amount) or link an existing refund (using refund).
  • Customer balance credit: credit the customer’s balance (using credit_amount) which will be automatically applied to their next invoice when it’s finalized.
  • Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).

  For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total.

  You may issue multiple credit notes for an invoice. Each credit note will increment the invoice’s pre_payment_credit_notes_amount or post_payment_credit_notes_amount depending on its status at the time of credit note creation.

• creditNotes.postCreditNotesId

  Updates an existing credit note.

• creditNotes.postCreditNotesIdVoid

  Marks a credit note as void. Learn more about voiding credit notes.

• customers.deleteCustomersCustomer

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

• customers.deleteCustomersCustomerBankAccountsId

  Delete a specified source for a given customer.

• customers.deleteCustomersCustomerCardsId

  Delete a specified source for a given customer.

• customers.deleteCustomersCustomerDiscount

  Removes the currently applied discount on a customer.

• customers.deleteCustomersCustomerSourcesId

  Delete a specified source for a given customer.

• customers.deleteCustomersCustomerSubscriptionsSubscriptionExposedId

  Cancels a customer’s subscription. If you set the at_period_end parameter to true, 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 false value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription.

  Note, however, that any pending invoice items that you’ve created will still be charged for at the end of the period, unless manually deleted. If you’ve set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.

  By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

• customers.deleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount

  Removes the currently applied discount on a customer.

• customers.deleteCustomersCustomerTaxIdsId

  Deletes an existing TaxID object.

• customers.getCustomers

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

• customers.getCustomersCustomer

  Retrieves a Customer object.

• customers.getCustomersCustomerBalanceTransactions

  Returns a list of transactions that updated the customer’s balances.

• customers.getCustomersCustomerBalanceTransactionsTransaction

  Retrieves a specific customer balance transaction that updated the customer’s balances.

• customers.getCustomersCustomerBankAccounts

  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 limit and starting_after parameters to page through additional bank accounts.

• customers.getCustomersCustomerBankAccountsId

  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.

• customers.getCustomersCustomerCards

  You can see a list of the cards belonging to a customer. Note that the 10 most recent sources are always available on the Customer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional cards.

• customers.getCustomersCustomerCardsId

  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.

• customers.getCustomersCustomerCashBalance

  Retrieves a customer’s cash balance.

• customers.getCustomersCustomerCashBalanceTransactions

  Returns a list of transactions that modified the customer’s cash balance.

• customers.getCustomersCustomerCashBalanceTransactionsTransaction

  Retrieves a specific cash balance transaction, which updated the customer’s cash balance.

• customers.getCustomersCustomerDiscount
• customers.getCustomersCustomerPaymentMethods

  Returns a list of PaymentMethods for a given Customer

• customers.getCustomersCustomerPaymentMethodsPaymentMethod

  Retrieves a PaymentMethod object for a given Customer.

• customers.getCustomersCustomerSources

  List sources for a specified customer.

• customers.getCustomersCustomerSourcesId

  Retrieve a specified source for a given customer.

• customers.getCustomersCustomerSubscriptions

  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.

• customers.getCustomersCustomerSubscriptionsSubscriptionExposedId

  Retrieves the subscription with the given ID.

• customers.getCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount
• customers.getCustomersCustomerTaxIds

  Returns a list of tax IDs for a customer.

• customers.getCustomersCustomerTaxIdsId

  Retrieves the TaxID object with the given identifier.

• customers.getCustomersSearch

  Search for customers you’ve previously created using Stripe’s Search Query Language. 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.

• customers.postCustomers

  Creates a new customer object.

• customers.postCustomersCustomer

  Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.

  This request accepts mostly the same arguments as the customer creation call.

• customers.postCustomersCustomerBalanceTransactions

  Creates an immutable transaction that updates the customer’s credit balance.

• customers.postCustomersCustomerBalanceTransactionsTransaction

  Most credit balance transaction fields are immutable, but you may update its description and metadata.

• customers.postCustomersCustomerBankAccounts

  When you create a new credit card, you must specify a customer or recipient on which to create it.

  If the card’s owner has no default card, then the new card will become the default. However, if the owner already has a default, then it will not change. To change the default, you should update the customer to have a new default_source.

• customers.postCustomersCustomerBankAccountsId

  Update a specified source for a given customer.

• customers.postCustomersCustomerBankAccountsIdVerify

  Verify a specified bank account for a given customer.

• customers.postCustomersCustomerCards

  When you create a new credit card, you must specify a customer or recipient on which to create it.

  If the card’s owner has no default card, then the new card will become the default. However, if the owner already has a default, then it will not change. To change the default, you should update the customer to have a new default_source.

• customers.postCustomersCustomerCardsId

  Update a specified source for a given customer.

• customers.postCustomersCustomerCashBalance

  Changes the settings on a customer’s cash balance.

• customers.postCustomersCustomerFundingInstructions

  Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new funding instructions will be created. If funding instructions have already been created for a given customer, the same funding instructions will be retrieved. In other words, we will return the same funding instructions each time.

• customers.postCustomersCustomerSources

  When you create a new credit card, you must specify a customer or recipient on which to create it.

  If the card’s owner has no default card, then the new card will become the default. However, if the owner already has a default, then it will not change. To change the default, you should update the customer to have a new default_source.

• customers.postCustomersCustomerSourcesId

  Update a specified source for a given customer.

• customers.postCustomersCustomerSourcesIdVerify

  Verify a specified bank account for a given customer.

• customers.postCustomersCustomerSubscriptions

  Creates a new subscription on an existing customer.

• customers.postCustomersCustomerSubscriptionsSubscriptionExposedId

  Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint.

• customers.postCustomersCustomerTaxIds

  Creates a new TaxID object for a customer.

• disputes.getDisputes

  Returns a list of your disputes.

• disputes.getDisputesDispute

  Retrieves the dispute with the given ID.

• disputes.postDisputesDispute

  When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.

  Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our guide to dispute types.

• disputes.postDisputesDisputeClose

  Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

  The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.

• ephemeralKeys.deleteEphemeralKeysKey

  Invalidates a short-lived API key for a given resource.

• ephemeralKeys.postEphemeralKeys

  Creates a short-lived API key for a given resource.

• events.getEvents

  List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event object api_version attribute (not according to your current Stripe API version or Stripe-Version header).

• events.getEventsId

  Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.

• exchangeRates.getExchangeRates

  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.

• exchangeRates.getExchangeRatesRateId

  Retrieves the exchange rates from the given currency to every supported currency.

• fileLinks.getFileLinks

  Returns a list of file links.

• fileLinks.getFileLinksLink

  Retrieves the file link with the given ID.

• fileLinks.postFileLinks

  Creates a new file link object.

• fileLinks.postFileLinksLink

  Updates an existing file link object. Expired links can no longer be updated.

• files.getFiles

  Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.

• files.getFilesFile

  Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the File Upload Guide.

• files.postFiles

  To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

  All of Stripe’s officially supported Client libraries should have support for sending multipart/form-data.

• financialConnections.getFinancialConnectionsAccounts

  Returns a list of Financial Connections Account objects.

• financialConnections.getFinancialConnectionsAccountsAccount

  Retrieves the details of an Financial Connections Account.

• financialConnections.getFinancialConnectionsAccountsAccountOwners

  Lists all owners for a given Account

• financialConnections.getFinancialConnectionsSessionsSession

  Retrieves the details of a Financial Connections Session

• financialConnections.postFinancialConnectionsAccountsAccountDisconnect

  Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).

• financialConnections.postFinancialConnectionsAccountsAccountRefresh

  Refreshes the data associated with a Financial Connections Account.

• financialConnections.postFinancialConnectionsSessions

  To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.

• identity.getIdentityVerificationReports

  List all verification reports.

• identity.getIdentityVerificationReportsReport

  Retrieves an existing VerificationReport

• identity.getIdentityVerificationSessions

  Returns a list of VerificationSessions

• identity.getIdentityVerificationSessionsSession

  Retrieves the details of a VerificationSession that was previously created.

  When the session status is requires_input, you can use this method to retrieve a valid client_secret or url to allow re-submission.

• identity.postIdentityVerificationSessions

  Creates a VerificationSession object.

  After the VerificationSession is created, display a verification modal using the session client_secret or send your users to the session’s url.

  If your API key is in test mode, verification checks won’t actually process, though everything else will occur as if in live mode.

  Related guide: Verify your users’ identity documents.

• identity.postIdentityVerificationSessionsSession

  Updates a VerificationSession object.

  When the session status is requires_input, you can use this method to update the verification check and options.

• identity.postIdentityVerificationSessionsSessionCancel

  A VerificationSession object can be canceled when it is in requires_input status.

  Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.

• identity.postIdentityVerificationSessionsSessionRedact

  Redact a VerificationSession to remove all collected information from Stripe. This will redact the VerificationSession and all objects related to it, including VerificationReports, Events, request logs, etc.

  A VerificationSession object can be redacted when it is in requires_input or verified status. Redacting a VerificationSession in requires_action state will automatically cancel it.

  The redaction process may take up to four days. When the redaction process is in progress, the VerificationSession’s redaction.status field will be set to processing; when the process is finished, it will change to redacted and an identity.verification_session.redacted event will be emitted.

  Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the fields that contain personal data will be replaced by the string [redacted] or a similar placeholder. The metadata field will also be erased. Redacted objects cannot be updated or used for any purpose.

  Learn more.

• invoiceitems.deleteInvoiceitemsInvoiceitem

  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.

• invoiceitems.getInvoiceitems

  Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.

• invoiceitems.getInvoiceitemsInvoiceitem

  Retrieves the invoice item with the given ID.

• invoiceitems.postInvoiceitems

  Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified.

• invoiceitems.postInvoiceitemsInvoiceitem

  Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it’s attached to is closed.

• invoices.deleteInvoicesInvoice

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

• invoices.getInvoices

  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.

• invoices.getInvoicesInvoice

  Retrieves the invoice with the given ID.

• invoices.getInvoicesInvoiceLines

  When retrieving an invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

• invoices.getInvoicesSearch

  Search for invoices you’ve previously created using Stripe’s Search Query Language. 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.

• invoices.getInvoicesUpcoming

  At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

  Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.

  You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass a proration_date parameter when doing the actual subscription update. The value passed in should be the same as the subscription_proration_date returned on the upcoming invoice resource. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date on the upcoming invoice resource.

• invoices.getInvoicesUpcomingLines

  When retrieving an upcoming invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

• invoices.postInvoices

  This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you finalize the invoice, which allows you to pay or send the invoice to your customers.

• invoices.postInvoicesInvoice

  Draft invoices are fully editable. Once an invoice is finalized, monetary values, as well as collection_method, become uneditable.

  If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on, sending reminders for, or automatically reconciling invoices, pass auto_advance=false.

• invoices.postInvoicesInvoiceFinalize

  Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method.

• invoices.postInvoicesInvoiceMarkUncollectible

  Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.

• invoices.postInvoicesInvoicePay

  Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.

• invoices.postInvoicesInvoiceSend

  Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.

  Requests made in test-mode result in no emails being sent, despite sending an invoice.sent event.

• invoices.postInvoicesInvoiceVoid

  Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

• issuing.getIssuingAuthorizations

  Returns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

• issuing.getIssuingAuthorizationsAuthorization

  Retrieves an Issuing Authorization object.

• issuing.getIssuingCardholders

  Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

• issuing.getIssuingCardholdersCardholder

  Retrieves an Issuing Cardholder object.

• issuing.getIssuingCards

  Returns a list of Issuing Card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

• issuing.getIssuingCardsCard

  Retrieves an Issuing Card object.

• issuing.getIssuingDisputes

  Returns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

• issuing.getIssuingDisputesDispute

  Retrieves an Issuing Dispute object.

• issuing.getIssuingSettlements

  Returns a list of Issuing Settlement objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

• issuing.getIssuingSettlementsSettlement

  Retrieves an Issuing Settlement object.

• issuing.getIssuingTransactions

  Returns a list of Issuing Transaction objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

• issuing.getIssuingTransactionsTransaction

  Retrieves an Issuing Transaction object.

• issuing.postIssuingAuthorizationsAuthorization

  Updates the specified Issuing Authorization object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

• issuing.postIssuingAuthorizationsAuthorizationApprove

  Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow. You can also respond directly to the webhook request to approve an authorization (preferred). More details can be found here.

• issuing.postIssuingAuthorizationsAuthorizationDecline

  Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow. You can also respond directly to the webhook request to decline an authorization (preferred). More details can be found here.

• issuing.postIssuingCardholders

  Creates a new Issuing Cardholder object that can be issued cards.

• issuing.postIssuingCardholdersCardholder

  Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

• issuing.postIssuingCards

  Creates an Issuing Card object.

• issuing.postIssuingCardsCard

  Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

• issuing.postIssuingDisputes

  Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to Dispute reasons and evidence for more details about evidence requirements.

• issuing.postIssuingDisputesDispute

  Updates the specified Issuing Dispute object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the evidence object can be unset by passing in an empty string.

• issuing.postIssuingDisputesDisputeSubmit

  Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute’s reason are present. For more details, see Dispute reasons and evidence.

• issuing.postIssuingSettlementsSettlement

  Updates the specified Issuing Settlement object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

• issuing.postIssuingTransactionsTransaction

  Updates the specified Issuing Transaction object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

• linkAccountSessions.getLinkAccountSessionsSession

  Retrieves the details of a Financial Connections Session

• linkAccountSessions.postLinkAccountSessions

  To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.

• linkedAccounts.getLinkedAccounts

  Returns a list of Financial Connections Account objects.

• linkedAccounts.getLinkedAccountsAccount

  Retrieves the details of an Financial Connections Account.

• linkedAccounts.getLinkedAccountsAccountOwners

  Lists all owners for a given Account

• linkedAccounts.postLinkedAccountsAccountDisconnect

  Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).

• linkedAccounts.postLinkedAccountsAccountRefresh

  Refreshes the data associated with a Financial Connections Account.

• mandates.getMandatesMandate

  Retrieves a Mandate object.

• paymentIntents.getPaymentIntents

  Returns a list of PaymentIntents.

• paymentIntents.getPaymentIntentsIntent

  Retrieves the details of a PaymentIntent that has previously been created.

  Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string.

  When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the payment intent object reference for more details.

• paymentIntents.getPaymentIntentsSearch

  Search for PaymentIntents you’ve previously created using Stripe’s Search Query Language. 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.

• paymentIntents.postPaymentIntents

  Creates a PaymentIntent object.

  After the PaymentIntent is created, attach a payment method and confirm to continue the payment. You can read more about the different payment flows available via the Payment Intents API here.

  When confirm=true is used during creation, it is equivalent to creating and confirming the PaymentIntent in the same call. You may use any parameters available in the confirm API when confirm=true is supplied.

• paymentIntents.postPaymentIntentsIntent

  Updates properties on a PaymentIntent object without confirming.

  Depending on which properties you update, you may need to confirm the PaymentIntent again. For example, updating the payment_method will always require you to confirm the PaymentIntent again. If you prefer to update and confirm at the same time, we recommend updating properties via the confirm API instead.

• paymentIntents.postPaymentIntentsIntentApplyCustomerBalance

  Manually reconcile the remaining amount for a customer_balance PaymentIntent.

• paymentIntents.postPaymentIntentsIntentCancel

  A PaymentIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, in rare cases, processing.

  Once canceled, no additional charges will be made by the PaymentIntent and any operations on the PaymentIntent will fail with an error. For PaymentIntents with status=’requires_capture’, the remaining amount_capturable will automatically be refunded.

  You cannot cancel the PaymentIntent for a Checkout Session. Expire the Checkout Session instead.

• paymentIntents.postPaymentIntentsIntentCapture

  Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

  Uncaptured PaymentIntents will be canceled a set number of days after they are created (7 by default).

  Learn more about separate authorization and capture.

• paymentIntents.postPaymentIntentsIntentConfirm

  Confirm that your customer intends to pay with current or provided payment method. Upon confirmation, the PaymentIntent will attempt to initiate a payment. If the selected payment method requires additional authentication steps, the PaymentIntent will transition to the requires_action status and suggest additional actions via next_action. If payment fails, the PaymentIntent will transition to the requires_payment_method status. If payment succeeds, the PaymentIntent will transition to the succeeded status (or requires_capture, if capture_method is set to manual). If the confirmation_method is automatic, payment may be attempted using our client SDKs and the PaymentIntent’s client_secret. After next_actions are handled by the client, no additional confirmation is required to complete the payment. If the confirmation_method is manual, all payment attempts must be initiated using a secret key. If any actions are required for the payment, the PaymentIntent will return to the requires_confirmation state after those actions are completed. Your server needs to then explicitly re-confirm the PaymentIntent to initiate the next payment attempt. Read the expanded documentation to learn more about manual confirmation.

• paymentIntents.postPaymentIntentsIntentIncrementAuthorization

  Perform an incremental authorization on an eligible PaymentIntent. To be eligible, the PaymentIntent’s status must be requires_capture and incremental_authorization_supported must be true.

  Incremental authorizations attempt to increase the authorized amount on your customer’s card to the new, higher amount provided. As with the initial authorization, incremental authorizations may be declined. A single PaymentIntent can call this endpoint multiple times to further increase the authorized amount.

  If the incremental authorization succeeds, the PaymentIntent object is returned with the updated amount. If the incremental authorization fails, a card_declined error is returned, and no fields on the PaymentIntent or Charge are updated. The PaymentIntent object remains capturable for the previously authorized amount.

  Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines. Once captured, a PaymentIntent can no longer be incremented.

  Learn more about incremental authorizations.

• paymentIntents.postPaymentIntentsIntentVerifyMicrodeposits

  Verifies microdeposits on a PaymentIntent object.

• paymentLinks.getPaymentLinks

  Returns a list of your payment links.

• paymentLinks.getPaymentLinksPaymentLink

  Retrieve a payment link.

• paymentLinks.getPaymentLinksPaymentLinkLineItems

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

• paymentLinks.postPaymentLinks

  Creates a payment link.

• paymentLinks.postPaymentLinksPaymentLink

  Updates a payment link.

• paymentMethods.getPaymentMethods

  Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the List a Customer’s PaymentMethods API instead.

• paymentMethods.getPaymentMethodsPaymentMethod

  Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use Retrieve a Customer’s PaymentMethods

• paymentMethods.postPaymentMethods

  Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.

  Instead of creating a PaymentMethod directly, we recommend using the PaymentIntents API to accept a payment immediately or the SetupIntent API to collect payment method details ahead of a future payment.

• paymentMethods.postPaymentMethodsPaymentMethod

  Updates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated.

• paymentMethods.postPaymentMethodsPaymentMethodAttach

  Attaches a PaymentMethod object to a Customer.

  To attach a new PaymentMethod to a customer for future payments, we recommend you use a SetupIntent or a PaymentIntent with setup_future_usage. These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for future use, which makes later declines and payment friction more likely. See Optimizing cards for future payments for more information about setting up future payments.

  To use this PaymentMethod as the default for invoice or subscription payments, set invoice_settings.default_payment_method, on the Customer to the PaymentMethod’s ID.

• paymentMethods.postPaymentMethodsPaymentMethodDetach

  Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer.

• payouts.getPayouts

  Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.

• payouts.getPayoutsPayout

  Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list, and Stripe will return the corresponding payout information.

• payouts.postPayouts

  To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.

  If your API key is in test mode, money won’t actually be sent, though everything else will occur as if in live mode.

  If you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type.

• payouts.postPayoutsPayout

  Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.

• payouts.postPayoutsPayoutCancel

  A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.

• payouts.postPayoutsPayoutReverse

  Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in the pending status, /v1/payouts/:id/cancel should be used instead.

  By requesting a reversal via /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account has authorized the debit on the bank account and that no other authorization is required.

• plans.deletePlansPlan

  Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.

• plans.getPlans

  Returns a list of your plans.

• plans.getPlansPlan

  Retrieves the plan with the given ID.

• plans.postPlans

  You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

• plans.postPlansPlan

  Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan’s ID, amount, currency, or billing cycle.

• prices.getPrices

  Returns a list of your prices.

• prices.getPricesPrice

  Retrieves the price with the given ID.

• prices.getPricesSearch

  Search for prices you’ve previously created using Stripe’s Search Query Language. 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.

• prices.postPrices

  Creates a new price for an existing product. The price can be recurring or one-time.

• prices.postPricesPrice

  Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.

• products.deleteProductsId

  Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.

• products.getProducts

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

• products.getProductsId

  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.

• products.getProductsSearch

  Search for products you’ve previously created using Stripe’s Search Query Language. 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.

• products.postProducts

  Creates a new product object.

• products.postProductsId

  Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

• promotionCodes.getPromotionCodes

  Returns a list of your promotion codes.

• promotionCodes.getPromotionCodesPromotionCode

  Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use list with the desired code.

• promotionCodes.postPromotionCodes

  A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.

• promotionCodes.postPromotionCodesPromotionCode

  Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.

• quotes.getQuotes

  Returns a list of your quotes.

• quotes.getQuotesQuote

  Retrieves the quote with the given ID.

• quotes.getQuotesQuoteComputedUpfrontLineItems

  When retrieving a quote, there is an includable computed.upfront.line_items 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.

• quotes.getQuotesQuoteLineItems

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

• quotes.getQuotesQuotePdf

  Download the PDF for a finalized quote

• quotes.postQuotes

  A quote models prices and services for a customer. Default options for header, description, footer, and expires_at can be set in the dashboard via the quote template.

• quotes.postQuotesQuote

  A quote models prices and services for a customer.

• quotes.postQuotesQuoteAccept

  Accepts the specified quote.

• quotes.postQuotesQuoteCancel

  Cancels the quote.

• quotes.postQuotesQuoteFinalize

  Finalizes the quote.

• radar.deleteRadarValueListItemsItem

  Deletes a ValueListItem object, removing it from its parent value list.

• radar.deleteRadarValueListsValueList

  Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.

• radar.getRadarEarlyFraudWarnings

  Returns a list of early fraud warnings.

• radar.getRadarEarlyFraudWarningsEarlyFraudWarning

  Retrieves the details of an early fraud warning that has previously been created.

  Please refer to the early fraud warning object reference for more details.

• radar.getRadarValueListItems

  Returns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

• radar.getRadarValueListItemsItem

  Retrieves a ValueListItem object.

• radar.getRadarValueLists

  Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

• radar.getRadarValueListsValueList

  Retrieves a ValueList object.

• radar.postRadarValueListItems

  Creates a new ValueListItem object, which is added to the specified parent value list.

• radar.postRadarValueLists

  Creates a new ValueList object, which can then be referenced in rules.

• radar.postRadarValueListsValueList

  Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.

• refunds.getRefunds

  Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.

• refunds.getRefundsRefund

  Retrieves the details of an existing refund.

• refunds.postRefunds

  Create a refund.

• refunds.postRefundsRefund

  Updates the specified refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

  This request only accepts metadata as an argument.

• refunds.postRefundsRefundCancel

  Cancels a refund with a status of requires_action.

  Refunds in other states cannot be canceled, and only refunds for payment methods that require customer action will enter the requires_action state.

• reporting.getReportingReportRuns

  Returns a list of Report Runs, with the most recent appearing first.

• reporting.getReportingReportRunsReportRun

  Retrieves the details of an existing Report Run.

• reporting.getReportingReportTypes

  Returns a full list of Report Types.

• reporting.getReportingReportTypesReportType

  Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)

• reporting.postReportingReportRuns

  Creates a new object and begin running the report. (Certain report types require a live-mode API key.)

• reviews.getReviews

  Returns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

• reviews.getReviewsReview

  Retrieves a Review object.

• reviews.postReviewsReviewApprove

  Approves a Review object, closing it and removing it from the list of reviews.

• setupAttempts.getSetupAttempts

  Returns a list of SetupAttempts associated with a provided SetupIntent.

• setupIntents.getSetupIntents

  Returns a list of SetupIntents.

• setupIntents.getSetupIntentsIntent

  Retrieves the details of a SetupIntent that has previously been created.

  Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string.

  When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the SetupIntent object reference for more details.

• setupIntents.postSetupIntents

  Creates a SetupIntent object.

  After the SetupIntent is created, attach a payment method and confirm to collect any required permissions to charge the payment method later.

• setupIntents.postSetupIntentsIntent

  Updates a SetupIntent object.

• setupIntents.postSetupIntentsIntentCancel

  A SetupIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

  Once canceled, setup is abandoned and any operations on the SetupIntent will fail with an error.

• setupIntents.postSetupIntentsIntentConfirm

  Confirm that your customer intends to set up the current or provided payment method. For example, you would confirm a SetupIntent when a customer hits the “Save” button on a payment method management page on your website.

  If the selected payment method does not require any additional steps from the customer, the SetupIntent will transition to the succeeded status.

  Otherwise, it will transition to the requires_action status and suggest additional actions via next_action. If setup fails, the SetupIntent will transition to the requires_payment_method status.

• setupIntents.postSetupIntentsIntentVerifyMicrodeposits

  Verifies microdeposits on a SetupIntent object.

• shippingRates.getShippingRates

  Returns a list of your shipping rates.

• shippingRates.getShippingRatesShippingRateToken

  Returns the shipping rate object with the given ID.

• shippingRates.postShippingRates

  Creates a new shipping rate object.

• shippingRates.postShippingRatesShippingRateToken

  Updates an existing shipping rate object.

• sigma.getSigmaScheduledQueryRuns

  Returns a list of scheduled query runs.

• sigma.getSigmaScheduledQueryRunsScheduledQueryRun

  Retrieves the details of an scheduled query run.

• sources.getSourcesSource

  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.

• sources.getSourcesSourceMandateNotificationsMandateNotification

  Retrieves a new Source MandateNotification.

• sources.getSourcesSourceSourceTransactions

  List source transactions for a given source.

• sources.getSourcesSourceSourceTransactionsSourceTransaction

  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.

• sources.postSources

  Creates a new source object.

• sources.postSourcesSource

  Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

  This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our payment method guides for more detail.

• sources.postSourcesSourceVerify

  Verify a given source.

• subscriptionItems.deleteSubscriptionItemsItem

  Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

• subscriptionItems.getSubscriptionItems

  Returns a list of your subscription items for a given subscription.

• subscriptionItems.getSubscriptionItemsItem

  Retrieves the subscription item with the given ID.

• subscriptionItems.getSubscriptionItemsSubscriptionItemUsageRecordSummaries

  For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).

  The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn’t ended yet. Since new usage records can still be added, the returned summary information for the subscription item’s ID should be seen as unstable until the subscription billing period ends.

• subscriptionItems.postSubscriptionItems

  Adds a new item to an existing subscription. No existing items will be changed or replaced.

• subscriptionItems.postSubscriptionItemsItem

  Updates the plan or quantity of an item on a current subscription.

• subscriptionItems.postSubscriptionItemsSubscriptionItemUsageRecords

  Creates a usage record for a specified subscription item and date, and fills it with a quantity.

  Usage records provide quantity information that Stripe uses to track how much a customer is using your service. With usage information and the pricing model set up by the metered billing plan, Stripe helps you send accurate invoices to your customers.

  The default calculation for usage is to add up all the quantity values of the usage records within a billing period. You can change this default behavior with the billing plan’s aggregate_usage parameter. When there is more than one usage record with the same timestamp, Stripe adds the quantity values together. In most cases, this is the desired resolution, however, you can change this behavior with the action parameter.

  The default pricing model for metered billing is per-unit pricing. For finer granularity, you can configure metered billing to have a tiered pricing model.

• subscriptions.deleteSubscriptionsSubscriptionExposedId

  Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.

  Note, however, that any pending invoice items that you’ve created will still be charged for at the end of the period, unless manually deleted. If you’ve set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.

  By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.

• subscriptions.deleteSubscriptionsSubscriptionExposedIdDiscount

  Removes the currently applied discount on a subscription.

• subscriptions.getSubscriptions

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

• subscriptions.getSubscriptionsSearch

  Search for subscriptions you’ve previously created using Stripe’s Search Query Language. 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.

• subscriptions.getSubscriptionsSubscriptionExposedId

  Retrieves the subscription with the given ID.

• subscriptions.postSubscriptions

  Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.

  When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request. The payment_behavior parameter determines the exact behavior of the initial payment.

  To start subscriptions where the first invoice always begins in a draft status, use subscription schedules instead. Schedules provide the flexibility to model more complex billing configurations that change over time.

• subscriptions.postSubscriptionsSubscriptionExposedId

  Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint.

• subscriptions.postSubscriptionsSubscriptionResume

  Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date.

• subscriptionSchedules.getSubscriptionSchedules

  Retrieves the list of your subscription schedules.

• subscriptionSchedules.getSubscriptionSchedulesSchedule

  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.

• subscriptionSchedules.postSubscriptionSchedules

  Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.

• subscriptionSchedules.postSubscriptionSchedulesSchedule

  Updates an existing subscription schedule.

• subscriptionSchedules.postSubscriptionSchedulesScheduleCancel

  Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.

• subscriptionSchedules.postSubscriptionSchedulesScheduleRelease

  Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription’s ID to the released_subscription property.

• taxCodes.getTaxCodes

  A list of all tax codes available to add to Products in order to allow specific tax calculations.

• taxCodes.getTaxCodesId

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

• taxRates.getTaxRates

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

• taxRates.getTaxRatesTaxRate

  Retrieves a tax rate with the given ID

• taxRates.postTaxRates

  Creates a new tax rate.

• taxRates.postTaxRatesTaxRate

  Updates an existing tax rate.

• terminal.deleteTerminalConfigurationsConfiguration

  Deletes a Configuration object.

• terminal.deleteTerminalLocationsLocation

  Deletes a Location object.

• terminal.deleteTerminalReadersReader

  Deletes a Reader object.

• terminal.getTerminalConfigurations

  Returns a list of Configuration objects.

• terminal.getTerminalConfigurationsConfiguration

  Retrieves a Configuration object.

• terminal.getTerminalLocations

  Returns a list of Location objects.

• terminal.getTerminalLocationsLocation

  Retrieves a Location object.

• terminal.getTerminalReaders

  Returns a list of Reader objects.

• terminal.getTerminalReadersReader

  Retrieves a Reader object.

• terminal.postTerminalConfigurations

  Creates a new Configuration object.

• terminal.postTerminalConfigurationsConfiguration

  Updates a new Configuration object.

• terminal.postTerminalConnectionTokens

  To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.

• terminal.postTerminalLocations

  Creates a new Location object. For further details, including which address fields are required in each country, see the Manage locations guide.

• terminal.postTerminalLocationsLocation

  Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

• terminal.postTerminalReaders

  Creates a new Reader object.

• terminal.postTerminalReadersReader

  Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

• terminal.postTerminalReadersReaderCancelAction

  Cancels the current reader action.

• terminal.postTerminalReadersReaderProcessPaymentIntent

  Initiates a payment flow on a Reader.

• terminal.postTerminalReadersReaderProcessSetupIntent

  Initiates a setup intent flow on a Reader.

• terminal.postTerminalReadersReaderRefundPayment

  Initiates a refund on a Reader

• terminal.postTerminalReadersReaderSetReaderDisplay

  Sets reader display to show cart details.

• testHelpers.deleteTestHelpersTestClocksTestClock

  Deletes a test clock.

• testHelpers.getTestHelpersTestClocks

  Returns a list of your test clocks.

• testHelpers.getTestHelpersTestClocksTestClock

  Retrieves a test clock.

• testHelpers.postTestHelpersCustomersCustomerFundCashBalance

  Create an incoming testmode bank transfer

• testHelpers.postTestHelpersIssuingCardsCardShippingDeliver

  Updates the shipping status of the specified Issuing Card object to delivered.

• testHelpers.postTestHelpersIssuingCardsCardShippingFail

  Updates the shipping status of the specified Issuing Card object to failure.

• testHelpers.postTestHelpersIssuingCardsCardShippingReturn

  Updates the shipping status of the specified Issuing Card object to returned.

• testHelpers.postTestHelpersIssuingCardsCardShippingShip

  Updates the shipping status of the specified Issuing Card object to shipped.

• testHelpers.postTestHelpersRefundsRefundExpire

  Expire a refund with a status of requires_action.

• testHelpers.postTestHelpersTerminalReadersReaderPresentPaymentMethod

  Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction.

• testHelpers.postTestHelpersTestClocks

  Creates a new test clock that can be attached to new customers and quotes.

• testHelpers.postTestHelpersTestClocksTestClockAdvance

  Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.

• testHelpers.postTestHelpersTreasuryInboundTransfersIdFail

  Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.

• testHelpers.postTestHelpersTreasuryInboundTransfersIdReturn

  Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.

• testHelpers.postTestHelpersTreasuryInboundTransfersIdSucceed

  Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.

• testHelpers.postTestHelpersTreasuryOutboundPaymentsIdFail

  Transitions a test mode created OutboundPayment to the failed status. The OutboundPayment must already be in the processing state.

• testHelpers.postTestHelpersTreasuryOutboundPaymentsIdPost

  Transitions a test mode created OutboundPayment to the posted status. The OutboundPayment must already be in the processing state.

• testHelpers.postTestHelpersTreasuryOutboundPaymentsIdReturn

  Transitions a test mode created OutboundPayment to the returned status. The OutboundPayment must already be in the processing state.

• testHelpers.postTestHelpersTreasuryOutboundTransfersOutboundTransferFail

  Transitions a test mode created OutboundTransfer to the failed status. The OutboundTransfer must already be in the processing state.

• testHelpers.postTestHelpersTreasuryOutboundTransfersOutboundTransferPost

  Transitions a test mode created OutboundTransfer to the posted status. The OutboundTransfer must already be in the processing state.

• testHelpers.postTestHelpersTreasuryOutboundTransfersOutboundTransferReturn

  Transitions a test mode created OutboundTransfer to the returned status. The OutboundTransfer must already be in the processing state.

• testHelpers.postTestHelpersTreasuryReceivedCredits

  Use this endpoint to simulate a test mode ReceivedCredit initiated by a third party. In live mode, you can’t directly create ReceivedCredits initiated by third parties.

• testHelpers.postTestHelpersTreasuryReceivedDebits

  Use this endpoint to simulate a test mode ReceivedDebit initiated by a third party. In live mode, you can’t directly create ReceivedDebits initiated by third parties.

• tokens.getTokensToken

  Retrieves the token with the given ID.

• tokens.postTokens

  Creates a single-use token that represents a bank account’s details. This token can be used with any API method in place of a bank account dictionary. This token can be used only once, by attaching it to a Custom account.

• topups.getTopups

  Returns a list of top-ups.

• topups.getTopupsTopup

  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.

• topups.postTopups

  Top up the balance of an account

• topups.postTopupsTopup

  Updates the metadata of a top-up. Other top-up details are not editable by design.

• topups.postTopupsTopupCancel

  Cancels a top-up. Only pending top-ups can be canceled.

• transfers.getTransfers

  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.

• transfers.getTransfersIdReversals

  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 limit and starting_after parameters to page through additional reversals.

• transfers.getTransfersTransfer

  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.

• transfers.getTransfersTransferReversalsId

  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.

• transfers.postTransfers

  To send funds from your Stripe account to a connected account, you create a new transfer object. Your Stripe balance must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error.

• transfers.postTransfersIdReversals

  When you create a new reversal, you must specify a transfer to create it on.

  When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until the entire transfer has been reversed.

  Once entirely reversed, a transfer can’t be reversed again. This method will return an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer.

• transfers.postTransfersTransfer

  Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

  This request accepts only metadata as an argument.

• transfers.postTransfersTransferReversalsId

  Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

  This request only accepts metadata and description as arguments.

• treasury.getTreasuryCreditReversals

  Returns a list of CreditReversals.

• treasury.getTreasuryCreditReversalsCreditReversal

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

• treasury.getTreasuryDebitReversals

  Returns a list of DebitReversals.

• treasury.getTreasuryDebitReversalsDebitReversal

  Retrieves a DebitReversal object.

• treasury.getTreasuryFinancialAccounts

  Returns a list of FinancialAccounts.

• treasury.getTreasuryFinancialAccountsFinancialAccount

  Retrieves the details of a FinancialAccount.

• treasury.getTreasuryFinancialAccountsFinancialAccountFeatures

  Retrieves Features information associated with the FinancialAccount.

• treasury.getTreasuryInboundTransfers

  Returns a list of InboundTransfers sent from the specified FinancialAccount.

• treasury.getTreasuryInboundTransfersId

  Retrieves the details of an existing InboundTransfer.

• treasury.getTreasuryOutboundPayments

  Returns a list of OutboundPayments sent from the specified FinancialAccount.

• treasury.getTreasuryOutboundPaymentsId

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

• treasury.getTreasuryOutboundTransfers

  Returns a list of OutboundTransfers sent from the specified FinancialAccount.

• treasury.getTreasuryOutboundTransfersOutboundTransfer

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

• treasury.getTreasuryReceivedCredits

  Returns a list of ReceivedCredits.

• treasury.getTreasuryReceivedCreditsId

  Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.

• treasury.getTreasuryReceivedDebits

  Returns a list of ReceivedDebits.

• treasury.getTreasuryReceivedDebitsId

  Retrieves the details of an existing ReceivedDebit by passing the unique ReceivedDebit ID from the ReceivedDebit list

• treasury.getTreasuryTransactionEntries

  Retrieves a list of TransactionEntry objects.

• treasury.getTreasuryTransactionEntriesId

  Retrieves a TransactionEntry object.

• treasury.getTreasuryTransactions

  Retrieves a list of Transaction objects.

• treasury.getTreasuryTransactionsId

  Retrieves the details of an existing Transaction.

• treasury.postTreasuryCreditReversals

  Reverses a ReceivedCredit and creates a CreditReversal object.

• treasury.postTreasuryDebitReversals

  Reverses a ReceivedDebit and creates a DebitReversal object.

• treasury.postTreasuryFinancialAccounts

  Creates a new FinancialAccount. For now, each connected account can only have one FinancialAccount.

• treasury.postTreasuryFinancialAccountsFinancialAccount

  Updates the details of a FinancialAccount.

• treasury.postTreasuryFinancialAccountsFinancialAccountFeatures

  Updates the Features associated with a FinancialAccount.

• treasury.postTreasuryInboundTransfers

  Creates an InboundTransfer.

• treasury.postTreasuryInboundTransfersInboundTransferCancel

  Cancels an InboundTransfer.

• treasury.postTreasuryOutboundPayments

  Creates an OutboundPayment.

• treasury.postTreasuryOutboundPaymentsIdCancel

  Cancel an OutboundPayment.

• treasury.postTreasuryOutboundTransfers

  Creates an OutboundTransfer.

• treasury.postTreasuryOutboundTransfersOutboundTransferCancel

  An OutboundTransfer can be canceled if the funds have not yet been paid out.

• webhookEndpoints.deleteWebhookEndpointsWebhookEndpoint

  You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

• webhookEndpoints.getWebhookEndpoints

  Returns a list of your webhook endpoints.

• webhookEndpoints.getWebhookEndpointsWebhookEndpoint

  Retrieves the webhook endpoint with the given ID.

• webhookEndpoints.postWebhookEndpoints

  A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified url about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified url only about events from your account is created. You can also create webhook endpoints in the webhooks settings section of the Dashboard.

• webhookEndpoints.postWebhookEndpointsWebhookEndpoint

  Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools