Skip to main content

Stripe

Manage your Stripe account.

Stripe Logo

Authentication

This connector uses OAuth 2.0 authentication.

info

Set up your connection in the Abstra Console before using it in your workflows.

How to use

Using the Smart Chat

Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".

Using the Web Editor

from abstra.connectors import run_connection_action

result = run_connection_action(
connection_name="your_connection_name",
action_name="your_action_name",
params={
"param1": "value1",
"param2": "value2"
})

Available Actions

This connector provides 570 actions:

ActionPurposeParameters
get_v1_accountpRetrieves the details of an account./pexpand (array)
post_v1_account_linkspCreates 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./pNo parameters
post_v1_account_sessionspCreates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access./pNo parameters
get_v1_accountspReturns 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./pcreated (undefined)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
post_v1_accountspWith 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 pIf 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 anyNo parameters
delete_v1_accounts_by_accountpWith a href='/connect'Connect/a, you can delete accounts you manage./p pTest-mode accounts can be deleted at any time./p pLive-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 pIf you want to delete your own account, use the a href='https://dashboard.stripe.com/settaccount (string)
get_v1_accounts_by_accountpRetrieves the details of an account./paccount (string)
expand (array)
post_v1_accounts_by_accountpUpdates a a href='/connect/accounts'connected account/a by setting the values of the parameters passed. Any parameters not provided are left unchanged./p pFor accounts where a href='/api/accounts/object account_object-controller-requirement_collection'controller.requirement_collection/a is codeapplication/code, which includes Custom accounts, you can update any information on the account./p pFor accounts where a href='/api/accounts/object account_object-controller-requirement_collection'contraccount (string)
post_v1_accounts_by_account_bank_accountspCreate an external account for a given account./paccount (string)
delete_v1_accounts_by_account_bank_accounts_by_idpDelete a specified external account for a given account./paccount (string)
id (string)
get_v1_accounts_by_account_bank_accounts_by_idpRetrieve a specified external account for a given account./paccount (string)
id (string)
expand (array)
post_v1_accounts_by_account_bank_accounts_by_idpUpdates 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 pYou can only update bank accounts when a href='/api/accounts/object account_object-controller-requirement_collection'account.controller.requirement_collection/a is codeapplication/code, which includes a href='/connect/custom-accounts'Custom accounts/a./p pYou can re-enaccount (string)
id (string)
get_v1_accounts_by_account_capabilitiespReturns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first./paccount (string)
expand (array)
get_v1_accounts_by_account_capabilities_by_capabilitypRetrieves information about the specified Account Capability./paccount (string)
capability (string)
expand (array)
post_v1_accounts_by_account_capabilities_by_capabilitypUpdates an existing Account Capability. Request or remove a capability by updating its coderequested/code parameter./paccount (string)
capability (string)
get_v1_accounts_by_account_external_accountspList external accounts for an account./paccount (string)
ending_before (string)
expand (array)
limit (integer)
object (string)
starting_after (string)
post_v1_accounts_by_account_external_accountspCreate an external account for a given account./paccount (string)
delete_v1_accounts_by_account_external_accounts_by_idpDelete a specified external account for a given account./paccount (string)
id (string)
get_v1_accounts_by_account_external_accounts_by_idpRetrieve a specified external account for a given account./paccount (string)
id (string)
expand (array)
post_v1_accounts_by_account_external_accounts_by_idpUpdates 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 pYou can only update bank accounts when a href='/api/accounts/object account_object-controller-requirement_collection'account.controller.requirement_collection/a is codeapplication/code, which includes a href='/connect/custom-accounts'Custom accounts/a./p pYou can re-enaccount (string)
id (string)
post_v1_accounts_by_account_login_linkspCreates a login link for a connected account to access the Express Dashboard./p pstrongYou 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./paccount (string)
get_v1_accounts_by_account_peoplepReturns 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./paccount (string)
ending_before (string)
expand (array)
limit (integer)
relationship: {
. authorizer (boolean)
. director (boolean)
. executive (boolean)
. legal_guardian (boolean)
. owner (boolean)
. representative (boolean)
} (object)
starting_after (string)
post_v1_accounts_by_account_peoplepCreates a new person./paccount (string)
delete_v1_accounts_by_account_people_by_personpDeletes 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 codeaccount_opener/code. If your integration is using the codeexecutive/code parameter, you cannot delete the only verified codeexecutive/code on file./paccount (string)
person (string)
get_v1_accounts_by_account_people_by_personpRetrieves an existing person./paccount (string)
person (string)
expand (array)
post_v1_accounts_by_account_people_by_personpUpdates an existing person./paccount (string)
person (string)
get_v1_accounts_by_account_personspReturns 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./paccount (string)
ending_before (string)
expand (array)
limit (integer)
relationship: {
. authorizer (boolean)
. director (boolean)
. executive (boolean)
. legal_guardian (boolean)
. owner (boolean)
. representative (boolean)
} (object)
starting_after (string)
post_v1_accounts_by_account_personspCreates a new person./paccount (string)
delete_v1_accounts_by_account_persons_by_personpDeletes 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 codeaccount_opener/code. If your integration is using the codeexecutive/code parameter, you cannot delete the only verified codeexecutive/code on file./paccount (string)
person (string)
get_v1_accounts_by_account_persons_by_personpRetrieves an existing person./paccount (string)
person (string)
expand (array)
post_v1_accounts_by_account_persons_by_personpUpdates an existing person./paccount (string)
person (string)
post_v1_accounts_by_account_rejectpWith a href='/connect'Connect/a, you can reject accounts that you have flagged as suspicious./p pOnly 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./paccount (string)
get_v1_apple_pay_domainspList apple pay domains./pdomain_name (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
post_v1_apple_pay_domainspCreate an apple pay domain./pNo parameters
delete_v1_apple_pay_domains_by_domainpDelete an apple pay domain./pdomain (string)
get_v1_apple_pay_domains_by_domainpRetrieve an apple pay domain./pdomain (string)
expand (array)
get_v1_application_feespReturns a list of application fees you’ve previously collected. The application fees are returned in sorted order, with the most recent fees appearing first./pcharge (string)
created (undefined)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
get_v1_application_fees_by_fee_refunds_by_idpBy 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./pfee (string)
id (string)
expand (array)
post_v1_application_fees_by_fee_refunds_by_idpUpdates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged./p pThis request only accepts metadata as an argument./pfee (string)
id (string)
get_v1_application_fees_by_idpRetrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee./pid (string)
expand (array)
post_v1_application_fees_by_id_refundNo description availableid (string)
get_v1_application_fees_by_id_refundspYou 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 codelimit/code and codestarting_after/code parameters to page through additional refunds./pid (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
post_v1_application_fees_by_id_refundspRefunds 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 pYou can optionally refund only part of an application fee. You can do so multiple times, until the entire fee has been refunded./p pOnce 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 moneyid (string)
get_v1_apps_secretspList all secrets stored on the given scope./pending_before (string)
expand (array)
limit (integer)
scope: {
. type (string)
. user (string)
} (object) required
starting_after (string)
post_v1_apps_secretspCreate or replace a secret in the secret store./pNo parameters
post_v1_apps_secrets_deletepDeletes a secret from the secret store by name and scope./pNo parameters
get_v1_apps_secrets_findpFinds a secret in the secret store by name and scope./pexpand (array)
name (string) required
scope: {
. type (string)
. user (string)
} (object) required
get_v1_balancepRetrieves 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./pexpand (array)
get_v1_balance_historypReturns 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./p pNote that this endpoint was previously called “Balance history” and used the path code/v1/balance/history/code./pcreated (undefined)
currency (string)
ending_before (string)
expand (array)
limit (integer)
payout (string)
source (string)
starting_after (string)
type (string)
get_v1_balance_history_by_idpRetrieves the balance transaction with the given ID./p pNote that this endpoint previously used the path code/v1/balance/history/:id/code./pid (string)
expand (array)
get_v1_balance_transactionspReturns 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./p pNote that this endpoint was previously called “Balance history” and used the path code/v1/balance/history/code./pcreated (undefined)
currency (string)
ending_before (string)
expand (array)
limit (integer)
payout (string)
source (string)
starting_after (string)
type (string)
get_v1_balance_transactions_by_idpRetrieves the balance transaction with the given ID./p pNote that this endpoint previously used the path code/v1/balance/history/:id/code./pid (string)
expand (array)
get_v1_billing_alertspLists billing active and inactive alerts/palert_type (string)
ending_before (string)
expand (array)
limit (integer)
meter (string)
starting_after (string)
post_v1_billing_alertspCreates a billing alert/pNo parameters
get_v1_billing_alerts_by_idpRetrieves a billing alert given an ID/pid (string)
expand (array)
post_v1_billing_alerts_by_id_activatepReactivates this alert, allowing it to trigger again./pid (string)
post_v1_billing_alerts_by_id_archivepArchives this alert, removing it from the list view and APIs. This is non-reversible./pid (string)
post_v1_billing_alerts_by_id_deactivatepDeactivates this alert, preventing it from triggering./pid (string)
get_v1_billing_credit_balance_summarypRetrieves the credit balance summary for a customer./pcustomer (string) required
expand (array)
filter: {
. applicability_scope (object)
. credit_grant (string)
. type (string)
} (object) required
get_v1_billing_credit_balance_transactionspRetrieve a list of credit balance transactions./pcredit_grant (string)
customer (string) required
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
get_v1_billing_credit_balance_transactions_by_idpRetrieves a credit balance transaction./pid (string)
expand (array)
get_v1_billing_credit_grantspRetrieve a list of credit grants./pcustomer (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
post_v1_billing_credit_grantspCreates a credit grant./pNo parameters
get_v1_billing_credit_grants_by_idpRetrieves a credit grant./pid (string)
expand (array)
post_v1_billing_credit_grants_by_idpUpdates a credit grant./pid (string)
post_v1_billing_credit_grants_by_id_expirepExpires a credit grant./pid (string)
post_v1_billing_credit_grants_by_id_voidpVoids a credit grant./pid (string)
post_v1_billing_meter_event_adjustmentspCreates a billing meter event adjustment./pNo parameters
post_v1_billing_meter_eventspCreates a billing meter event./pNo parameters
get_v1_billing_meterspRetrieve a list of billing meters./pending_before (string)
expand (array)
limit (integer)
starting_after (string)
status (string)
post_v1_billing_meterspCreates a billing meter./pNo parameters
get_v1_billing_meters_by_idpRetrieves a billing meter given an ID./pid (string)
expand (array)
post_v1_billing_meters_by_idpUpdates a billing meter./pid (string)
post_v1_billing_meters_by_id_deactivatepWhen a meter is deactivated, no more meter events will be accepted for this meter. You can’t attach a deactivated meter to a price./pid (string)
get_v1_billing_meters_by_id_event_summariespRetrieve a list of billing meter event summaries./pid (string)
customer (string) required
end_time (integer) required
ending_before (string)
expand (array)
limit (integer)
start_time (integer) required
starting_after (string)
value_grouping_window (string)
post_v1_billing_meters_by_id_reactivatepWhen a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price./pid (string)
get_v1_billing_portal_configurationspReturns a list of configurations that describe the functionality of the customer portal./pactive (boolean)
ending_before (string)
expand (array)
is_default (boolean)
limit (integer)
starting_after (string)
post_v1_billing_portal_configurationspCreates a configuration that describes the functionality and behavior of a PortalSession/pNo parameters
get_v1_billing_portal_configurations_by_configurationpRetrieves a configuration that describes the functionality of the customer portal./pconfiguration (string)
expand (array)
post_v1_billing_portal_configurations_by_configurationpUpdates a configuration that describes the functionality of the customer portal./pconfiguration (string)
post_v1_billing_portal_sessionspCreates a session of the customer portal./pNo parameters
get_v1_chargespReturns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first./pcreated (undefined)
customer (string)
ending_before (string)
expand (array)
limit (integer)
payment_intent (string)
starting_after (string)
transfer_group (string)
post_v1_chargespThis 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 codeCharge/code object used to request payment./pNo parameters
get_v1_charges_searchpSearch 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./pexpand (array)
limit (integer)
page (string)
query (string) required
get_v1_charges_by_chargepRetrieves 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./pcharge (string)
expand (array)
post_v1_charges_by_chargepUpdates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged./pcharge (string)
post_v1_charges_by_charge_capturepCapture the payment of an existing, uncaptured charge that was created with the codecapture/code option set to false./p pUncaptured 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 pDon’t use this method to capture a PaymentIntent-initiated charge. Use a href='/docs/api/payment_intents/capture'Capture a PaymentIntent/a./pcharge (string)
get_v1_charges_by_charge_disputepRetrieve a dispute for a specified charge./pcharge (string)
expand (array)
post_v1_charges_by_charge_disputeNo description availablecharge (string)
post_v1_charges_by_charge_dispute_closeNo description availablecharge (string)
post_v1_charges_by_charge_refundpWhen you create a new refund, you must specify either a Charge or a PaymentIntent object./p pThis 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 pYou can optionally refund only part of a charge. You can repeat this until the entire charge is refunded./p pAfter 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 whcharge (string)
get_v1_charges_by_charge_refundspYou 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 codelimit/code and codestarting_after/code parameters to page through additional refunds./pcharge (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
post_v1_charges_by_charge_refundspWhen you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it./p pCreating 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 pYou can optionally refund only part of a charge. You can do so multiple times, until the entire charge has been refunded./p pOnce entirely refunded, a charge can’t be refunded again. This method will raise acharge (string)
get_v1_charges_by_charge_refunds_by_refundpRetrieves the details of an existing refund./pcharge (string)
refund (string)
expand (array)
post_v1_charges_by_charge_refunds_by_refundpUpdate a specified refund./pcharge (string)
refund (string)
get_v1_checkout_sessionspReturns a list of Checkout Sessions./pcreated (undefined)
customer (string)
customer_details: {
. email (string)
} (object)
ending_before (string)
expand (array)
limit (integer)
payment_intent (string)
payment_link (string)
starting_after (string)
status (string)
subscription (string)
post_v1_checkout_sessionspCreates a Checkout Session object./pNo parameters
get_v1_checkout_sessions_by_sessionpRetrieves a Checkout Session object./psession (string)
expand (array)
post_v1_checkout_sessions_by_sessionpUpdates a Checkout Session object./p pRelated guide: a href='/payments/checkout/dynamic-updates'Dynamically update Checkout/a/psession (string)
post_v1_checkout_sessions_by_session_expirepA Checkout Session can be expired when it is in one of these statuses: codeopen/code /p pAfter 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./psession (string)
get_v1_checkout_sessions_by_session_line_itemspWhen retrieving a Checkout Session, there is an includable strongline_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./psession (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
get_v1_climate_orderspLists all Climate order objects. The orders are returned sorted by creation date, with the most recently created orders appearing first./pending_before (string)
expand (array)
limit (integer)
starting_after (string)
post_v1_climate_orderspCreates 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./pNo parameters
get_v1_climate_orders_by_orderpRetrieves the details of a Climate order object with the given ID./porder (string)
expand (array)
post_v1_climate_orders_by_orderpUpdates the specified order by setting the values of the parameters passed./porder (string)
post_v1_climate_orders_by_order_cancelpCancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the reservation codeamount_subtotal/code, but not the codeamount_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 codeamount_total/code./porder (string)
get_v1_climate_productspLists all available Climate product objects./pending_before (string)
expand (array)
limit (integer)
starting_after (string)
get_v1_climate_products_by_productpRetrieves the details of a Climate product with the given ID./pproduct (string)
expand (array)
get_v1_climate_supplierspLists all available Climate supplier objects./pending_before (string)
expand (array)
limit (integer)
starting_after (string)
get_v1_climate_suppliers_by_supplierpRetrieves a Climate supplier object./psupplier (string)
expand (array)
get_v1_confirmation_tokens_by_confirmation_tokenpRetrieves an existing ConfirmationToken object/pconfirmation_token (string)
expand (array)
get_v1_country_specspLists all Country Spec objects available in the API./pending_before (string)
expand (array)
limit (integer)
starting_after (string)
get_v1_country_specs_by_countrypReturns a Country Spec for a given Country code./pcountry (string)
expand (array)
get_v1_couponspReturns a list of your coupons./pcreated (undefined)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
post_v1_couponspYou 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 pA coupon has either a codepercent_off/code or an codeamount_off/code and codecurrency/code. If you set an codeamount_off/code, that amount will be subtracted from any invoice’s subtotal. For example, an invoice with a subtotal of currency100/currency will have a final totaNo parameters
delete_v1_coupons_by_couponpYou 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./pcoupon (string)
get_v1_coupons_by_couponpRetrieves the coupon with the given ID./pcoupon (string)
expand (array)
post_v1_coupons_by_couponpUpdates the metadata of a coupon. Other coupon details currency, duration, amount_off are, by design, not editable./pcoupon (string)
get_v1_credit_notespReturns a list of credit notes./pcreated (undefined)
customer (string)
ending_before (string)
expand (array)
invoice (string)
limit (integer)
starting_after (string)
post_v1_credit_notespIssue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice’s codeamount_remaining/code and codeamount_due/code, but not below zero. This amount is indicated by the credit note’s codepre_payment_amount/code. The excess amount is indicated by codepost_payment_amount/code, and it can result in any combination of the following:/p ul liRefunds: create a new refund using coderefund_amount/code or link existing refunds using coderefunds/code./li liCusNo parameters
get_v1_credit_notes_previewpGet a preview of a credit note without creating it./pamount (integer)
credit_amount (integer)
effective_at (integer)
email_type (string)
expand (array)
invoice (string) required
lines (array)
memo (string)
metadata (object)
out_of_band_amount (integer)
reason (string)
refund_amount (integer)
refunds (array)
shipping_cost: {
. shipping_rate (string)
} (object)
get_v1_credit_notes_preview_linespWhen retrieving a credit note preview, you’ll get a stronglines/strong property containing the first handful of those items. This URL you can retrieve the full paginated list of line items./pamount (integer)
credit_amount (integer)
effective_at (integer)
email_type (string)
ending_before (string)
expand (array)
invoice (string) required
limit (integer)
lines (array)
memo (string)
metadata (object)
out_of_band_amount (integer)
reason (string)
refund_amount (integer)
refunds (array)
shipping_cost: {
. shipping_rate (string)
} (object)
starting_after (string)
get_v1_credit_notes_by_credit_note_linespWhen retrieving a credit note, you’ll get a stronglines/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./pcredit_note (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
get_v1_credit_notes_by_idpRetrieves the credit note object with the given identifier./pid (string)
expand (array)
post_v1_credit_notes_by_idpUpdates an existing credit note./pid (string)
post_v1_credit_notes_by_id_voidpMarks a credit note as void. Learn more about a href='/docs/billing/invoices/credit-notes voiding'voiding credit notes/a./pid (string)
post_v1_customer_sessionspCreates 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./pNo parameters
get_v1_customerspReturns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first./pcreated (undefined)
email (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
test_clock (string)
post_v1_customerspCreates a new customer object./pNo parameters
get_v1_customers_searchpSearch 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./pexpand (array)
limit (integer)
page (string)
query (string) required
delete_v1_customers_by_customerpPermanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer./pcustomer (string)
get_v1_customers_by_customerpRetrieves a Customer object./pcustomer (string)
expand (array)
post_v1_customers_by_customerpUpdates 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 strongsource/strong 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 strongsource/strong parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the codepascustomer (string)
get_v1_customers_by_customer_balance_transactionspReturns a list of transactions that updated the customer’s a href='/docs/billing/customer/balance'balances/a./pcustomer (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
post_v1_customers_by_customer_balance_transactionspCreates an immutable transaction that updates the customer’s credit a href='/docs/billing/customer/balance'balance/a./pcustomer (string)
get_v1_customers_by_customer_balance_transactions_by_transactionpRetrieves a specific customer balance transaction that updated the customer’s a href='/docs/billing/customer/balance'balances/a./pcustomer (string)
transaction (string)
expand (array)
post_v1_customers_by_customer_balance_transactions_by_transactionpMost credit balance transaction fields are immutable, but you may update its codedescription/code and codemetadata/code./pcustomer (string)
transaction (string)
get_v1_customers_by_customer_bank_accountspYou 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 codelimit/code and codestarting_after/code parameters to page through additional bank accounts./pcustomer (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
post_v1_customers_by_customer_bank_accountspWhen you create a new credit card, you must specify a customer or recipient on which to create it./p pIf 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='/docs/api update_customer'update the customer/a to have a new codedefault_source/code./pcustomer (string)
delete_v1_customers_by_customer_bank_accounts_by_idpDelete a specified source for a given customer./pcustomer (string)
id (string)
get_v1_customers_by_customer_bank_accounts_by_idpBy 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./pcustomer (string)
id (string)
expand (array)
post_v1_customers_by_customer_bank_accounts_by_idpUpdate a specified source for a given customer./pcustomer (string)
id (string)
post_v1_customers_by_customer_bank_accounts_by_id_verifypVerify a specified bank account for a given customer./pcustomer (string)
id (string)
get_v1_customers_by_customer_cardspYou can see a list of the cards belonging to a customer. Note that the 10 most recent sources are always available on the codeCustomer/code object. If you need more than those 10, you can use this API method and the codelimit/code and codestarting_after/code parameters to page through additional cards./pcustomer (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
post_v1_customers_by_customer_cardspWhen you create a new credit card, you must specify a customer or recipient on which to create it./p pIf 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='/docs/api update_customer'update the customer/a to have a new codedefault_source/code./pcustomer (string)
delete_v1_customers_by_customer_cards_by_idpDelete a specified source for a given customer./pcustomer (string)
id (string)
get_v1_customers_by_customer_cards_by_idpYou 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./pcustomer (string)
id (string)
expand (array)
post_v1_customers_by_customer_cards_by_idpUpdate a specified source for a given customer./pcustomer (string)
id (string)
get_v1_customers_by_customer_cash_balancepRetrieves a customer’s cash balance./pcustomer (string)
expand (array)
post_v1_customers_by_customer_cash_balancepChanges the settings on a customer’s cash balance./pcustomer (string)
get_v1_customers_by_customer_cash_balance_transactionspReturns a list of transactions that modified the customer’s a href='/docs/payments/customer-balance'cash balance/a./pcustomer (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
get_v1_customers_by_customer_cash_balance_transactions_by_transactionpRetrieves a specific cash balance transaction, which updated the customer’s a href='/docs/payments/customer-balance'cash balance/a./pcustomer (string)
transaction (string)
expand (array)
delete_v1_customers_by_customer_discountpRemoves the currently applied discount on a customer./pcustomer (string)
get_v1_customers_by_customer_discountNo description availablecustomer (string)
expand (array)
post_v1_customers_by_customer_funding_instructionspRetrieve 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./pcustomer (string)
get_v1_customers_by_customer_payment_methodspReturns a list of PaymentMethods for a given Customer/pcustomer (string)
allow_redisplay (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
type (string)
get_v1_customers_by_customer_payment_methods_by_payment_methodpRetrieves a PaymentMethod object for a given Customer./pcustomer (string)
payment_method (string)
expand (array)
get_v1_customers_by_customer_sourcespList sources for a specified customer./pcustomer (string)
ending_before (string)
expand (array)
limit (integer)
object (string)
starting_after (string)
post_v1_customers_by_customer_sourcespWhen you create a new credit card, you must specify a customer or recipient on which to create it./p pIf 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='/docs/api update_customer'update the customer/a to have a new codedefault_source/code./pcustomer (string)
delete_v1_customers_by_customer_sources_by_idpDelete a specified source for a given customer./pcustomer (string)
id (string)
get_v1_customers_by_customer_sources_by_idpRetrieve a specified source for a given customer./pcustomer (string)
id (string)
expand (array)
post_v1_customers_by_customer_sources_by_idpUpdate a specified source for a given customer./pcustomer (string)
id (string)
post_v1_customers_by_customer_sources_by_id_verifypVerify a specified bank account for a given customer./pcustomer (string)
id (string)
get_v1_customers_by_customer_subscriptionspYou 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./pcustomer (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
post_v1_customers_by_customer_subscriptionspCreates a new subscription on an existing customer./pcustomer (string)
delete_v1_customers_by_customer_subscriptions_by_subscription_exposed_idpCancels a customer’s subscription. If you set the codeat_period_end/code parameter to codetrue/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 codefalse/code value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription./p pNote, however, that any pending invoice items that you’ve created will still be charged for at the end ofcustomer (string)
subscription_exposed_id (string)
get_v1_customers_by_customer_subscriptions_by_subscription_exposed_idpRetrieves the subscription with the given ID./pcustomer (string)
subscription_exposed_id (string)
expand (array)
post_v1_customers_by_customer_subscriptions_by_subscription_exposed_idpUpdates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the a href=' upcoming_invoice'upcoming invoice/a endpoint./pcustomer (string)
subscription_exposed_id (string)
delete_v1_customers_by_customer_subscriptions_by_subscription_exposed_id_discountpRemoves the currently applied discount on a customer./pcustomer (string)
subscription_exposed_id (string)
get_v1_customers_by_customer_subscriptions_by_subscription_exposed_id_discountNo description availablecustomer (string)
subscription_exposed_id (string)
expand (array)
get_v1_customers_by_customer_tax_idspReturns a list of tax IDs for a customer./pcustomer (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
post_v1_customers_by_customer_tax_idspCreates a new codetax_id/code object for a customer./pcustomer (string)
delete_v1_customers_by_customer_tax_ids_by_idpDeletes an existing codetax_id/code object./pcustomer (string)
id (string)
get_v1_customers_by_customer_tax_ids_by_idpRetrieves the codetax_id/code object with the given identifier./pcustomer (string)
id (string)
expand (array)
get_v1_disputespReturns a list of your disputes./pcharge (string)
created (undefined)
ending_before (string)
expand (array)
limit (integer)
payment_intent (string)
starting_after (string)
get_v1_disputes_by_disputepRetrieves the dispute with the given ID./pdispute (string)
expand (array)
post_v1_disputes_by_disputepWhen you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your a href='https://dashboard.stripe.com/disputes'dashboard/a, but if you prefer, you can use the API to submit evidence programmatically./p pDepending 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, seedispute (string)
post_v1_disputes_by_dispute_closepClosing 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./p pThe status of the dispute will change from codeneeds_response/code to codelost/code. emClosing a dispute is irreversible/em./pdispute (string)
get_v1_entitlements_active_entitlementspRetrieve a list of active entitlements for a customer/pcustomer (string) required
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
get_v1_entitlements_active_entitlements_by_idpRetrieve an active entitlement/pid (string)
expand (array)
get_v1_entitlements_featurespRetrieve a list of features/parchived (boolean)
ending_before (string)
expand (array)
limit (integer)
lookup_key (string)
starting_after (string)
post_v1_entitlements_featurespCreates a feature/pNo parameters
get_v1_entitlements_features_by_idpRetrieves a feature/pid (string)
expand (array)
post_v1_entitlements_features_by_idpUpdate a feature’s metadata or permanently deactivate it./pid (string)
post_v1_ephemeral_keyspCreates a short-lived API key for a given resource./pNo parameters
delete_v1_ephemeral_keys_by_keypInvalidates a short-lived API key for a given resource./pkey (string)
get_v1_eventspList 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 codeapi_version/code attribute not according to your current Stripe API version or codeStripe-Version/code header./pcreated (undefined)
delivery_success (boolean)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
type (string)
types (array)
get_v1_events_by_idpRetrieves 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./pid (string)
expand (array)
get_v1_exchange_ratespReturns 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./pending_before (string)
expand (array)
limit (integer)
starting_after (string)
get_v1_exchange_rates_by_rate_idpRetrieves the exchange rates from the given currency to every supported currency./prate_id (string)
expand (array)
post_v1_external_accounts_by_idpUpdates 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 pYou can only update bank accounts when a href='/api/accounts/object account_object-controller-requirement_collection'account.controller.requirement_collection/a is codeapplication/code, which includes a href='/connect/custom-accounts'Custom accounts/a./p pYou can re-enid (string)
get_v1_file_linkspReturns a list of file links./pcreated (undefined)
ending_before (string)
expand (array)
expired (boolean)
file (string)
limit (integer)
starting_after (string)
post_v1_file_linkspCreates a new file link object./pNo parameters
get_v1_file_links_by_linkpRetrieves the file link with the given ID./plink (string)
expand (array)
post_v1_file_links_by_linkpUpdates an existing file link object. Expired links can no longer be updated./plink (string)
get_v1_filespReturns 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./pcreated (undefined)
ending_before (string)
expand (array)
limit (integer)
purpose (string)
starting_after (string)
post_v1_filespTo upload a file to Stripe, you need to send a request of type codemultipart/form-data/code. Include the file you want to upload in the request, and the parameters for creating a file./p pAll of Stripe’s officially supported Client libraries support sending codemultipart/form-data/code./pNo parameters
get_v1_files_by_filepRetrieves 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./pfile (string)
expand (array)
get_v1_financial_connections_accountspReturns a list of Financial Connections codeAccount/code objects./paccount_holder: {
. account (string)
. customer (string)
} (object)
ending_before (string)
expand (array)
limit (integer)
session (string)
starting_after (string)
get_v1_financial_connections_accounts_by_accountpRetrieves the details of an Financial Connections codeAccount/code./paccount (string)
expand (array)
post_v1_financial_connections_accounts_by_account_disconnectpDisables your access to a Financial Connections codeAccount/code. You will no longer be able to access data associated with the account e.g. balances, transactions./paccount (string)
get_v1_financial_connections_accounts_by_account_ownerspLists all owners for a given codeAccount/code/paccount (string)
ending_before (string)
expand (array)
limit (integer)
ownership (string) required
starting_after (string)
post_v1_financial_connections_accounts_by_account_refreshpRefreshes the data associated with a Financial Connections codeAccount/code./paccount (string)
post_v1_financial_connections_accounts_by_account_subscribepSubscribes to periodic refreshes of data associated with a Financial Connections codeAccount/code./paccount (string)
post_v1_financial_connections_accounts_by_account_unsubscribepUnsubscribes from periodic refreshes of data associated with a Financial Connections codeAccount/code./paccount (string)
post_v1_financial_connections_sessionspTo launch the Financial Connections authorization flow, create a codeSession/code. The session’s codeclient_secret/code can be used to launch the flow using Stripe.js./pNo parameters
get_v1_financial_connections_sessions_by_sessionpRetrieves the details of a Financial Connections codeSession/code/psession (string)
expand (array)
get_v1_financial_connections_transactionspReturns a list of Financial Connections codeTransaction/code objects./paccount (string) required
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
transacted_at (undefined)
transaction_refresh: {
. after (string)
} (object)
get_v1_financial_connections_transactions_by_transactionpRetrieves the details of a Financial Connections codeTransaction/code/ptransaction (string)
expand (array)
get_v1_forwarding_requestspLists all ForwardingRequest objects./pcreated: {
. gt (integer)
. gte (integer)
. lt (integer)
. lte (integer)
} (object)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
post_v1_forwarding_requestspCreates a ForwardingRequest object./pNo parameters
get_v1_forwarding_requests_by_idpRetrieves a ForwardingRequest object./pid (string)
expand (array)
get_v1_identity_verification_reportspList all verification reports./pclient_reference_id (string)
created (undefined)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
type (string)
verification_session (string)
get_v1_identity_verification_reports_by_reportpRetrieves an existing VerificationReport/preport (string)
expand (array)
get_v1_identity_verification_sessionspReturns a list of VerificationSessions/pclient_reference_id (string)
created (undefined)
ending_before (string)
expand (array)
limit (integer)
related_customer (string)
starting_after (string)
status (string)
post_v1_identity_verification_sessionspCreates a VerificationSession object./p pAfter the VerificationSession is created, display a verification modal using the session codeclient_secret/code or send your users to the session’s codeurl/code./p pIf your API key is in test mode, verification checks won’t actually process, though everything else will occur as if in live mode./p pRelated guide: a href='/docs/identity/verify-identity-documents'Verify your users’ identity documents/a/pNo parameters
get_v1_identity_verification_sessions_by_sessionpRetrieves the details of a VerificationSession that was previously created./p pWhen the session status is coderequires_input/code, you can use this method to retrieve a valid codeclient_secret/code or codeurl/code to allow re-submission./psession (string)
expand (array)
post_v1_identity_verification_sessions_by_sessionpUpdates a VerificationSession object./p pWhen the session status is coderequires_input/code, you can use this method to update the verification check and options./psession (string)
post_v1_identity_verification_sessions_by_session_cancelpA VerificationSession object can be canceled when it is in coderequires_input/code a href='/docs/identity/how-sessions-work'status/a./p pOnce canceled, future submission attempts are disabled. This cannot be undone. a href='/docs/identity/verification-sessions cancel'Learn more/a./psession (string)
post_v1_identity_verification_sessions_by_session_redactpRedact 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./p pA VerificationSession object can be redacted when it is in coderequires_input/code or codeverified/code a href='/docs/identity/how-sessions-work'status/a. Redacting a VerificationSession in coderequires_action/code state will automatically cancel it./p pThe redaction process may take usession (string)
get_v1_invoice_paymentspWhen 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./pending_before (string)
expand (array)
invoice (string)
limit (integer)
payment: {
. payment_intent (string)
. type (string)
} (object)
starting_after (string)
status (string)
get_v1_invoice_payments_by_invoice_paymentpRetrieves the invoice payment with the given ID./pinvoice_payment (string)
expand (array)
get_v1_invoice_rendering_templatespList all templates, ordered by creation date, with the most recently created template appearing first./pending_before (string)
expand (array)
limit (integer)
starting_after (string)
status (string)
get_v1_invoice_rendering_templates_by_templatepRetrieves 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./ptemplate (string)
expand (array)
version (integer)
post_v1_invoice_rendering_templates_by_template_archivepUpdates the status of an invoice rendering template to ‘archived’ so no new Stripe objects customers, invoices, etc. can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it./ptemplate (string)
post_v1_invoice_rendering_templates_by_template_unarchivepUnarchive an invoice rendering template so it can be used on new Stripe objects again./ptemplate (string)
get_v1_invoiceitemspReturns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first./pcreated (undefined)
customer (string)
ending_before (string)
expand (array)
invoice (string)
limit (integer)
pending (boolean)
starting_after (string)
post_v1_invoiceitemspCreates 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./pNo parameters
delete_v1_invoiceitems_by_invoiceitempDeletes 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./pinvoiceitem (string)
get_v1_invoiceitems_by_invoiceitempRetrieves the invoice item with the given ID./pinvoiceitem (string)
expand (array)
post_v1_invoiceitems_by_invoiceitempUpdates 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./pinvoiceitem (string)
get_v1_invoicespYou 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./pcollection_method (string)
created (undefined)
customer (string)
due_date (undefined)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
status (string)
subscription (string)
post_v1_invoicespThis endpoint creates a draft invoice for a given customer. The invoice remains a draft until you a href=' finalize_invoice'finalize/a the invoice, which allows you to a href=' pay_invoice'pay/a or a href=' send_invoice'send/a the invoice to your customers./pNo parameters
post_v1_invoices_create_previewpAt any time, you can preview the upcoming invoice for a subscription or subscription schedule. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice./p pYou can also preview the effects of creating or updating a subscription or subscription schedule, including a preview of any prorations that will take place. To ensure that the actual proration is calculatedNo parameters
get_v1_invoices_searchpSearch 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./pexpand (array)
limit (integer)
page (string)
query (string) required
delete_v1_invoices_by_invoicepPermanently 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=' void_invoice'voided/a./pinvoice (string)
get_v1_invoices_by_invoicepRetrieves the invoice with the given ID./pinvoice (string)
expand (array)
post_v1_invoices_by_invoicepDraft invoices are fully editable. Once an invoice is a href='/docs/billing/invoices/workflow finalized'finalized/a, monetary values, as well as codecollection_method/code, become uneditable./p pIf you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on, sending reminders for, or a href='/docs/billing/invoices/reconciliation'automatically reconciling/a invoices, pass codeauto_advance=false/code./pinvoice (string)
post_v1_invoices_by_invoice_add_linespAdds multiple line items to an invoice. This is only possible when an invoice is still a draft./pinvoice (string)
post_v1_invoices_by_invoice_attach_paymentpAttaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of codepayments/code./p pFor the PaymentIntent, when the PaymentIntent’s status changes to codesucceeded/code, the payment is credited to the invoice, increasing its codeamount_paid/code. When the invoice is fully paid, the invoice’s status becomes codepaid/code./p pIf the PaymentIntent’s status is already codesucceeded/code when it’s attached, it’s credited to the invoice immediately./p pSee: a href='/dinvoice (string)
post_v1_invoices_by_invoice_finalizepStripe 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./pinvoice (string)
get_v1_invoices_by_invoice_linespWhen retrieving an invoice, you’ll get a stronglines/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./pinvoice (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
post_v1_invoices_by_invoice_lines_by_line_item_idpUpdates an invoice’s line item. Some fields, such as codetax_amounts/code, only live on the invoice line item, so they can only be updated through this endpoint. Other fields, such as codeamount/code, live on both the invoice item and the invoice line item, so updates on this endpoint will propagate to the invoice item as well. Updating an invoice’s line item is only possible before the invoice is finalized./pinvoice (string)
line_item_id (string)
post_v1_invoices_by_invoice_mark_uncollectiblepMarking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes./pinvoice (string)
post_v1_invoices_by_invoice_paypStripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your a href='https://dashboard.stripe.com/account/billing/automatic'subscriptions settings/a. However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so./pinvoice (string)
post_v1_invoices_by_invoice_remove_linespRemoves multiple line items from an invoice. This is only possible when an invoice is still a draft./pinvoice (string)
post_v1_invoices_by_invoice_sendpStripe will automatically send invoices to customers according to your a href='https://dashboard.stripe.com/account/billing/automatic'subscriptions settings/a. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email./p pRequests made in test-mode result in no emails being sent, despite sending an codeinvoice.sent/code event./pinvoice (string)
post_v1_invoices_by_invoice_update_linespUpdates multiple line items on an invoice. This is only possible when an invoice is still a draft./pinvoice (string)
post_v1_invoices_by_invoice_voidpMark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to a href=' delete_invoice'deletion/a, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found./p pConsult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you’re doing business in. You might need to a href=' create_invoice'issue another invoice/a or a href=' create_credit_note'creditinvoice (string)
get_v1_issuing_authorizationspReturns a list of Issuing codeAuthorization/code objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first./pcard (string)
cardholder (string)
created (undefined)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
status (string)
get_v1_issuing_authorizations_by_authorizationpRetrieves an Issuing codeAuthorization/code object./pauthorization (string)
expand (array)
post_v1_issuing_authorizations_by_authorizationpUpdates the specified Issuing codeAuthorization/code object by setting the values of the parameters passed. Any parameters not provided will be left unchanged./pauthorization (string)
post_v1_issuing_authorizations_by_authorization_approvepDeprecated Approves a pending Issuing codeAuthorization/code object. This request should be made within the timeout window of the a href='/docs/issuing/controls/real-time-authorizations'real-time authorization/a flow. This method is deprecated. Instead, a href='/docs/issuing/controls/real-time-authorizations authorization-handling'respond directly to the webhook request to approve an authorization/a./pauthorization (string)
post_v1_issuing_authorizations_by_authorization_declinepDeprecated Declines a pending Issuing codeAuthorization/code object. This request should be made within the timeout window of the a href='/docs/issuing/controls/real-time-authorizations'real time authorization/a flow. This method is deprecated. Instead, a href='/docs/issuing/controls/real-time-authorizations authorization-handling'respond directly to the webhook request to decline an authorization/a./pauthorization (string)
get_v1_issuing_cardholderspReturns a list of Issuing codeCardholder/code objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first./pcreated (undefined)
email (string)
ending_before (string)
expand (array)
limit (integer)
phone_number (string)
starting_after (string)
status (string)
type (string)
post_v1_issuing_cardholderspCreates a new Issuing codeCardholder/code object that can be issued cards./pNo parameters
get_v1_issuing_cardholders_by_cardholderpRetrieves an Issuing codeCardholder/code object./pcardholder (string)
expand (array)
post_v1_issuing_cardholders_by_cardholderpUpdates the specified Issuing codeCardholder/code object by setting the values of the parameters passed. Any parameters not provided will be left unchanged./pcardholder (string)
get_v1_issuing_cardspReturns a list of Issuing codeCard/code objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first./pcardholder (string)
created (undefined)
ending_before (string)
exp_month (integer)
exp_year (integer)
expand (array)
last4 (string)
limit (integer)
personalization_design (string)
starting_after (string)
status (string)
type (string)
post_v1_issuing_cardspCreates an Issuing codeCard/code object./pNo parameters
get_v1_issuing_cards_by_cardpRetrieves an Issuing codeCard/code object./pcard (string)
expand (array)
post_v1_issuing_cards_by_cardpUpdates the specified Issuing codeCard/code object by setting the values of the parameters passed. Any parameters not provided will be left unchanged./pcard (string)
get_v1_issuing_disputespReturns a list of Issuing codeDispute/code objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first./pcreated (undefined)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
status (string)
transaction (string)
post_v1_issuing_disputespCreates an Issuing codeDispute/code object. Individual pieces of evidence within the codeevidence/code object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to a href='/docs/issuing/purchases/disputes dispute-reasons-and-evidence'Dispute reasons and evidence/a for more details about evidence requirements./pNo parameters
get_v1_issuing_disputes_by_disputepRetrieves an Issuing codeDispute/code object./pdispute (string)
expand (array)
post_v1_issuing_disputes_by_disputepUpdates the specified Issuing codeDispute/code object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the codeevidence/code object can be unset by passing in an empty string./pdispute (string)
post_v1_issuing_disputes_by_dispute_submitpSubmits an Issuing codeDispute/code to the card network. Stripe validates that all evidence fields required for the dispute’s reason are present. For more details, see a href='/docs/issuing/purchases/disputes dispute-reasons-and-evidence'Dispute reasons and evidence/a./pdispute (string)
get_v1_issuing_personalization_designspReturns a list of personalization design objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first./pending_before (string)
expand (array)
limit (integer)
lookup_keys (array)
preferences: {
. is_default (boolean)
. is_platform_default (boolean)
} (object)
starting_after (string)
status (string)
post_v1_issuing_personalization_designspCreates a personalization design object./pNo parameters
get_v1_issuing_personalization_designs_by_personalization_designpRetrieves a personalization design object./ppersonalization_design (string)
expand (array)
post_v1_issuing_personalization_designs_by_personalization_designpUpdates a card personalization object./ppersonalization_design (string)
get_v1_issuing_physical_bundlespReturns a list of physical bundle objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first./pending_before (string)
expand (array)
limit (integer)
starting_after (string)
status (string)
type (string)
get_v1_issuing_physical_bundles_by_physical_bundlepRetrieves a physical bundle object./pphysical_bundle (string)
expand (array)
get_v1_issuing_settlements_by_settlementpRetrieves an Issuing codeSettlement/code object./psettlement (string)
expand (array)
post_v1_issuing_settlements_by_settlementpUpdates the specified Issuing codeSettlement/code object by setting the values of the parameters passed. Any parameters not provided will be left unchanged./psettlement (string)
get_v1_issuing_tokenspLists all Issuing codeToken/code objects for a given card./pcard (string) required
created (undefined)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
status (string)
get_v1_issuing_tokens_by_tokenpRetrieves an Issuing codeToken/code object./ptoken (string)
expand (array)
post_v1_issuing_tokens_by_tokenpAttempts to update the specified Issuing codeToken/code object to the status specified./ptoken (string)
get_v1_issuing_transactionspReturns a list of Issuing codeTransaction/code objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first./pcard (string)
cardholder (string)
created (undefined)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
type (string)
get_v1_issuing_transactions_by_transactionpRetrieves an Issuing codeTransaction/code object./ptransaction (string)
expand (array)
post_v1_issuing_transactions_by_transactionpUpdates the specified Issuing codeTransaction/code object by setting the values of the parameters passed. Any parameters not provided will be left unchanged./ptransaction (string)
post_v1_link_account_sessionspTo launch the Financial Connections authorization flow, create a codeSession/code. The session’s codeclient_secret/code can be used to launch the flow using Stripe.js./pNo parameters
get_v1_link_account_sessions_by_sessionpRetrieves the details of a Financial Connections codeSession/code/psession (string)
expand (array)
get_v1_linked_accountspReturns a list of Financial Connections codeAccount/code objects./paccount_holder: {
. account (string)
. customer (string)
} (object)
ending_before (string)
expand (array)
limit (integer)
session (string)
starting_after (string)
get_v1_linked_accounts_by_accountpRetrieves the details of an Financial Connections codeAccount/code./paccount (string)
expand (array)
post_v1_linked_accounts_by_account_disconnectpDisables your access to a Financial Connections codeAccount/code. You will no longer be able to access data associated with the account e.g. balances, transactions./paccount (string)
get_v1_linked_accounts_by_account_ownerspLists all owners for a given codeAccount/code/paccount (string)
ending_before (string)
expand (array)
limit (integer)
ownership (string) required
starting_after (string)
post_v1_linked_accounts_by_account_refreshpRefreshes the data associated with a Financial Connections codeAccount/code./paccount (string)
get_v1_mandates_by_mandatepRetrieves a Mandate object./pmandate (string)
expand (array)
get_v1_payment_intentspReturns a list of PaymentIntents./pcreated (undefined)
customer (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
post_v1_payment_intentspCreates a PaymentIntent object./p pAfter the PaymentIntent is created, attach a payment method and a href='/docs/api/payment_intents/confirm'confirm/a to continue the payment. Learn more about a href='/docs/payments/payment-intents'the available payment flows with the Payment Intents API/a./p pWhen you use codeconfirm=true/code during creation, it’s equivalent to creating and confirming the PaymentIntent in the same call. You can use any parameters available in the a href='/docs/api/payment_iNo parameters
get_v1_payment_intents_searchpSearch 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./pexpand (array)
limit (integer)
page (string)
query (string) required
get_v1_payment_intents_by_intentpRetrieves the details of a PaymentIntent that has previously been created. /p pYou can retrieve a PaymentIntent client-side using a publishable key when the codeclient_secret/code is in the query string. /p pIf 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./pintent (string)
client_secret (string)
expand (array)
post_v1_payment_intents_by_intentpUpdates properties on a PaymentIntent object without confirming./p pDepending on which properties you update, you might need to confirm the PaymentIntent again. For example, updating the codepayment_method/code always requires you to confirm the PaymentIntent again. If you prefer to update and confirm at the same time, we recommend updating properties through the a href='/docs/api/payment_intents/confirm'confirm API/a instead./pintent (string)
post_v1_payment_intents_by_intent_apply_customer_balancepManually reconcile the remaining amount for a codecustomer_balance/code PaymentIntent./pintent (string)
post_v1_payment_intents_by_intent_cancelpYou can cancel a PaymentIntent object when it’s in one of these statuses: coderequires_payment_method/code, coderequires_capture/code, coderequires_confirmation/code, coderequires_action/code or, a href='/docs/payments/intents'in rare cases/a, codeprocessing/code. /p pAfter it’s canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a codestatus/code of coderequires_capture/code, the remaining codeamountintent (string)
post_v1_payment_intents_by_intent_capturepCapture the funds of an existing uncaptured PaymentIntent when its status is coderequires_capture/code./p pUncaptured PaymentIntents are cancelled a set number of days 7 by default after their creation./p pLearn more about a href='/docs/payments/capture-later'separate authorization and capture/a./pintent (string)
post_v1_payment_intents_by_intent_confirmpConfirm that your customer intends to pay with current or provided payment method. Upon confirmation, the PaymentIntent will attempt to initiate a payment./p pIf the selected payment method requires additional authentication steps, the PaymentIntent will transition to the coderequires_action/code status and suggest additional actions via codenext_action/code. If payment fails, the PaymentIntent transitions to the coderequires_payment_method/code status or the codecanceled/code status if the cointent (string)
post_v1_payment_intents_by_intent_increment_authorizationpPerform an incremental authorization on an eligible a href='/docs/api/payment_intents/object'PaymentIntent/a. To be eligible, the PaymentIntent’s status must be coderequires_capture/code and a href='/docs/api/charges/object charge_object-payment_method_details-card_present-incremental_authorization_supported'incremental_authorization_supported/a must be codetrue/code./p pIncremental authorizations attempt to increase the authorized amount on your customer’s card to the new, higher codeamount/cintent (string)
post_v1_payment_intents_by_intent_verify_microdepositspVerifies microdeposits on a PaymentIntent object./pintent (string)
get_v1_payment_linkspReturns a list of your payment links./pactive (boolean)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
post_v1_payment_linkspCreates a payment link./pNo parameters
get_v1_payment_links_by_payment_linkpRetrieve a payment link./ppayment_link (string)
expand (array)
post_v1_payment_links_by_payment_linkpUpdates a payment link./ppayment_link (string)
get_v1_payment_links_by_payment_link_line_itemspWhen retrieving a payment link, there is an includable strongline_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./ppayment_link (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
get_v1_payment_method_configurationspList payment method configurations/papplication (undefined)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
post_v1_payment_method_configurationspCreates a payment method configuration/pNo parameters
get_v1_payment_method_configurations_by_configurationpRetrieve payment method configuration/pconfiguration (string)
expand (array)
post_v1_payment_method_configurations_by_configurationpUpdate payment method configuration/pconfiguration (string)
get_v1_payment_method_domainspLists the details of existing payment method domains./pdomain_name (string)
enabled (boolean)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
post_v1_payment_method_domainspCreates a payment method domain./pNo parameters
get_v1_payment_method_domains_by_payment_method_domainpRetrieves the details of an existing payment method domain./ppayment_method_domain (string)
expand (array)
post_v1_payment_method_domains_by_payment_method_domainpUpdates an existing payment method domain./ppayment_method_domain (string)
post_v1_payment_method_domains_by_payment_method_domain_validatepSome payment methods might require additional steps to register a domain. If the requirements weren’t satisfied when the domain was created, the payment method will be inactive on the domain. The payment method doesn’t appear in Elements or Embedded Checkout for this domain until it is active./p pTo activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoipayment_method_domain (string)
get_v1_payment_methodspReturns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the a href='/docs/api/payment_methods/customer_list'List a Customer’s PaymentMethods/a API instead./pcustomer (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
type (string)
post_v1_payment_methodspCreates a PaymentMethod object. Read the a href='/docs/stripe-js/reference stripe-create-payment-method'Stripe.reference/a to learn how to create PaymentMethods via Stripe.js./p pInstead of creating a PaymentMethod directly, we recommend using the a href='/docs/payments/accept-a-payment'PaymentIntents/a API to accept a payment immediately or the a href='/docs/payments/save-and-reuse'SetupIntent/a API to collect payment method details ahead of a future payment./pNo parameters
get_v1_payment_methods_by_payment_methodpRetrieves 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/ppayment_method (string)
expand (array)
post_v1_payment_methods_by_payment_methodpUpdates a PaymentMethod object. A PaymentMethod must be attached to a customer to be updated./ppayment_method (string)
post_v1_payment_methods_by_payment_method_attachpAttaches a PaymentMethod object to a Customer./p pTo attach a new PaymentMethod to a customer for future payments, we recommend you use a a href='/docs/api/setup_intents'SetupIntent/a or a PaymentIntent with a href='/docs/api/payment_intents/create create_payment_intent-setup_future_usage'setup_future_usage/a. These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the code/v1/payment_methods/:id/attach/code endpoint without first using a SetupIpayment_method (string)
post_v1_payment_methods_by_payment_method_detachpDetaches 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./ppayment_method (string)
get_v1_payoutspReturns 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./parrival_date (undefined)
created (undefined)
destination (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
status (string)
post_v1_payoutspTo send funds to your own bank account, create a new payout object. Your a href=' balance'Stripe balance/a must cover the payout amount. If it doesn’t, you receive an “Insufficient Funds” error./p pIf your API key is in test mode, money won’t actually be sent, though every other action occurs as if you’re in live mode./p pIf you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The a hrefNo parameters
get_v1_payouts_by_payoutpRetrieves 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./ppayout (string)
expand (array)
post_v1_payouts_by_payoutpUpdates the specified payout by setting the values of the parameters you pass. We don’t change parameters that you don’t provide. This request only accepts the metadata as arguments./ppayout (string)
post_v1_payouts_by_payout_cancelpYou can cancel a previously created payout if its status is codepending/code. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts./ppayout (string)
post_v1_payouts_by_payout_reversepReverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US bank accounts. If the payout is manual and in the codepending/code status, use code/v1/payouts/:id/cancel/code instead./p pBy requesting a reversal through code/v1/payouts/:id/reverse/code, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required./ppayout (string)
get_v1_planspReturns a list of your plans./pactive (boolean)
created (undefined)
ending_before (string)
expand (array)
limit (integer)
product (string)
starting_after (string)
post_v1_planspYou can now model subscriptions more flexibly using the a href=' prices'Prices API/a. It replaces the Plans API and is backwards compatible to simplify your migration./pNo parameters
delete_v1_plans_by_planpDeleting plans means new subscribers can’t be added. Existing subscribers aren’t affected./pplan (string)
get_v1_plans_by_planpRetrieves the plan with the given ID./pplan (string)
expand (array)
post_v1_plans_by_planpUpdates 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./pplan (string)
get_v1_pricespReturns 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 codeactive/code to false./pactive (boolean)
created (undefined)
currency (string)
ending_before (string)
expand (array)
limit (integer)
lookup_keys (array)
product (string)
recurring: {
. interval (string)
. meter (string)
. usage_type (string)
} (object)
starting_after (string)
type (string)
post_v1_pricespCreates a new a href='https://docs.stripe.com/api/prices'Price/a for an existing a href='https://docs.stripe.com/api/products'Product/a. The Price can be recurring or one-time./pNo parameters
get_v1_prices_searchpSearch 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./pexpand (array)
limit (integer)
page (string)
query (string) required
get_v1_prices_by_pricepRetrieves the price with the given ID./pprice (string)
expand (array)
post_v1_prices_by_pricepUpdates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged./pprice (string)
get_v1_productspReturns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first./pactive (boolean)
created (undefined)
ending_before (string)
expand (array)
ids (array)
limit (integer)
shippable (boolean)
starting_after (string)
url (string)
post_v1_productspCreates a new product object./pNo parameters
get_v1_products_searchpSearch 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./pexpand (array)
limit (integer)
page (string)
query (string) required
delete_v1_products_by_idpDelete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with codetype=good/code is only possible if it has no SKUs associated with it./pid (string)
get_v1_products_by_idpRetrieves 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./pid (string)
expand (array)
post_v1_products_by_idpUpdates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged./pid (string)
get_v1_products_by_product_featurespRetrieve a list of features for a product/pproduct (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
post_v1_products_by_product_featurespCreates a product_feature, which represents a feature attachment to a product/pproduct (string)
delete_v1_products_by_product_features_by_idpDeletes the feature attachment to a product/pid (string)
product (string)
get_v1_products_by_product_features_by_idpRetrieves a product_feature, which represents a feature attachment to a product/pid (string)
product (string)
expand (array)
get_v1_promotion_codespReturns a list of your promotion codes./pactive (boolean)
code (string)
coupon (string)
created (undefined)
customer (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
post_v1_promotion_codespA promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date./pNo parameters
get_v1_promotion_codes_by_promotion_codepRetrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing codecode/code use a href='/docs/api/promotion_codes/list'list/a with the desired codecode/code./ppromotion_code (string)
expand (array)
post_v1_promotion_codes_by_promotion_codepUpdates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable./ppromotion_code (string)
get_v1_quotespReturns a list of your quotes./pcustomer (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
status (string)
test_clock (string)
post_v1_quotespA quote models prices and services for a customer. Default options for codeheader/code, codedescription/code, codefooter/code, and codeexpires_at/code can be set in the dashboard via the a href='https://dashboard.stripe.com/settings/billing/quote'quote template/a./pNo parameters
get_v1_quotes_by_quotepRetrieves the quote with the given ID./pquote (string)
expand (array)
post_v1_quotes_by_quotepA quote models prices and services for a customer./pquote (string)
post_v1_quotes_by_quote_acceptpAccepts the specified quote./pquote (string)
post_v1_quotes_by_quote_cancelpCancels the quote./pquote (string)
get_v1_quotes_by_quote_computed_upfront_line_itemspWhen retrieving a quote, there is an includable a href='https://stripe.com/docs/api/quotes/object quote_object-computed-upfront-line_items'strongcomputed.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./pquote (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
post_v1_quotes_by_quote_finalizepFinalizes the quote./pquote (string)
get_v1_quotes_by_quote_line_itemspWhen retrieving a quote, there is an includable strongline_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./pquote (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
get_v1_quotes_by_quote_pdfpDownload 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/pquote (string)
expand (array)
get_v1_radar_early_fraud_warningspReturns a list of early fraud warnings./pcharge (string)
created (undefined)
ending_before (string)
expand (array)
limit (integer)
payment_intent (string)
starting_after (string)
get_v1_radar_early_fraud_warnings_by_early_fraud_warningpRetrieves the details of an early fraud warning that has previously been created. /p pPlease refer to the a href=' early_fraud_warning_object'early fraud warning/a object reference for more details./pearly_fraud_warning (string)
expand (array)
get_v1_radar_value_list_itemspReturns a list of codeValueListItem/code objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first./pcreated (undefined)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
value (string)
value_list (string) required
post_v1_radar_value_list_itemspCreates a new codeValueListItem/code object, which is added to the specified parent value list./pNo parameters
delete_v1_radar_value_list_items_by_itempDeletes a codeValueListItem/code object, removing it from its parent value list./pitem (string)
get_v1_radar_value_list_items_by_itempRetrieves a codeValueListItem/code object./pitem (string)
expand (array)
get_v1_radar_value_listspReturns a list of codeValueList/code objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first./palias (string)
contains (string)
created (undefined)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
post_v1_radar_value_listspCreates a new codeValueList/code object, which can then be referenced in rules./pNo parameters
delete_v1_radar_value_lists_by_value_listpDeletes a codeValueList/code object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules./pvalue_list (string)
get_v1_radar_value_lists_by_value_listpRetrieves a codeValueList/code object./pvalue_list (string)
expand (array)
post_v1_radar_value_lists_by_value_listpUpdates a codeValueList/code object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that codeitem_type/code is immutable./pvalue_list (string)
get_v1_refundspReturns 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./pcharge (string)
created (undefined)
ending_before (string)
expand (array)
limit (integer)
payment_intent (string)
starting_after (string)
post_v1_refundspWhen you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it./p pCreating 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 pYou can optionally refund only part of a charge. You can do so multiple times, until the entire charge has been refunded./p pOnce entirely refunded, a charge can’t be refunded again. This method will raise aNo parameters
get_v1_refunds_by_refundpRetrieves the details of an existing refund./prefund (string)
expand (array)
post_v1_refunds_by_refundpUpdates the refund that you specify by setting the values of the passed parameters. Any parameters that you don’t provide remain unchanged./p pThis request only accepts codemetadata/code as an argument./prefund (string)
post_v1_refunds_by_refund_cancelpCancels a refund with a status of coderequires_action/code./p pYou can’t cancel refunds in other states. Only refunds for payment methods that require customer action can enter the coderequires_action/code state./prefund (string)
get_v1_reporting_report_runspReturns a list of Report Runs, with the most recent appearing first./pcreated (undefined)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
post_v1_reporting_report_runspCreates a new object and begin running the report. Certain report types require a a href='https://stripe.com/docs/keys test-live-modes'live-mode API key/a./pNo parameters
get_v1_reporting_report_runs_by_report_runpRetrieves the details of an existing Report Run./preport_run (string)
expand (array)
get_v1_reporting_report_typespReturns a full list of Report Types./pexpand (array)
get_v1_reporting_report_types_by_report_typepRetrieves 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./preport_type (string)
expand (array)
get_v1_reviewspReturns a list of codeReview/code objects that have codeopen/code set to codetrue/code. The objects are sorted in descending order by creation date, with the most recently created object appearing first./pcreated (undefined)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
get_v1_reviews_by_reviewpRetrieves a codeReview/code object./preview (string)
expand (array)
post_v1_reviews_by_review_approvepApproves a codeReview/code object, closing it and removing it from the list of reviews./preview (string)
get_v1_setup_attemptspReturns a list of SetupAttempts that associate with a provided SetupIntent./pcreated (undefined)
ending_before (string)
expand (array)
limit (integer)
setup_intent (string) required
starting_after (string)
get_v1_setup_intentspReturns a list of SetupIntents./pattach_to_self (boolean)
created (undefined)
customer (string)
ending_before (string)
expand (array)
limit (integer)
payment_method (string)
starting_after (string)
post_v1_setup_intentspCreates a SetupIntent object./p pAfter you create the SetupIntent, attach a payment method and a href='/docs/api/setup_intents/confirm'confirm/a it to collect any required permissions to charge the payment method later./pNo parameters
get_v1_setup_intents_by_intentpRetrieves the details of a SetupIntent that has previously been created. /p pClient-side retrieval using a publishable key is allowed when the codeclient_secret/code is provided in the query string. /p pWhen 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./pintent (string)
client_secret (string)
expand (array)
post_v1_setup_intents_by_intentpUpdates a SetupIntent object./pintent (string)
post_v1_setup_intents_by_intent_cancelpYou can cancel a SetupIntent object when it’s in one of these statuses: coderequires_payment_method/code, coderequires_confirmation/code, or coderequires_action/code. /p pAfter you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can’t cancel the SetupIntent for a Checkout Session. a href='/docs/api/checkout/sessions/expire'Expire the Checkout Session/a instead./pintent (string)
post_v1_setup_intents_by_intent_confirmpConfirm 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./p pIf the selected payment method does not require any additional steps from the customer, the SetupIntent will transition to the codesucceeded/code status./p pOtherwise, it will transition to the coderequires_action/code status and suggest additional actions via codenext_acintent (string)
post_v1_setup_intents_by_intent_verify_microdepositspVerifies microdeposits on a SetupIntent object./pintent (string)
get_v1_shipping_ratespReturns a list of your shipping rates./pactive (boolean)
created (undefined)
currency (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
post_v1_shipping_ratespCreates a new shipping rate object./pNo parameters
get_v1_shipping_rates_by_shipping_rate_tokenpReturns the shipping rate object with the given ID./pshipping_rate_token (string)
expand (array)
post_v1_shipping_rates_by_shipping_rate_tokenpUpdates an existing shipping rate object./pshipping_rate_token (string)
post_v1_sigma_saved_queries_by_idpUpdate an existing Sigma query that previously exists/pid (string)
get_v1_sigma_scheduled_query_runspReturns a list of scheduled query runs./pending_before (string)
expand (array)
limit (integer)
starting_after (string)
get_v1_sigma_scheduled_query_runs_by_scheduled_query_runpRetrieves the details of an scheduled query run./pscheduled_query_run (string)
expand (array)
post_v1_sourcespCreates a new source object./pNo parameters
get_v1_sources_by_sourcepRetrieves 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./psource (string)
client_secret (string)
expand (array)
post_v1_sources_by_sourcepUpdates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged./p pThis request accepts the codemetadata/code and codeowner/code as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our a href='/docs/sources'payment method guides/a for more detail./psource (string)
get_v1_sources_by_source_mandate_notifications_by_mandate_notificationpRetrieves a new Source MandateNotification./pmandate_notification (string)
source (string)
expand (array)
get_v1_sources_by_source_source_transactionspList source transactions for a given source./psource (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
get_v1_sources_by_source_source_transactions_by_source_transactionpRetrieve 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./psource (string)
source_transaction (string)
expand (array)
post_v1_sources_by_source_verifypVerify a given source./psource (string)
get_v1_subscription_itemspReturns a list of your subscription items for a given subscription./pending_before (string)
expand (array)
limit (integer)
starting_after (string)
subscription (string) required
post_v1_subscription_itemspAdds a new item to an existing subscription. No existing items will be changed or replaced./pNo parameters
delete_v1_subscription_items_by_itempDeletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription./pitem (string)
get_v1_subscription_items_by_itempRetrieves the subscription item with the given ID./pitem (string)
expand (array)
post_v1_subscription_items_by_itempUpdates the plan or quantity of an item on a current subscription./pitem (string)
get_v1_subscription_schedulespRetrieves the list of your subscription schedules./pcanceled_at (undefined)
completed_at (undefined)
created (undefined)
customer (string)
ending_before (string)
expand (array)
limit (integer)
released_at (undefined)
scheduled (boolean)
starting_after (string)
post_v1_subscription_schedulespCreates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions./pNo parameters
get_v1_subscription_schedules_by_schedulepRetrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation./pschedule (string)
expand (array)
post_v1_subscription_schedules_by_schedulepUpdates an existing subscription schedule./pschedule (string)
post_v1_subscription_schedules_by_schedule_cancelpCancels 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 codenot_started/code or codeactive/code./pschedule (string)
post_v1_subscription_schedules_by_schedule_releasepReleases 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 codenot_started/code or codeactive/code. If the subscription schedule is currently associated with a subscription, releasing it will remove its codesubscription/code property and set the subscription’s ID to the codereleased_subscription/code property./pschedule (string)
get_v1_subscriptionspBy default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify codestatus=canceled/code./pautomatic_tax: {
. enabled (boolean)
} (object)
collection_method (string)
created (undefined)
current_period_end (undefined)
current_period_start (undefined)
customer (string)
ending_before (string)
expand (array)
limit (integer)
price (string)
starting_after (string)
status (string)
test_clock (string)
post_v1_subscriptionspCreates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions./p pWhen you create a subscription with codecollection_method=charge_automatically/code, the first invoice is finalized as part of the request. The codepayment_behavior/code parameter determines the exact behavior of the initial payment./p pTo start subscriptions where the first invoice always begins in a codedraft/code status, use a href='/docs/billing/subscriptions/subscripNo parameters
get_v1_subscriptions_searchpSearch 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./pexpand (array)
limit (integer)
page (string)
query (string) required
delete_v1_subscriptions_by_subscription_exposed_idpCancels a customer’s subscription immediately. The customer won’t be charged again for the subscription. After it’s canceled, you can no longer update the subscription or its a href='/metadata'metadata/a./p pAny pending invoice items that you’ve created are still charged at the end of the period, unless manually a href=' delete_invoiceitem'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 thesubscription_exposed_id (string)
get_v1_subscriptions_by_subscription_exposed_idpRetrieves the subscription with the given ID./psubscription_exposed_id (string)
expand (array)
post_v1_subscriptions_by_subscription_exposed_idpUpdates an existing subscription to match the specified parameters. When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes. To preview how the proration is calculated, use the a href='/docs/api/invoices/create_preview'create preview/a endpoint./p pBy default, we prorate subscription changes. For example, if a customer signs up on May 1 for a currency100/currency price, they’ll be billed currency100/currency immediately. If on Msubscription_exposed_id (string)
delete_v1_subscriptions_by_subscription_exposed_id_discountpRemoves the currently applied discount on a subscription./psubscription_exposed_id (string)
post_v1_subscriptions_by_subscription_migratepUpgrade the billing_mode of an existing subscription./psubscription (string)
post_v1_subscriptions_by_subscription_resumepInitiates 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 codeactive/code, and if payment fails the subscription will be codepast_due/code. The resumption invoice will void automatically if not paid by the expiration date./psubscription (string)
post_v1_tax_calculationspCalculates tax based on the input and returns a Tax codeCalculation/code object./pNo parameters
get_v1_tax_calculations_by_calculationpRetrieves a Tax codeCalculation/code object, if the calculation hasn’t expired./pcalculation (string)
expand (array)
get_v1_tax_calculations_by_calculation_line_itemspRetrieves the line items of a tax calculation as a collection, if the calculation hasn’t expired./pcalculation (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
get_v1_tax_registrationspReturns a list of Tax codeRegistration/code objects./pending_before (string)
expand (array)
limit (integer)
starting_after (string)
status (string)
post_v1_tax_registrationspCreates a new Tax codeRegistration/code object./pNo parameters
get_v1_tax_registrations_by_idpReturns a Tax codeRegistration/code object./pid (string)
expand (array)
post_v1_tax_registrations_by_idpUpdates an existing Tax codeRegistration/code object./p pA registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting codeexpires_at/code./pid (string)
get_v1_tax_settingspRetrieves Tax codeSettings/code for a merchant./pexpand (array)
post_v1_tax_settingspUpdates Tax codeSettings/code parameters used in tax calculations. All parameters are editable but none can be removed once set./pNo parameters
post_v1_tax_transactions_create_from_calculationpCreates a Tax Transaction from a calculation, if that calculation hasn’t expired. Calculations expire after 90 days./pNo parameters
post_v1_tax_transactions_create_reversalpPartially or fully reverses a previously created codeTransaction/code./pNo parameters
get_v1_tax_transactions_by_transactionpRetrieves a Tax codeTransaction/code object./ptransaction (string)
expand (array)
get_v1_tax_transactions_by_transaction_line_itemspRetrieves the line items of a committed standalone transaction as a collection./ptransaction (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
get_v1_tax_codespA 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./pending_before (string)
expand (array)
limit (integer)
starting_after (string)
get_v1_tax_codes_by_idpRetrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information./pid (string)
expand (array)
get_v1_tax_idspReturns a list of tax IDs./pending_before (string)
expand (array)
limit (integer)
owner: {
. account (string)
. customer (string)
. type (string)
} (object)
starting_after (string)
post_v1_tax_idspCreates a new account or customer codetax_id/code object./pNo parameters
delete_v1_tax_ids_by_idpDeletes an existing account or customer codetax_id/code object./pid (string)
get_v1_tax_ids_by_idpRetrieves an account or customer codetax_id/code object./pid (string)
expand (array)
get_v1_tax_ratespReturns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first./pactive (boolean)
created (undefined)
ending_before (string)
expand (array)
inclusive (boolean)
limit (integer)
starting_after (string)
post_v1_tax_ratespCreates a new tax rate./pNo parameters
get_v1_tax_rates_by_tax_ratepRetrieves a tax rate with the given ID/ptax_rate (string)
expand (array)
post_v1_tax_rates_by_tax_ratepUpdates an existing tax rate./ptax_rate (string)
get_v1_terminal_configurationspReturns a list of codeConfiguration/code objects./pending_before (string)
expand (array)
is_account_default (boolean)
limit (integer)
starting_after (string)
post_v1_terminal_configurationspCreates a new codeConfiguration/code object./pNo parameters
delete_v1_terminal_configurations_by_configurationpDeletes a codeConfiguration/code object./pconfiguration (string)
get_v1_terminal_configurations_by_configurationpRetrieves a codeConfiguration/code object./pconfiguration (string)
expand (array)
post_v1_terminal_configurations_by_configurationpUpdates a new codeConfiguration/code object./pconfiguration (string)
post_v1_terminal_connection_tokenspTo 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./pNo parameters
get_v1_terminal_locationspReturns a list of codeLocation/code objects./pending_before (string)
expand (array)
limit (integer)
starting_after (string)
post_v1_terminal_locationspCreates a new codeLocation/code object. For further details, including which address fields are required in each country, see the a href='/docs/terminal/fleet/locations'Manage locations/a guide./pNo parameters
delete_v1_terminal_locations_by_locationpDeletes a codeLocation/code object./plocation (string)
get_v1_terminal_locations_by_locationpRetrieves a codeLocation/code object./plocation (string)
expand (array)
post_v1_terminal_locations_by_locationpUpdates a codeLocation/code object by setting the values of the parameters passed. Any parameters not provided will be left unchanged./plocation (string)
get_v1_terminal_readerspReturns a list of codeReader/code objects./pdevice_type (string)
ending_before (string)
expand (array)
limit (integer)
location (string)
serial_number (string)
starting_after (string)
status (string)
post_v1_terminal_readerspCreates a new codeReader/code object./pNo parameters
delete_v1_terminal_readers_by_readerpDeletes a codeReader/code object./preader (string)
get_v1_terminal_readers_by_readerpRetrieves a codeReader/code object./preader (string)
expand (array)
post_v1_terminal_readers_by_readerpUpdates a codeReader/code object by setting the values of the parameters passed. Any parameters not provided will be left unchanged./preader (string)
post_v1_terminal_readers_by_reader_cancel_actionpCancels the current reader action./preader (string)
post_v1_terminal_readers_by_reader_collect_inputspInitiates an input collection flow on a Reader./preader (string)
post_v1_terminal_readers_by_reader_collect_payment_methodpInitiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation./preader (string)
post_v1_terminal_readers_by_reader_confirm_payment_intentpFinalizes a payment on a Reader./preader (string)
post_v1_terminal_readers_by_reader_process_payment_intentpInitiates a payment flow on a Reader./preader (string)
post_v1_terminal_readers_by_reader_process_setup_intentpInitiates a setup intent flow on a Reader./preader (string)
post_v1_terminal_readers_by_reader_refund_paymentpInitiates a refund on a Reader/preader (string)
post_v1_terminal_readers_by_reader_set_reader_displaypSets reader display to show cart details./preader (string)
post_v1_test_helpers_confirmation_tokenspCreates a test mode Confirmation Token server side for your integration tests./pNo parameters
post_v1_test_helpers_customers_by_customer_fund_cash_balancepCreate an incoming testmode bank transfer/pcustomer (string)
post_v1_test_helpers_issuing_authorizationspCreate a test-mode authorization./pNo parameters
post_v1_test_helpers_issuing_authorizations_by_authorization_capturepCapture a test-mode authorization./pauthorization (string)
post_v1_test_helpers_issuing_authorizations_by_authorization_expirepExpire a test-mode Authorization./pauthorization (string)
post_v1_test_helpers_issuing_authorizations_by_authorization_finalize_amountpFinalize the amount on an Authorization prior to capture, when the initial authorization was for an estimated amount./pauthorization (string)
post_v1_test_helpers_issuing_authorizations_by_authorization_fraud_challenges_respondpRespond to a fraud challenge on a testmode Issuing authorization, simulating either a confirmation of fraud or a correction of legitimacy./pauthorization (string)
post_v1_test_helpers_issuing_authorizations_by_authorization_incrementpIncrement a test-mode Authorization./pauthorization (string)
post_v1_test_helpers_issuing_authorizations_by_authorization_reversepReverse a test-mode Authorization./pauthorization (string)
post_v1_test_helpers_issuing_cards_by_card_shipping_deliverpUpdates the shipping status of the specified Issuing codeCard/code object to codedelivered/code./pcard (string)
post_v1_test_helpers_issuing_cards_by_card_shipping_failpUpdates the shipping status of the specified Issuing codeCard/code object to codefailure/code./pcard (string)
post_v1_test_helpers_issuing_cards_by_card_shipping_returnpUpdates the shipping status of the specified Issuing codeCard/code object to codereturned/code./pcard (string)
post_v1_test_helpers_issuing_cards_by_card_shipping_shippUpdates the shipping status of the specified Issuing codeCard/code object to codeshipped/code./pcard (string)
post_v1_test_helpers_issuing_cards_by_card_shipping_submitpUpdates the shipping status of the specified Issuing codeCard/code object to codesubmitted/code. This method requires Stripe Version ‘2024-09-30.acacia’ or later./pcard (string)
post_v1_test_helpers_issuing_personalization_designs_by_personalization_design_activatepUpdates the codestatus/code of the specified testmode personalization design object to codeactive/code./ppersonalization_design (string)
post_v1_test_helpers_issuing_personalization_designs_by_personalization_design_deactivatepUpdates the codestatus/code of the specified testmode personalization design object to codeinactive/code./ppersonalization_design (string)
post_v1_test_helpers_issuing_personalization_designs_by_personalization_design_rejectpUpdates the codestatus/code of the specified testmode personalization design object to coderejected/code./ppersonalization_design (string)
post_v1_test_helpers_issuing_settlementspAllows the user to create an Issuing settlement./pNo parameters
post_v1_test_helpers_issuing_settlements_by_settlement_completepAllows the user to mark an Issuing settlement as complete./psettlement (string)
post_v1_test_helpers_issuing_transactions_create_force_capturepAllows the user to capture an arbitrary amount, also known as a forced capture./pNo parameters
post_v1_test_helpers_issuing_transactions_create_unlinked_refundpAllows the user to refund an arbitrary amount, also known as a unlinked refund./pNo parameters
post_v1_test_helpers_issuing_transactions_by_transaction_refundpRefund a test-mode Transaction./ptransaction (string)
post_v1_test_helpers_refunds_by_refund_expirepExpire a refund with a status of coderequires_action/code./prefund (string)
post_v1_test_helpers_terminal_readers_by_reader_present_payment_methodpPresents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction./preader (string)
post_v1_test_helpers_terminal_readers_by_reader_succeed_input_collectionpUse this endpoint to trigger a successful input collection on a simulated reader./preader (string)
post_v1_test_helpers_terminal_readers_by_reader_timeout_input_collectionpUse this endpoint to complete an input collection with a timeout error on a simulated reader./preader (string)
get_v1_test_helpers_test_clockspReturns a list of your test clocks./pending_before (string)
expand (array)
limit (integer)
starting_after (string)
post_v1_test_helpers_test_clockspCreates a new test clock that can be attached to new customers and quotes./pNo parameters
delete_v1_test_helpers_test_clocks_by_test_clockpDeletes a test clock./ptest_clock (string)
get_v1_test_helpers_test_clocks_by_test_clockpRetrieves a test clock./ptest_clock (string)
expand (array)
post_v1_test_helpers_test_clocks_by_test_clock_advancepStarts advancing a test clock to a specified time in the future. Advancement is done when status changes to codeReady/code./ptest_clock (string)
post_v1_test_helpers_treasury_inbound_transfers_by_id_failpTransitions a test mode created InboundTransfer to the codefailed/code status. The InboundTransfer must already be in the codeprocessing/code state./pid (string)
post_v1_test_helpers_treasury_inbound_transfers_by_id_returnpMarks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the codesucceeded/code state./pid (string)
post_v1_test_helpers_treasury_inbound_transfers_by_id_succeedpTransitions a test mode created InboundTransfer to the codesucceeded/code status. The InboundTransfer must already be in the codeprocessing/code state./pid (string)
post_v1_test_helpers_treasury_outbound_payments_by_idpUpdates a test mode created OutboundPayment with tracking details. The OutboundPayment must not be cancelable, and cannot be in the codecanceled/code or codefailed/code states./pid (string)
post_v1_test_helpers_treasury_outbound_payments_by_id_failpTransitions a test mode created OutboundPayment to the codefailed/code status. The OutboundPayment must already be in the codeprocessing/code state./pid (string)
post_v1_test_helpers_treasury_outbound_payments_by_id_postpTransitions a test mode created OutboundPayment to the codeposted/code status. The OutboundPayment must already be in the codeprocessing/code state./pid (string)
post_v1_test_helpers_treasury_outbound_payments_by_id_returnpTransitions a test mode created OutboundPayment to the codereturned/code status. The OutboundPayment must already be in the codeprocessing/code state./pid (string)
post_v1_test_helpers_treasury_outbound_transfers_by_outbound_transferpUpdates a test mode created OutboundTransfer with tracking details. The OutboundTransfer must not be cancelable, and cannot be in the codecanceled/code or codefailed/code states./poutbound_transfer (string)
post_v1_test_helpers_treasury_outbound_transfers_by_outbound_transfer_failpTransitions a test mode created OutboundTransfer to the codefailed/code status. The OutboundTransfer must already be in the codeprocessing/code state./poutbound_transfer (string)
post_v1_test_helpers_treasury_outbound_transfers_by_outbound_transfer_postpTransitions a test mode created OutboundTransfer to the codeposted/code status. The OutboundTransfer must already be in the codeprocessing/code state./poutbound_transfer (string)
post_v1_test_helpers_treasury_outbound_transfers_by_outbound_transfer_returnpTransitions a test mode created OutboundTransfer to the codereturned/code status. The OutboundTransfer must already be in the codeprocessing/code state./poutbound_transfer (string)
post_v1_test_helpers_treasury_received_creditspUse 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./pNo parameters
post_v1_test_helpers_treasury_received_debitspUse 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./pNo parameters
post_v1_tokenspCreates a single-use token that represents a bank account’s details. You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a a href=' accounts'connected account/a where a href='/api/accounts/object account_object-controller-requirement_collection'controller.requirement_collection/a is codeapplication/code, which includes Custom accounts./pNo parameters
get_v1_tokens_by_tokenpRetrieves the token with the given ID./ptoken (string)
expand (array)
get_v1_topupspReturns a list of top-ups./pamount (undefined)
created (undefined)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
status (string)
post_v1_topupspTop up the balance of an account/pNo parameters
get_v1_topups_by_topuppRetrieves 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./ptopup (string)
expand (array)
post_v1_topups_by_topuppUpdates the metadata of a top-up. Other top-up details are not editable by design./ptopup (string)
post_v1_topups_by_topup_cancelpCancels a top-up. Only pending top-ups can be canceled./ptopup (string)
get_v1_transferspReturns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first./pcreated (undefined)
destination (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
transfer_group (string)
post_v1_transferspTo send funds from your Stripe account to a connected account, you create a new transfer object. Your a href=' balance'Stripe balance/a must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error./pNo parameters
get_v1_transfers_by_id_reversalspYou 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 codelimit/code and codestarting_after/code parameters to page through additional reversals./pid (string)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
post_v1_transfers_by_id_reversalspWhen you create a new reversal, you must specify a transfer to create it on./p pWhen 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./p pOnce 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./pid (string)
get_v1_transfers_by_transferpRetrieves 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./ptransfer (string)
expand (array)
post_v1_transfers_by_transferpUpdates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged./p pThis request accepts only metadata as an argument./ptransfer (string)
get_v1_transfers_by_transfer_reversals_by_idpBy 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./pid (string)
transfer (string)
expand (array)
post_v1_transfers_by_transfer_reversals_by_idpUpdates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged./p pThis request only accepts metadata and description as arguments./pid (string)
transfer (string)
get_v1_treasury_credit_reversalspReturns a list of CreditReversals./pending_before (string)
expand (array)
financial_account (string) required
limit (integer)
received_credit (string)
starting_after (string)
status (string)
post_v1_treasury_credit_reversalspReverses a ReceivedCredit and creates a CreditReversal object./pNo parameters
get_v1_treasury_credit_reversals_by_credit_reversalpRetrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list/pcredit_reversal (string)
expand (array)
get_v1_treasury_debit_reversalspReturns a list of DebitReversals./pending_before (string)
expand (array)
financial_account (string) required
limit (integer)
received_debit (string)
resolution (string)
starting_after (string)
status (string)
post_v1_treasury_debit_reversalspReverses a ReceivedDebit and creates a DebitReversal object./pNo parameters
get_v1_treasury_debit_reversals_by_debit_reversalpRetrieves a DebitReversal object./pdebit_reversal (string)
expand (array)
get_v1_treasury_financial_accountspReturns a list of FinancialAccounts./pcreated (undefined)
ending_before (string)
expand (array)
limit (integer)
starting_after (string)
status (string)
post_v1_treasury_financial_accountspCreates a new FinancialAccount. Each connected account can have up to three FinancialAccounts by default./pNo parameters
get_v1_treasury_financial_accounts_by_financial_accountpRetrieves the details of a FinancialAccount./pfinancial_account (string)
expand (array)
post_v1_treasury_financial_accounts_by_financial_accountpUpdates the details of a FinancialAccount./pfinancial_account (string)
post_v1_treasury_financial_accounts_by_financial_account_closepCloses a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards./pfinancial_account (string)
get_v1_treasury_financial_accounts_by_financial_account_featurespRetrieves Features information associated with the FinancialAccount./pfinancial_account (string)
expand (array)
post_v1_treasury_financial_accounts_by_financial_account_featurespUpdates the Features associated with a FinancialAccount./pfinancial_account (string)
get_v1_treasury_inbound_transferspReturns a list of InboundTransfers sent from the specified FinancialAccount./pending_before (string)
expand (array)
financial_account (string) required
limit (integer)
starting_after (string)
status (string)
post_v1_treasury_inbound_transferspCreates an InboundTransfer./pNo parameters
get_v1_treasury_inbound_transfers_by_idpRetrieves the details of an existing InboundTransfer./pid (string)
expand (array)
post_v1_treasury_inbound_transfers_by_inbound_transfer_cancelpCancels an InboundTransfer./pinbound_transfer (string)
get_v1_treasury_outbound_paymentspReturns a list of OutboundPayments sent from the specified FinancialAccount./pcreated (undefined)
customer (string)
ending_before (string)
expand (array)
financial_account (string) required
limit (integer)
starting_after (string)
status (string)
post_v1_treasury_outbound_paymentspCreates an OutboundPayment./pNo parameters
get_v1_treasury_outbound_payments_by_idpRetrieves the details of an existing OutboundPayment by passing the unique OutboundPayment ID from either the OutboundPayment creation request or OutboundPayment list./pid (string)
expand (array)
post_v1_treasury_outbound_payments_by_id_cancelpCancel an OutboundPayment./pid (string)
get_v1_treasury_outbound_transferspReturns a list of OutboundTransfers sent from the specified FinancialAccount./pending_before (string)
expand (array)
financial_account (string) required
limit (integer)
starting_after (string)
status (string)
post_v1_treasury_outbound_transferspCreates an OutboundTransfer./pNo parameters
get_v1_treasury_outbound_transfers_by_outbound_transferpRetrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list./poutbound_transfer (string)
expand (array)
post_v1_treasury_outbound_transfers_by_outbound_transfer_cancelpAn OutboundTransfer can be canceled if the funds have not yet been paid out./poutbound_transfer (string)
get_v1_treasury_received_creditspReturns a list of ReceivedCredits./pending_before (string)
expand (array)
financial_account (string) required
limit (integer)
linked_flows: {
. source_flow_type (string)
} (object)
starting_after (string)
status (string)
get_v1_treasury_received_credits_by_idpRetrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list./pid (string)
expand (array)
get_v1_treasury_received_debitspReturns a list of ReceivedDebits./pending_before (string)
expand (array)
financial_account (string) required
limit (integer)
starting_after (string)
status (string)
get_v1_treasury_received_debits_by_idpRetrieves the details of an existing ReceivedDebit by passing the unique ReceivedDebit ID from the ReceivedDebit list/pid (string)
expand (array)
get_v1_treasury_transaction_entriespRetrieves a list of TransactionEntry objects./pcreated (undefined)
effective_at (undefined)
ending_before (string)
expand (array)
financial_account (string) required
limit (integer)
order_by (string)
starting_after (string)
transaction (string)
get_v1_treasury_transaction_entries_by_idpRetrieves a TransactionEntry object./pid (string)
expand (array)
get_v1_treasury_transactionspRetrieves a list of Transaction objects./pcreated (undefined)
ending_before (string)
expand (array)
financial_account (string) required
limit (integer)
order_by (string)
starting_after (string)
status (string)
status_transitions: {
. posted_at
} (object)
get_v1_treasury_transactions_by_idpRetrieves the details of an existing Transaction./pid (string)
expand (array)
get_v1_webhook_endpointspReturns a list of your webhook endpoints./pending_before (string)
expand (array)
limit (integer)
starting_after (string)
post_v1_webhook_endpointspA webhook endpoint must have a codeurl/code and a list of codeenabled_events/code. You may optionally specify the Boolean codeconnect/code parameter. If set to true, then a Connect webhook endpoint that notifies the specified codeurl/code about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified codeurl/code only about events from your account is created. You can also create webhook endpoints in the a href='https://dashboard.stripe.coNo parameters
delete_v1_webhook_endpoints_by_webhook_endpointpYou can also delete webhook endpoints via the a href='https://dashboard.stripe.com/account/webhooks'webhook endpoint management/a page of the Stripe dashboard./pwebhook_endpoint (string)
get_v1_webhook_endpoints_by_webhook_endpointpRetrieves the webhook endpoint with the given ID./pwebhook_endpoint (string)
expand (array)
post_v1_webhook_endpoints_by_webhook_endpointpUpdates the webhook endpoint. You may edit the codeurl/code, the list of codeenabled_events/code, and the status of your endpoint./pwebhook_endpoint (string)