Stripe

Manage your Stripe account.

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 571 actions:

Action	Purpose	Parameters
get_v1_account	pRetrieves the details of an account./p	expand (array)
post_v1_account_links	pCreates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow./p	No parameters
post_v1_account_sessions	pCreates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access./p	No parameters
get_v1_accounts	pReturns a list of accounts connected to your platform via a href='/docs/connect'Connect/a. If you’re not a platform, the list is empty./p	created ending_before (string) expand (array) limit (integer) starting_after (string)
post_v1_accounts	pWith 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 any	No parameters
delete_v1_accounts_by_account	pWith 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/sett	account (string) required
get_v1_accounts_by_account	pRetrieves the details of an account./p	account (string) required expand (array)
post_v1_accounts_by_account	pUpdates 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'contr	account (string) required
post_v1_accounts_by_account_bank_accounts	pCreate an external account for a given account./p	account (string) required
delete_v1_accounts_by_account_bank_accounts_by_id	pDelete a specified external account for a given account./p	account (string) required id (string) required
get_v1_accounts_by_account_bank_accounts_by_id	pRetrieve a specified external account for a given account./p	account (string) required id (string) required expand (array)
post_v1_accounts_by_account_bank_accounts_by_id	pUpdates 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-en	account (string) required id (string) required
get_v1_accounts_by_account_capabilities	pReturns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first./p	account (string) required expand (array)
get_v1_accounts_by_account_capabilities_by_capability	pRetrieves information about the specified Account Capability./p	account (string) required capability (string) required expand (array)
post_v1_accounts_by_account_capabilities_by_capability	pUpdates an existing Account Capability. Request or remove a capability by updating its coderequested/code parameter./p	account (string) required capability (string) required
get_v1_accounts_by_account_external_accounts	pList external accounts for an account./p	account (string) required ending_before (string) expand (array) limit (integer) object (string) starting_after (string)
post_v1_accounts_by_account_external_accounts	pCreate an external account for a given account./p	account (string) required
delete_v1_accounts_by_account_external_accounts_by_id	pDelete a specified external account for a given account./p	account (string) required id (string) required
get_v1_accounts_by_account_external_accounts_by_id	pRetrieve a specified external account for a given account./p	account (string) required id (string) required expand (array)
post_v1_accounts_by_account_external_accounts_by_id	pUpdates 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-en	account (string) required id (string) required
post_v1_accounts_by_account_login_links	pCreates 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./p	account (string) required
get_v1_accounts_by_account_people	pReturns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first./p	account (string) required 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_people	pCreates a new person./p	account (string) required
delete_v1_accounts_by_account_people_by_person	pDeletes 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./p	account (string) required person (string) required
get_v1_accounts_by_account_people_by_person	pRetrieves an existing person./p	account (string) required person (string) required expand (array)
post_v1_accounts_by_account_people_by_person	pUpdates an existing person./p	account (string) required person (string) required
get_v1_accounts_by_account_persons	pReturns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first./p	account (string) required 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_persons	pCreates a new person./p	account (string) required
delete_v1_accounts_by_account_persons_by_person	pDeletes 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./p	account (string) required person (string) required
get_v1_accounts_by_account_persons_by_person	pRetrieves an existing person./p	account (string) required person (string) required expand (array)
post_v1_accounts_by_account_persons_by_person	pUpdates an existing person./p	account (string) required person (string) required
post_v1_accounts_by_account_reject	pWith 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./p	account (string) required
get_v1_apple_pay_domains	pList apple pay domains./p	domain_name (string) ending_before (string) expand (array) limit (integer) starting_after (string)
post_v1_apple_pay_domains	pCreate an apple pay domain./p	No parameters
delete_v1_apple_pay_domains_by_domain	pDelete an apple pay domain./p	domain (string) required
get_v1_apple_pay_domains_by_domain	pRetrieve an apple pay domain./p	domain (string) required expand (array)
get_v1_application_fees	pReturns a list of application fees you’ve previously collected. The application fees are returned in sorted order, with the most recent fees appearing first./p	charge (string) created ending_before (string) expand (array) limit (integer) starting_after (string)
get_v1_application_fees_by_fee_refunds_by_id	pBy default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee./p	fee (string) required id (string) required expand (array)
post_v1_application_fees_by_fee_refunds_by_id	pUpdates 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./p	fee (string) required id (string) required
get_v1_application_fees_by_id	pRetrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee./p	id (string) required expand (array)
post_v1_application_fees_by_id_refund	No description available	id (string) required
get_v1_application_fees_by_id_refunds	pYou 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./p	id (string) required ending_before (string) expand (array) limit (integer) starting_after (string)
post_v1_application_fees_by_id_refunds	pRefunds 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 money	id (string) required
get_v1_apps_secrets	pList all secrets stored on the given scope./p	ending_before (string) expand (array) limit (integer) scope: { . type (string) . user (string) } (object) required starting_after (string)
post_v1_apps_secrets	pCreate or replace a secret in the secret store./p	No parameters
post_v1_apps_secrets_delete	pDeletes a secret from the secret store by name and scope./p	No parameters
get_v1_apps_secrets_find	pFinds a secret in the secret store by name and scope./p	expand (array) name (string) required scope: { . type (string) . user (string) } (object) required
get_v1_balance	pRetrieves the current account balance, based on the authentication that was used to make the request. For a sample request, see a href='/docs/connect/account-balances accounting-for-negative-balances'Accounting for negative balances/a./p	expand (array)
get_v1_balance_history	pReturns 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./p	created currency (string) ending_before (string) expand (array) limit (integer) payout (string) source (string) starting_after (string) type (string)
get_v1_balance_history_by_id	pRetrieves the balance transaction with the given ID./p pNote that this endpoint previously used the path code/v1/balance/history/:id/code./p	id (string) required expand (array)
get_v1_balance_transactions	pReturns 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./p	created currency (string) ending_before (string) expand (array) limit (integer) payout (string) source (string) starting_after (string) type (string)
get_v1_balance_transactions_by_id	pRetrieves the balance transaction with the given ID./p pNote that this endpoint previously used the path code/v1/balance/history/:id/code./p	id (string) required expand (array)
get_v1_billing_alerts	pLists billing active and inactive alerts/p	alert_type (string) ending_before (string) expand (array) limit (integer) meter (string) starting_after (string)
post_v1_billing_alerts	pCreates a billing alert/p	No parameters
get_v1_billing_alerts_by_id	pRetrieves a billing alert given an ID/p	id (string) required expand (array)
post_v1_billing_alerts_by_id_activate	pReactivates this alert, allowing it to trigger again./p	id (string) required
post_v1_billing_alerts_by_id_archive	pArchives this alert, removing it from the list view and APIs. This is non-reversible./p	id (string) required
post_v1_billing_alerts_by_id_deactivate	pDeactivates this alert, preventing it from triggering./p	id (string) required
get_v1_billing_credit_balance_summary	pRetrieves the credit balance summary for a customer./p	customer (string) required expand (array) filter: { . applicability_scope (object) . credit_grant (string) . type (string) } (object) required
get_v1_billing_credit_balance_transactions	pRetrieve a list of credit balance transactions./p	credit_grant (string) customer (string) required ending_before (string) expand (array) limit (integer) starting_after (string)
get_v1_billing_credit_balance_transactions_by_id	pRetrieves a credit balance transaction./p	id (string) required expand (array)
get_v1_billing_credit_grants	pRetrieve a list of credit grants./p	customer (string) ending_before (string) expand (array) limit (integer) starting_after (string)
post_v1_billing_credit_grants	pCreates a credit grant./p	No parameters
get_v1_billing_credit_grants_by_id	pRetrieves a credit grant./p	id (string) required expand (array)
post_v1_billing_credit_grants_by_id	pUpdates a credit grant./p	id (string) required
post_v1_billing_credit_grants_by_id_expire	pExpires a credit grant./p	id (string) required
post_v1_billing_credit_grants_by_id_void	pVoids a credit grant./p	id (string) required
post_v1_billing_meter_event_adjustments	pCreates a billing meter event adjustment./p	No parameters
post_v1_billing_meter_events	pCreates a billing meter event./p	No parameters
get_v1_billing_meters	pRetrieve a list of billing meters./p	ending_before (string) expand (array) limit (integer) starting_after (string) status (string)
post_v1_billing_meters	pCreates a billing meter./p	No parameters
get_v1_billing_meters_by_id	pRetrieves a billing meter given an ID./p	id (string) required expand (array)
post_v1_billing_meters_by_id	pUpdates a billing meter./p	id (string) required
post_v1_billing_meters_by_id_deactivate	pWhen a meter is deactivated, no more meter events will be accepted for this meter. You can’t attach a deactivated meter to a price./p	id (string) required
get_v1_billing_meters_by_id_event_summaries	pRetrieve a list of billing meter event summaries./p	id (string) required 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_reactivate	pWhen a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price./p	id (string) required
get_v1_billing_portal_configurations	pReturns a list of configurations that describe the functionality of the customer portal./p	active (boolean) ending_before (string) expand (array) is_default (boolean) limit (integer) starting_after (string)
post_v1_billing_portal_configurations	pCreates a configuration that describes the functionality and behavior of a PortalSession/p	No parameters
get_v1_billing_portal_configurations_by_configuration	pRetrieves a configuration that describes the functionality of the customer portal./p	configuration (string) required expand (array)
post_v1_billing_portal_configurations_by_configuration	pUpdates a configuration that describes the functionality of the customer portal./p	configuration (string) required
post_v1_billing_portal_sessions	pCreates a session of the customer portal./p	No parameters
get_v1_charges	pReturns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first./p	created customer (string) ending_before (string) expand (array) limit (integer) payment_intent (string) starting_after (string) transfer_group (string)
post_v1_charges	pThis 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./p	No parameters
get_v1_charges_search	pSearch for charges you’ve previously created using Stripe’s a href='/docs/search search-query-language'Search Query Language/a. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India./p	expand (array) limit (integer) page (string) query (string) required
get_v1_charges_by_charge	pRetrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge./p	charge (string) required expand (array)
post_v1_charges_by_charge	pUpdates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged./p	charge (string) required
post_v1_charges_by_charge_capture	pCapture 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./p	charge (string) required
get_v1_charges_by_charge_dispute	pRetrieve a dispute for a specified charge./p	charge (string) required expand (array)
post_v1_charges_by_charge_dispute	No description available	charge (string) required
post_v1_charges_by_charge_dispute_close	No description available	charge (string) required
post_v1_charges_by_charge_refund	pWhen 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 wh	charge (string) required
get_v1_charges_by_charge_refunds	pYou 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./p	charge (string) required ending_before (string) expand (array) limit (integer) starting_after (string)
post_v1_charges_by_charge_refunds	pWhen 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 a	charge (string) required
get_v1_charges_by_charge_refunds_by_refund	pRetrieves the details of an existing refund./p	charge (string) required refund (string) required expand (array)
post_v1_charges_by_charge_refunds_by_refund	pUpdate a specified refund./p	charge (string) required refund (string) required
get_v1_checkout_sessions	pReturns a list of Checkout Sessions./p	created 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_sessions	pCreates a Checkout Session object./p	No parameters
get_v1_checkout_sessions_by_session	pRetrieves a Checkout Session object./p	session (string) required expand (array)
post_v1_checkout_sessions_by_session	pUpdates a Checkout Session object./p pRelated guide: a href='/payments/checkout/dynamic-updates'Dynamically update Checkout/a/p	session (string) required
post_v1_checkout_sessions_by_session_expire	pA 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./p	session (string) required
get_v1_checkout_sessions_by_session_line_items	pWhen 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./p	session (string) required ending_before (string) expand (array) limit (integer) starting_after (string)
get_v1_climate_orders	pLists all Climate order objects. The orders are returned sorted by creation date, with the most recently created orders appearing first./p	ending_before (string) expand (array) limit (integer) starting_after (string)
post_v1_climate_orders	pCreates a Climate order object for a given Climate product. The order will be processed immediately after creation and payment will be deducted your Stripe balance./p	No parameters
get_v1_climate_orders_by_order	pRetrieves the details of a Climate order object with the given ID./p	order (string) required expand (array)
post_v1_climate_orders_by_order	pUpdates the specified order by setting the values of the parameters passed./p	order (string) required
post_v1_climate_orders_by_order_cancel	pCancels 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./p	order (string) required
get_v1_climate_products	pLists all available Climate product objects./p	ending_before (string) expand (array) limit (integer) starting_after (string)
get_v1_climate_products_by_product	pRetrieves the details of a Climate product with the given ID./p	product (string) required expand (array)
get_v1_climate_suppliers	pLists all available Climate supplier objects./p	ending_before (string) expand (array) limit (integer) starting_after (string)
get_v1_climate_suppliers_by_supplier	pRetrieves a Climate supplier object./p	supplier (string) required expand (array)
get_v1_confirmation_tokens_by_confirmation_token	pRetrieves an existing ConfirmationToken object/p	confirmation_token (string) required expand (array)
get_v1_country_specs	pLists all Country Spec objects available in the API./p	ending_before (string) expand (array) limit (integer) starting_after (string)
get_v1_country_specs_by_country	pReturns a Country Spec for a given Country code./p	country (string) required expand (array)
get_v1_coupons	pReturns a list of your coupons./p	created ending_before (string) expand (array) limit (integer) starting_after (string)
post_v1_coupons	pYou 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 tota	No parameters
delete_v1_coupons_by_coupon	pYou can delete coupons via the a href='https://dashboard.stripe.com/coupons'coupon management/a page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can’t redeem the coupon. You can also delete coupons via the API./p	coupon (string) required
get_v1_coupons_by_coupon	pRetrieves the coupon with the given ID./p	coupon (string) required expand (array)
post_v1_coupons_by_coupon	pUpdates the metadata of a coupon. Other coupon details currency, duration, amount_off are, by design, not editable./p	coupon (string) required
get_v1_credit_notes	pReturns a list of credit notes./p	created customer (string) ending_before (string) expand (array) invoice (string) limit (integer) starting_after (string)
post_v1_credit_notes	pIssue 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 liCus	No parameters
get_v1_credit_notes_preview	pGet a preview of a credit note without creating it./p	amount (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_lines	pWhen 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./p	amount (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_lines	pWhen 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./p	credit_note (string) required ending_before (string) expand (array) limit (integer) starting_after (string)
get_v1_credit_notes_by_id	pRetrieves the credit note object with the given identifier./p	id (string) required expand (array)
post_v1_credit_notes_by_id	pUpdates an existing credit note./p	id (string) required
post_v1_credit_notes_by_id_void	pMarks a credit note as void. Learn more about a href='/docs/billing/invoices/credit-notes voiding'voiding credit notes/a./p	id (string) required
post_v1_customer_sessions	pCreates a Customer Session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources./p	No parameters
get_v1_customers	pReturns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first./p	created email (string) ending_before (string) expand (array) limit (integer) starting_after (string) test_clock (string)
post_v1_customers	pCreates a new customer object./p	No parameters
get_v1_customers_search	pSearch for customers you’ve previously created using Stripe’s a href='/docs/search search-query-language'Search Query Language/a. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India./p	expand (array) limit (integer) page (string) query (string) required
delete_v1_customers_by_customer	pPermanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer./p	customer (string) required
get_v1_customers_by_customer	pRetrieves a Customer object./p	customer (string) required expand (array)
post_v1_customers_by_customer	pUpdates 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 codepas	customer (string) required
get_v1_customers_by_customer_balance_transactions	pReturns a list of transactions that updated the customer’s a href='/docs/billing/customer/balance'balances/a./p	customer (string) required ending_before (string) expand (array) limit (integer) starting_after (string)
post_v1_customers_by_customer_balance_transactions	pCreates an immutable transaction that updates the customer’s credit a href='/docs/billing/customer/balance'balance/a./p	customer (string) required
get_v1_customers_by_customer_balance_transactions_by_transaction	pRetrieves a specific customer balance transaction that updated the customer’s a href='/docs/billing/customer/balance'balances/a./p	customer (string) required transaction (string) required expand (array)
post_v1_customers_by_customer_balance_transactions_by_transaction	pMost credit balance transaction fields are immutable, but you may update its codedescription/code and codemetadata/code./p	customer (string) required transaction (string) required
get_v1_customers_by_customer_bank_accounts	pYou 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./p	customer (string) required ending_before (string) expand (array) limit (integer) starting_after (string)
post_v1_customers_by_customer_bank_accounts	pWhen 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./p	customer (string) required
delete_v1_customers_by_customer_bank_accounts_by_id	pDelete a specified source for a given customer./p	customer (string) required id (string) required
get_v1_customers_by_customer_bank_accounts_by_id	pBy default, you can see the 10 most recent sources stored on a Customer directly on the object, but you can also retrieve details about a specific bank account stored on the Stripe account./p	customer (string) required id (string) required expand (array)
post_v1_customers_by_customer_bank_accounts_by_id	pUpdate a specified source for a given customer./p	customer (string) required id (string) required
post_v1_customers_by_customer_bank_accounts_by_id_verify	pVerify a specified bank account for a given customer./p	customer (string) required id (string) required
get_v1_customers_by_customer_cards	pYou 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./p	customer (string) required ending_before (string) expand (array) limit (integer) starting_after (string)
post_v1_customers_by_customer_cards	pWhen 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./p	customer (string) required
delete_v1_customers_by_customer_cards_by_id	pDelete a specified source for a given customer./p	customer (string) required id (string) required
get_v1_customers_by_customer_cards_by_id	pYou can always see the 10 most recent cards directly on a customer; this method lets you retrieve details about a specific card stored on the customer./p	customer (string) required id (string) required expand (array)
post_v1_customers_by_customer_cards_by_id	pUpdate a specified source for a given customer./p	customer (string) required id (string) required
get_v1_customers_by_customer_cash_balance	pRetrieves a customer’s cash balance./p	customer (string) required expand (array)
post_v1_customers_by_customer_cash_balance	pChanges the settings on a customer’s cash balance./p	customer (string) required
get_v1_customers_by_customer_cash_balance_transactions	pReturns a list of transactions that modified the customer’s a href='/docs/payments/customer-balance'cash balance/a./p	customer (string) required ending_before (string) expand (array) limit (integer) starting_after (string)
get_v1_customers_by_customer_cash_balance_transactions_by_transaction	pRetrieves a specific cash balance transaction, which updated the customer’s a href='/docs/payments/customer-balance'cash balance/a./p	customer (string) required transaction (string) required expand (array)
delete_v1_customers_by_customer_discount	pRemoves the currently applied discount on a customer./p	customer (string) required
get_v1_customers_by_customer_discount	No description available	customer (string) required expand (array)
post_v1_customers_by_customer_funding_instructions	pRetrieve 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./p	customer (string) required
get_v1_customers_by_customer_payment_methods	pReturns a list of PaymentMethods for a given Customer/p	customer (string) required allow_redisplay (string) ending_before (string) expand (array) limit (integer) starting_after (string) type (string)
get_v1_customers_by_customer_payment_methods_by_payment_method	pRetrieves a PaymentMethod object for a given Customer./p	customer (string) required payment_method (string) required expand (array)
get_v1_customers_by_customer_sources	pList sources for a specified customer./p	customer (string) required ending_before (string) expand (array) limit (integer) object (string) starting_after (string)
post_v1_customers_by_customer_sources	pWhen 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./p	customer (string) required
delete_v1_customers_by_customer_sources_by_id	pDelete a specified source for a given customer./p	customer (string) required id (string) required
get_v1_customers_by_customer_sources_by_id	pRetrieve a specified source for a given customer./p	customer (string) required id (string) required expand (array)
post_v1_customers_by_customer_sources_by_id	pUpdate a specified source for a given customer./p	customer (string) required id (string) required
post_v1_customers_by_customer_sources_by_id_verify	pVerify a specified bank account for a given customer./p	customer (string) required id (string) required
get_v1_customers_by_customer_subscriptions	pYou can see a list of the customer’s active subscriptions. Note that the 10 most recent active subscriptions are always available by default on the customer object. If you need more than those 10, you can use the limit and starting_after parameters to page through additional subscriptions./p	customer (string) required ending_before (string) expand (array) limit (integer) starting_after (string)
post_v1_customers_by_customer_subscriptions	pCreates a new subscription on an existing customer./p	customer (string) required
delete_v1_customers_by_customer_subscriptions_by_subscription_exposed_id	pCancels 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 of	customer (string) required subscription_exposed_id (string) required
get_v1_customers_by_customer_subscriptions_by_subscription_exposed_id	pRetrieves the subscription with the given ID./p	customer (string) required subscription_exposed_id (string) required expand (array)
post_v1_customers_by_customer_subscriptions_by_subscription_exposed_id	pUpdates 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./p	customer (string) required subscription_exposed_id (string) required
delete_v1_customers_by_customer_subscriptions_by_subscription_exposed_id_discount	pRemoves the currently applied discount on a customer./p	customer (string) required subscription_exposed_id (string) required
get_v1_customers_by_customer_subscriptions_by_subscription_exposed_id_discount	No description available	customer (string) required subscription_exposed_id (string) required expand (array)
get_v1_customers_by_customer_tax_ids	pReturns a list of tax IDs for a customer./p	customer (string) required ending_before (string) expand (array) limit (integer) starting_after (string)
post_v1_customers_by_customer_tax_ids	pCreates a new codetax_id/code object for a customer./p	customer (string) required
delete_v1_customers_by_customer_tax_ids_by_id	pDeletes an existing codetax_id/code object./p	customer (string) required id (string) required
get_v1_customers_by_customer_tax_ids_by_id	pRetrieves the codetax_id/code object with the given identifier./p	customer (string) required id (string) required expand (array)
get_v1_disputes	pReturns a list of your disputes./p	charge (string) created ending_before (string) expand (array) limit (integer) payment_intent (string) starting_after (string)
get_v1_disputes_by_dispute	pRetrieves the dispute with the given ID./p	dispute (string) required expand (array)
post_v1_disputes_by_dispute	pWhen 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, see	dispute (string) required
post_v1_disputes_by_dispute_close	pClosing 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./p	dispute (string) required
get_v1_entitlements_active_entitlements	pRetrieve a list of active entitlements for a customer/p	customer (string) required ending_before (string) expand (array) limit (integer) starting_after (string)
get_v1_entitlements_active_entitlements_by_id	pRetrieve an active entitlement/p	id (string) required expand (array)
get_v1_entitlements_features	pRetrieve a list of features/p	archived (boolean) ending_before (string) expand (array) limit (integer) lookup_key (string) starting_after (string)
post_v1_entitlements_features	pCreates a feature/p	No parameters
get_v1_entitlements_features_by_id	pRetrieves a feature/p	id (string) required expand (array)
post_v1_entitlements_features_by_id	pUpdate a feature’s metadata or permanently deactivate it./p	id (string) required
post_v1_ephemeral_keys	pCreates a short-lived API key for a given resource./p	No parameters
delete_v1_ephemeral_keys_by_key	pInvalidates a short-lived API key for a given resource./p	key (string) required
get_v1_events	pList 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./p	created delivery_success (boolean) ending_before (string) expand (array) limit (integer) starting_after (string) type (string) types (array)
get_v1_events_by_id	pRetrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook./p	id (string) required expand (array)
get_v1_exchange_rates	pReturns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports./p	ending_before (string) expand (array) limit (integer) starting_after (string)
get_v1_exchange_rates_by_rate_id	pRetrieves the exchange rates from the given currency to every supported currency./p	rate_id (string) required expand (array)
post_v1_external_accounts_by_id	pUpdates 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-en	id (string) required
get_v1_file_links	pReturns a list of file links./p	created ending_before (string) expand (array) expired (boolean) file (string) limit (integer) starting_after (string)
post_v1_file_links	pCreates a new file link object./p	No parameters
get_v1_file_links_by_link	pRetrieves the file link with the given ID./p	link (string) required expand (array)
post_v1_file_links_by_link	pUpdates an existing file link object. Expired links can no longer be updated./p	link (string) required
get_v1_files	pReturns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top./p	created ending_before (string) expand (array) limit (integer) purpose (string) starting_after (string)
post_v1_files	pTo 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./p	data: { . expand (array) . file (object) . file_link_data (object) . purpose (string) } (object) required
get_v1_files_by_file	pRetrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to a href='/docs/file-upload download-file-contents'access file contents/a./p	file (string) required expand (array)
get_v1_financial_connections_accounts	pReturns a list of Financial Connections codeAccount/code objects./p	account_holder: { . account (string) . customer (string) } (object) ending_before (string) expand (array) limit (integer) session (string) starting_after (string)
get_v1_financial_connections_accounts_by_account	pRetrieves the details of an Financial Connections codeAccount/code./p	account (string) required expand (array)
post_v1_financial_connections_accounts_by_account_disconnect	pDisables 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./p	account (string) required
get_v1_financial_connections_accounts_by_account_owners	pLists all owners for a given codeAccount/code/p	account (string) required ending_before (string) expand (array) limit (integer) ownership (string) required starting_after (string)
post_v1_financial_connections_accounts_by_account_refresh	pRefreshes the data associated with a Financial Connections codeAccount/code./p	account (string) required
post_v1_financial_connections_accounts_by_account_subscribe	pSubscribes to periodic refreshes of data associated with a Financial Connections codeAccount/code./p	account (string) required
post_v1_financial_connections_accounts_by_account_unsubscribe	pUnsubscribes from periodic refreshes of data associated with a Financial Connections codeAccount/code./p	account (string) required
post_v1_financial_connections_sessions	pTo 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./p	No parameters
get_v1_financial_connections_sessions_by_session	pRetrieves the details of a Financial Connections codeSession/code/p	session (string) required expand (array)
get_v1_financial_connections_transactions	pReturns a list of Financial Connections codeTransaction/code objects./p	account (string) required ending_before (string) expand (array) limit (integer) starting_after (string) transacted_at transaction_refresh: { . after (string) } (object)
get_v1_financial_connections_transactions_by_transaction	pRetrieves the details of a Financial Connections codeTransaction/code/p	transaction (string) required expand (array)
get_v1_forwarding_requests	pLists all ForwardingRequest objects./p	created: { . gt (integer) . gte (integer) . lt (integer) . lte (integer) } (object) ending_before (string) expand (array) limit (integer) starting_after (string)
post_v1_forwarding_requests	pCreates a ForwardingRequest object./p	No parameters
get_v1_forwarding_requests_by_id	pRetrieves a ForwardingRequest object./p	id (string) required expand (array)
get_v1_identity_verification_reports	pList all verification reports./p	client_reference_id (string) created ending_before (string) expand (array) limit (integer) starting_after (string) type (string) verification_session (string)
get_v1_identity_verification_reports_by_report	pRetrieves an existing VerificationReport/p	report (string) required expand (array)
get_v1_identity_verification_sessions	pReturns a list of VerificationSessions/p	client_reference_id (string) created ending_before (string) expand (array) limit (integer) related_customer (string) starting_after (string) status (string)
post_v1_identity_verification_sessions	pCreates 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/p	No parameters
get_v1_identity_verification_sessions_by_session	pRetrieves 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./p	session (string) required expand (array)
post_v1_identity_verification_sessions_by_session	pUpdates a VerificationSession object./p pWhen the session status is coderequires_input/code, you can use this method to update the verification check and options./p	session (string) required
post_v1_identity_verification_sessions_by_session_cancel	pA 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./p	session (string) required
post_v1_identity_verification_sessions_by_session_redact	pRedact 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 u	session (string) required
get_v1_invoice_payments	pWhen retrieving an invoice, there is an includable payments property containing the first handful of those items. There is also a URL where you can retrieve the full paginated list of payments./p	ending_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_payment	pRetrieves the invoice payment with the given ID./p	invoice_payment (string) required expand (array)
get_v1_invoice_rendering_templates	pList all templates, ordered by creation date, with the most recently created template appearing first./p	ending_before (string) expand (array) limit (integer) starting_after (string) status (string)
get_v1_invoice_rendering_templates_by_template	pRetrieves an invoice rendering template with the given ID. It by default returns the latest version of the template. Optionally, specify a version to see previous versions./p	template (string) required expand (array) version (integer)
post_v1_invoice_rendering_templates_by_template_archive	pUpdates 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./p	template (string) required
post_v1_invoice_rendering_templates_by_template_unarchive	pUnarchive an invoice rendering template so it can be used on new Stripe objects again./p	template (string) required
get_v1_invoiceitems	pReturns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first./p	created customer (string) ending_before (string) expand (array) invoice (string) limit (integer) pending (boolean) starting_after (string)
post_v1_invoiceitems	pCreates 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./p	No parameters
delete_v1_invoiceitems_by_invoiceitem	pDeletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they’re not attached to invoices, or if it’s attached to a draft invoice./p	invoiceitem (string) required
get_v1_invoiceitems_by_invoiceitem	pRetrieves the invoice item with the given ID./p	invoiceitem (string) required expand (array)
post_v1_invoiceitems_by_invoiceitem	pUpdates 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./p	invoiceitem (string) required
get_v1_invoices	pYou can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first./p	collection_method (string) created customer (string) due_date ending_before (string) expand (array) limit (integer) starting_after (string) status (string) subscription (string)
post_v1_invoices	pThis 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./p	No parameters
post_v1_invoices_create_preview	pAt 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 calculated	No parameters
get_v1_invoices_search	pSearch for invoices you’ve previously created using Stripe’s a href='/docs/search search-query-language'Search Query Language/a. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India./p	expand (array) limit (integer) page (string) query (string) required
delete_v1_invoices_by_invoice	pPermanently 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./p	invoice (string) required
get_v1_invoices_by_invoice	pRetrieves the invoice with the given ID./p	invoice (string) required expand (array)
post_v1_invoices_by_invoice	pDraft 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./p	invoice (string) required
post_v1_invoices_by_invoice_add_lines	pAdds multiple line items to an invoice. This is only possible when an invoice is still a draft./p	invoice (string) required
post_v1_invoices_by_invoice_attach_payment	pAttaches 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='/d	invoice (string) required
post_v1_invoices_by_invoice_finalize	pStripe 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./p	invoice (string) required
get_v1_invoices_by_invoice_lines	pWhen 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./p	invoice (string) required ending_before (string) expand (array) limit (integer) starting_after (string)
post_v1_invoices_by_invoice_lines_by_line_item_id	pUpdates 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./p	invoice (string) required line_item_id (string) required
post_v1_invoices_by_invoice_mark_uncollectible	pMarking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes./p	invoice (string) required
post_v1_invoices_by_invoice_pay	pStripe 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./p	invoice (string) required
post_v1_invoices_by_invoice_remove_lines	pRemoves multiple line items from an invoice. This is only possible when an invoice is still a draft./p	invoice (string) required
post_v1_invoices_by_invoice_send	pStripe 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./p	invoice (string) required
post_v1_invoices_by_invoice_update_lines	pUpdates multiple line items on an invoice. This is only possible when an invoice is still a draft./p	invoice (string) required
post_v1_invoices_by_invoice_void	pMark 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'credit	invoice (string) required
get_v1_issuing_authorizations	pReturns 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./p	card (string) cardholder (string) created ending_before (string) expand (array) limit (integer) starting_after (string) status (string)
get_v1_issuing_authorizations_by_authorization	pRetrieves an Issuing codeAuthorization/code object./p	authorization (string) required expand (array)
post_v1_issuing_authorizations_by_authorization	pUpdates the specified Issuing codeAuthorization/code object by setting the values of the parameters passed. Any parameters not provided will be left unchanged./p	authorization (string) required
post_v1_issuing_authorizations_by_authorization_approve	pDeprecated 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./p	authorization (string) required
post_v1_issuing_authorizations_by_authorization_decline	pDeprecated 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./p	authorization (string) required
get_v1_issuing_cardholders	pReturns 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./p	created email (string) ending_before (string) expand (array) limit (integer) phone_number (string) starting_after (string) status (string) type (string)
post_v1_issuing_cardholders	pCreates a new Issuing codeCardholder/code object that can be issued cards./p	No parameters
get_v1_issuing_cardholders_by_cardholder	pRetrieves an Issuing codeCardholder/code object./p	cardholder (string) required expand (array)
post_v1_issuing_cardholders_by_cardholder	pUpdates the specified Issuing codeCardholder/code object by setting the values of the parameters passed. Any parameters not provided will be left unchanged./p	cardholder (string) required
get_v1_issuing_cards	pReturns 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./p	cardholder (string) created 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_cards	pCreates an Issuing codeCard/code object./p	No parameters
get_v1_issuing_cards_by_card	pRetrieves an Issuing codeCard/code object./p	card (string) required expand (array)
post_v1_issuing_cards_by_card	pUpdates the specified Issuing codeCard/code object by setting the values of the parameters passed. Any parameters not provided will be left unchanged./p	card (string) required
get_v1_issuing_disputes	pReturns 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./p	created ending_before (string) expand (array) limit (integer) starting_after (string) status (string) transaction (string)
post_v1_issuing_disputes	pCreates 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./p	No parameters
get_v1_issuing_disputes_by_dispute	pRetrieves an Issuing codeDispute/code object./p	dispute (string) required expand (array)
post_v1_issuing_disputes_by_dispute	pUpdates 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./p	dispute (string) required
post_v1_issuing_disputes_by_dispute_submit	pSubmits 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./p	dispute (string) required
get_v1_issuing_personalization_designs	pReturns a list of personalization design objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first./p	ending_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_designs	pCreates a personalization design object./p	No parameters
get_v1_issuing_personalization_designs_by_personalization_design	pRetrieves a personalization design object./p	personalization_design (string) required expand (array)
post_v1_issuing_personalization_designs_by_personalization_design	pUpdates a card personalization object./p	personalization_design (string) required
get_v1_issuing_physical_bundles	pReturns a list of physical bundle objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first./p	ending_before (string) expand (array) limit (integer) starting_after (string) status (string) type (string)
get_v1_issuing_physical_bundles_by_physical_bundle	pRetrieves a physical bundle object./p	physical_bundle (string) required expand (array)
get_v1_issuing_settlements_by_settlement	pRetrieves an Issuing codeSettlement/code object./p	settlement (string) required expand (array)
post_v1_issuing_settlements_by_settlement	pUpdates the specified Issuing codeSettlement/code object by setting the values of the parameters passed. Any parameters not provided will be left unchanged./p	settlement (string) required
get_v1_issuing_tokens	pLists all Issuing codeToken/code objects for a given card./p	card (string) required created ending_before (string) expand (array) limit (integer) starting_after (string) status (string)
get_v1_issuing_tokens_by_token	pRetrieves an Issuing codeToken/code object./p	token (string) required expand (array)
post_v1_issuing_tokens_by_token	pAttempts to update the specified Issuing codeToken/code object to the status specified./p	token (string) required
get_v1_issuing_transactions	pReturns 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./p	card (string) cardholder (string) created ending_before (string) expand (array) limit (integer) starting_after (string) type (string)
get_v1_issuing_transactions_by_transaction	pRetrieves an Issuing codeTransaction/code object./p	transaction (string) required expand (array)
post_v1_issuing_transactions_by_transaction	pUpdates the specified Issuing codeTransaction/code object by setting the values of the parameters passed. Any parameters not provided will be left unchanged./p	transaction (string) required
post_v1_link_account_sessions	pTo 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./p	No parameters
get_v1_link_account_sessions_by_session	pRetrieves the details of a Financial Connections codeSession/code/p	session (string) required expand (array)
get_v1_linked_accounts	pReturns a list of Financial Connections codeAccount/code objects./p	account_holder: { . account (string) . customer (string) } (object) ending_before (string) expand (array) limit (integer) session (string) starting_after (string)
get_v1_linked_accounts_by_account	pRetrieves the details of an Financial Connections codeAccount/code./p	account (string) required expand (array)
post_v1_linked_accounts_by_account_disconnect	pDisables 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./p	account (string) required
get_v1_linked_accounts_by_account_owners	pLists all owners for a given codeAccount/code/p	account (string) required ending_before (string) expand (array) limit (integer) ownership (string) required starting_after (string)
post_v1_linked_accounts_by_account_refresh	pRefreshes the data associated with a Financial Connections codeAccount/code./p	account (string) required
get_v1_mandates_by_mandate	pRetrieves a Mandate object./p	mandate (string) required expand (array)
get_v1_payment_intents	pReturns a list of PaymentIntents./p	created customer (string) ending_before (string) expand (array) limit (integer) starting_after (string)
post_v1_payment_intents	pCreates 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_i	No parameters
get_v1_payment_intents_search	pSearch for PaymentIntents you’ve previously created using Stripe’s a href='/docs/search search-query-language'Search Query Language/a. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India./p	expand (array) limit (integer) page (string) query (string) required
get_v1_payment_intents_by_intent	pRetrieves 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./p	intent (string) required client_secret (string) expand (array)
post_v1_payment_intents_by_intent	pUpdates 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./p	intent (string) required
post_v1_payment_intents_by_intent_apply_customer_balance	pManually reconcile the remaining amount for a codecustomer_balance/code PaymentIntent./p	intent (string) required
post_v1_payment_intents_by_intent_cancel	pYou 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 codeamount	intent (string) required
post_v1_payment_intents_by_intent_capture	pCapture 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./p	intent (string) required
post_v1_payment_intents_by_intent_confirm	pConfirm 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 co	intent (string) required
post_v1_payment_intents_by_intent_increment_authorization	pPerform 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/c	intent (string) required
post_v1_payment_intents_by_intent_verify_microdeposits	pVerifies microdeposits on a PaymentIntent object./p	intent (string) required
get_v1_payment_links	pReturns a list of your payment links./p	active (boolean) ending_before (string) expand (array) limit (integer) starting_after (string)
post_v1_payment_links	pCreates a payment link./p	No parameters
get_v1_payment_links_by_payment_link	pRetrieve a payment link./p	payment_link (string) required expand (array)
post_v1_payment_links_by_payment_link	pUpdates a payment link./p	payment_link (string) required
get_v1_payment_links_by_payment_link_line_items	pWhen 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./p	payment_link (string) required ending_before (string) expand (array) limit (integer) starting_after (string)
get_v1_payment_method_configurations	pList payment method configurations/p	application ending_before (string) expand (array) limit (integer) starting_after (string)
post_v1_payment_method_configurations	pCreates a payment method configuration/p	No parameters
get_v1_payment_method_configurations_by_configuration	pRetrieve payment method configuration/p	configuration (string) required expand (array)
post_v1_payment_method_configurations_by_configuration	pUpdate payment method configuration/p	configuration (string) required
get_v1_payment_method_domains	pLists the details of existing payment method domains./p	domain_name (string) enabled (boolean) ending_before (string) expand (array) limit (integer) starting_after (string)
post_v1_payment_method_domains	pCreates a payment method domain./p	No parameters
get_v1_payment_method_domains_by_payment_method_domain	pRetrieves the details of an existing payment method domain./p	payment_method_domain (string) required expand (array)
post_v1_payment_method_domains_by_payment_method_domain	pUpdates an existing payment method domain./p	payment_method_domain (string) required
post_v1_payment_method_domains_by_payment_method_domain_validate	pSome 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 endpoi	payment_method_domain (string) required
get_v1_payment_methods	pReturns 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./p	customer (string) ending_before (string) expand (array) limit (integer) starting_after (string) type (string)
post_v1_payment_methods	pCreates 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./p	No parameters
get_v1_payment_methods_by_payment_method	pRetrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use a href='/docs/api/payment_methods/customer'Retrieve a Customer’s PaymentMethods/a/p	payment_method (string) required expand (array)
post_v1_payment_methods_by_payment_method	pUpdates a PaymentMethod object. A PaymentMethod must be attached to a customer to be updated./p	payment_method (string) required
post_v1_payment_methods_by_payment_method_attach	pAttaches 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 SetupI	payment_method (string) required
post_v1_payment_methods_by_payment_method_detach	pDetaches 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./p	payment_method (string) required
get_v1_payouts	pReturns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first./p	arrival_date created destination (string) ending_before (string) expand (array) limit (integer) starting_after (string) status (string)
post_v1_payouts	pTo 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 href	No parameters
get_v1_payouts_by_payout	pRetrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information./p	payout (string) required expand (array)
post_v1_payouts_by_payout	pUpdates 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./p	payout (string) required
post_v1_payouts_by_payout_cancel	pYou 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./p	payout (string) required
post_v1_payouts_by_payout_reverse	pReverses 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./p	payout (string) required
get_v1_plans	pReturns a list of your plans./p	active (boolean) created ending_before (string) expand (array) limit (integer) product (string) starting_after (string)
post_v1_plans	pYou 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./p	No parameters
delete_v1_plans_by_plan	pDeleting plans means new subscribers can’t be added. Existing subscribers aren’t affected./p	plan (string) required
get_v1_plans_by_plan	pRetrieves the plan with the given ID./p	plan (string) required expand (array)
post_v1_plans_by_plan	pUpdates 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./p	plan (string) required
get_v1_prices	pReturns 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./p	active (boolean) created 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_prices	pCreates 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./p	No parameters
get_v1_prices_search	pSearch for prices you’ve previously created using Stripe’s a href='/docs/search search-query-language'Search Query Language/a. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India./p	expand (array) limit (integer) page (string) query (string) required
get_v1_prices_by_price	pRetrieves the price with the given ID./p	price (string) required expand (array)
post_v1_prices_by_price	pUpdates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged./p	price (string) required
get_v1_products	pReturns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first./p	active (boolean) created ending_before (string) expand (array) ids (array) limit (integer) shippable (boolean) starting_after (string) url (string)
post_v1_products	pCreates a new product object./p	No parameters
get_v1_products_search	pSearch for products you’ve previously created using Stripe’s a href='/docs/search search-query-language'Search Query Language/a. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India./p	expand (array) limit (integer) page (string) query (string) required
delete_v1_products_by_id	pDelete 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./p	id (string) required
get_v1_products_by_id	pRetrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information./p	id (string) required expand (array)
post_v1_products_by_id	pUpdates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged./p	id (string) required
get_v1_products_by_product_features	pRetrieve a list of features for a product/p	product (string) required ending_before (string) expand (array) limit (integer) starting_after (string)
post_v1_products_by_product_features	pCreates a product_feature, which represents a feature attachment to a product/p	product (string) required
delete_v1_products_by_product_features_by_id	pDeletes the feature attachment to a product/p	id (string) required product (string) required
get_v1_products_by_product_features_by_id	pRetrieves a product_feature, which represents a feature attachment to a product/p	id (string) required product (string) required expand (array)
get_v1_promotion_codes	pReturns a list of your promotion codes./p	active (boolean) code (string) coupon (string) created customer (string) ending_before (string) expand (array) limit (integer) starting_after (string)
post_v1_promotion_codes	pA promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date./p	No parameters
get_v1_promotion_codes_by_promotion_code	pRetrieves 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./p	promotion_code (string) required expand (array)
post_v1_promotion_codes_by_promotion_code	pUpdates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable./p	promotion_code (string) required
get_v1_quotes	pReturns a list of your quotes./p	customer (string) ending_before (string) expand (array) limit (integer) starting_after (string) status (string) test_clock (string)
post_v1_quotes	pA 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./p	No parameters
get_v1_quotes_by_quote	pRetrieves the quote with the given ID./p	quote (string) required expand (array)
post_v1_quotes_by_quote	pA quote models prices and services for a customer./p	quote (string) required
post_v1_quotes_by_quote_accept	pAccepts the specified quote./p	quote (string) required
post_v1_quotes_by_quote_cancel	pCancels the quote./p	quote (string) required
get_v1_quotes_by_quote_computed_upfront_line_items	pWhen 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./p	quote (string) required ending_before (string) expand (array) limit (integer) starting_after (string)
post_v1_quotes_by_quote_finalize	pFinalizes the quote./p	quote (string) required
get_v1_quotes_by_quote_line_items	pWhen 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./p	quote (string) required ending_before (string) expand (array) limit (integer) starting_after (string)
get_v1_quotes_by_quote_pdf	pDownload the PDF for a finalized quote. Explanation for special handling can be found a href='https://docs.stripe.com/quotes/overview quote_pdf'here/a/p	quote (string) required expand (array)
get_v1_radar_early_fraud_warnings	pReturns a list of early fraud warnings./p	charge (string) created ending_before (string) expand (array) limit (integer) payment_intent (string) starting_after (string)
get_v1_radar_early_fraud_warnings_by_early_fraud_warning	pRetrieves 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./p	early_fraud_warning (string) required expand (array)
get_v1_radar_value_list_items	pReturns a list of codeValueListItem/code objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first./p	created ending_before (string) expand (array) limit (integer) starting_after (string) value (string) value_list (string) required
post_v1_radar_value_list_items	pCreates a new codeValueListItem/code object, which is added to the specified parent value list./p	No parameters
delete_v1_radar_value_list_items_by_item	pDeletes a codeValueListItem/code object, removing it from its parent value list./p	item (string) required
get_v1_radar_value_list_items_by_item	pRetrieves a codeValueListItem/code object./p	item (string) required expand (array)
get_v1_radar_value_lists	pReturns a list of codeValueList/code objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first./p	alias (string) contains (string) created ending_before (string) expand (array) limit (integer) starting_after (string)
post_v1_radar_value_lists	pCreates a new codeValueList/code object, which can then be referenced in rules./p	No parameters
delete_v1_radar_value_lists_by_value_list	pDeletes 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./p	value_list (string) required
get_v1_radar_value_lists_by_value_list	pRetrieves a codeValueList/code object./p	value_list (string) required expand (array)
post_v1_radar_value_lists_by_value_list	pUpdates 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./p	value_list (string) required
get_v1_refunds	pReturns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object./p	charge (string) created ending_before (string) expand (array) limit (integer) payment_intent (string) starting_after (string)
post_v1_refunds	pWhen 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 a	No parameters
get_v1_refunds_by_refund	pRetrieves the details of an existing refund./p	refund (string) required expand (array)
post_v1_refunds_by_refund	pUpdates 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./p	refund (string) required
post_v1_refunds_by_refund_cancel	pCancels 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./p	refund (string) required
get_v1_reporting_report_runs	pReturns a list of Report Runs, with the most recent appearing first./p	created ending_before (string) expand (array) limit (integer) starting_after (string)
post_v1_reporting_report_runs	pCreates 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./p	No parameters
get_v1_reporting_report_runs_by_report_run	pRetrieves the details of an existing Report Run./p	report_run (string) required expand (array)
get_v1_reporting_report_types	pReturns a full list of Report Types./p	expand (array)
get_v1_reporting_report_types_by_report_type	pRetrieves the details of a Report Type. Certain report types require a a href='https://stripe.com/docs/keys test-live-modes'live-mode API key/a./p	report_type (string) required expand (array)
get_v1_reviews	pReturns 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./p	created ending_before (string) expand (array) limit (integer) starting_after (string)
get_v1_reviews_by_review	pRetrieves a codeReview/code object./p	review (string) required expand (array)
post_v1_reviews_by_review_approve	pApproves a codeReview/code object, closing it and removing it from the list of reviews./p	review (string) required
get_v1_setup_attempts	pReturns a list of SetupAttempts that associate with a provided SetupIntent./p	created ending_before (string) expand (array) limit (integer) setup_intent (string) required starting_after (string)
get_v1_setup_intents	pReturns a list of SetupIntents./p	attach_to_self (boolean) created customer (string) ending_before (string) expand (array) limit (integer) payment_method (string) starting_after (string)
post_v1_setup_intents	pCreates 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./p	No parameters
get_v1_setup_intents_by_intent	pRetrieves 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./p	intent (string) required client_secret (string) expand (array)
post_v1_setup_intents_by_intent	pUpdates a SetupIntent object./p	intent (string) required
post_v1_setup_intents_by_intent_cancel	pYou 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./p	intent (string) required
post_v1_setup_intents_by_intent_confirm	pConfirm 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_ac	intent (string) required
post_v1_setup_intents_by_intent_verify_microdeposits	pVerifies microdeposits on a SetupIntent object./p	intent (string) required
get_v1_shipping_rates	pReturns a list of your shipping rates./p	active (boolean) created currency (string) ending_before (string) expand (array) limit (integer) starting_after (string)
post_v1_shipping_rates	pCreates a new shipping rate object./p	No parameters
get_v1_shipping_rates_by_shipping_rate_token	pReturns the shipping rate object with the given ID./p	shipping_rate_token (string) required expand (array)
post_v1_shipping_rates_by_shipping_rate_token	pUpdates an existing shipping rate object./p	shipping_rate_token (string) required
post_v1_sigma_saved_queries_by_id	pUpdate an existing Sigma query that previously exists/p	id (string) required
get_v1_sigma_scheduled_query_runs	pReturns a list of scheduled query runs./p	ending_before (string) expand (array) limit (integer) starting_after (string)
get_v1_sigma_scheduled_query_runs_by_scheduled_query_run	pRetrieves the details of an scheduled query run./p	scheduled_query_run (string) required expand (array)
post_v1_sources	pCreates a new source object./p	No parameters
get_v1_sources_by_source	pRetrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information./p	source (string) required client_secret (string) expand (array)
post_v1_sources_by_source	pUpdates 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./p	source (string) required
get_v1_sources_by_source_mandate_notifications_by_mandate_notification	pRetrieves a new Source MandateNotification./p	mandate_notification (string) required source (string) required expand (array)
get_v1_sources_by_source_source_transactions	pList source transactions for a given source./p	source (string) required ending_before (string) expand (array) limit (integer) starting_after (string)
get_v1_sources_by_source_source_transactions_by_source_transaction	pRetrieve an existing source transaction object. Supply the unique source ID from a source creation request and the source transaction ID and Stripe will return the corresponding up-to-date source object information./p	source (string) required source_transaction (string) required expand (array)
post_v1_sources_by_source_verify	pVerify a given source./p	source (string) required
get_v1_subscription_items	pReturns a list of your subscription items for a given subscription./p	ending_before (string) expand (array) limit (integer) starting_after (string) subscription (string) required
post_v1_subscription_items	pAdds a new item to an existing subscription. No existing items will be changed or replaced./p	No parameters
delete_v1_subscription_items_by_item	pDeletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription./p	item (string) required
get_v1_subscription_items_by_item	pRetrieves the subscription item with the given ID./p	item (string) required expand (array)
post_v1_subscription_items_by_item	pUpdates the plan or quantity of an item on a current subscription./p	item (string) required
get_v1_subscription_schedules	pRetrieves the list of your subscription schedules./p	canceled_at completed_at created customer (string) ending_before (string) expand (array) limit (integer) released_at scheduled (boolean) starting_after (string)
post_v1_subscription_schedules	pCreates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions./p	No parameters
get_v1_subscription_schedules_by_schedule	pRetrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation./p	schedule (string) required expand (array)
post_v1_subscription_schedules_by_schedule	pUpdates an existing subscription schedule./p	schedule (string) required
post_v1_subscription_schedules_by_schedule_cancel	pCancels 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./p	schedule (string) required
post_v1_subscription_schedules_by_schedule_release	pReleases 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./p	schedule (string) required
get_v1_subscriptions	pBy default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify codestatus=canceled/code./p	automatic_tax: { . enabled (boolean) } (object) collection_method (string) created current_period_end current_period_start customer (string) ending_before (string) expand (array) limit (integer) price (string) starting_after (string) status (string) test_clock (string)
post_v1_subscriptions	pCreates 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/subscrip	No parameters
get_v1_subscriptions_search	pSearch for subscriptions you’ve previously created using Stripe’s a href='/docs/search search-query-language'Search Query Language/a. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India./p	expand (array) limit (integer) page (string) query (string) required
delete_v1_subscriptions_by_subscription_exposed_id	pCancels 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 the	subscription_exposed_id (string) required
get_v1_subscriptions_by_subscription_exposed_id	pRetrieves the subscription with the given ID./p	subscription_exposed_id (string) required expand (array)
post_v1_subscriptions_by_subscription_exposed_id	pUpdates 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 M	subscription_exposed_id (string) required
delete_v1_subscriptions_by_subscription_exposed_id_discount	pRemoves the currently applied discount on a subscription./p	subscription_exposed_id (string) required
post_v1_subscriptions_by_subscription_migrate	pUpgrade the billing_mode of an existing subscription./p	subscription (string) required
post_v1_subscriptions_by_subscription_resume	pInitiates 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./p	subscription (string) required
post_v1_tax_calculations	pCalculates tax based on the input and returns a Tax codeCalculation/code object./p	No parameters
get_v1_tax_calculations_by_calculation	pRetrieves a Tax codeCalculation/code object, if the calculation hasn’t expired./p	calculation (string) required expand (array)
get_v1_tax_calculations_by_calculation_line_items	pRetrieves the line items of a tax calculation as a collection, if the calculation hasn’t expired./p	calculation (string) required ending_before (string) expand (array) limit (integer) starting_after (string)
get_v1_tax_registrations	pReturns a list of Tax codeRegistration/code objects./p	ending_before (string) expand (array) limit (integer) starting_after (string) status (string)
post_v1_tax_registrations	pCreates a new Tax codeRegistration/code object./p	No parameters
get_v1_tax_registrations_by_id	pReturns a Tax codeRegistration/code object./p	id (string) required expand (array)
post_v1_tax_registrations_by_id	pUpdates 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./p	id (string) required
get_v1_tax_settings	pRetrieves Tax codeSettings/code for a merchant./p	expand (array)
post_v1_tax_settings	pUpdates Tax codeSettings/code parameters used in tax calculations. All parameters are editable but none can be removed once set./p	No parameters
post_v1_tax_transactions_create_from_calculation	pCreates a Tax Transaction from a calculation, if that calculation hasn’t expired. Calculations expire after 90 days./p	No parameters
post_v1_tax_transactions_create_reversal	pPartially or fully reverses a previously created codeTransaction/code./p	No parameters
get_v1_tax_transactions_by_transaction	pRetrieves a Tax codeTransaction/code object./p	transaction (string) required expand (array)
get_v1_tax_transactions_by_transaction_line_items	pRetrieves the line items of a committed standalone transaction as a collection./p	transaction (string) required ending_before (string) expand (array) limit (integer) starting_after (string)
get_v1_tax_codes	pA list of a href='https://stripe.com/docs/tax/tax-categories'all tax codes available/a to add to Products in order to allow specific tax calculations./p	ending_before (string) expand (array) limit (integer) starting_after (string)
get_v1_tax_codes_by_id	pRetrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information./p	id (string) required expand (array)
get_v1_tax_ids	pReturns a list of tax IDs./p	ending_before (string) expand (array) limit (integer) owner: { . account (string) . customer (string) . type (string) } (object) starting_after (string)
post_v1_tax_ids	pCreates a new account or customer codetax_id/code object./p	No parameters
delete_v1_tax_ids_by_id	pDeletes an existing account or customer codetax_id/code object./p	id (string) required
get_v1_tax_ids_by_id	pRetrieves an account or customer codetax_id/code object./p	id (string) required expand (array)
get_v1_tax_rates	pReturns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first./p	active (boolean) created ending_before (string) expand (array) inclusive (boolean) limit (integer) starting_after (string)
post_v1_tax_rates	pCreates a new tax rate./p	No parameters
get_v1_tax_rates_by_tax_rate	pRetrieves a tax rate with the given ID/p	tax_rate (string) required expand (array)
post_v1_tax_rates_by_tax_rate	pUpdates an existing tax rate./p	tax_rate (string) required
get_v1_terminal_configurations	pReturns a list of codeConfiguration/code objects./p	ending_before (string) expand (array) is_account_default (boolean) limit (integer) starting_after (string)
post_v1_terminal_configurations	pCreates a new codeConfiguration/code object./p	No parameters
delete_v1_terminal_configurations_by_configuration	pDeletes a codeConfiguration/code object./p	configuration (string) required
get_v1_terminal_configurations_by_configuration	pRetrieves a codeConfiguration/code object./p	configuration (string) required expand (array)
post_v1_terminal_configurations_by_configuration	pUpdates a new codeConfiguration/code object./p	configuration (string) required
post_v1_terminal_connection_tokens	pTo 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./p	No parameters
get_v1_terminal_locations	pReturns a list of codeLocation/code objects./p	ending_before (string) expand (array) limit (integer) starting_after (string)
post_v1_terminal_locations	pCreates 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./p	No parameters
delete_v1_terminal_locations_by_location	pDeletes a codeLocation/code object./p	location (string) required
get_v1_terminal_locations_by_location	pRetrieves a codeLocation/code object./p	location (string) required expand (array)
post_v1_terminal_locations_by_location	pUpdates a codeLocation/code object by setting the values of the parameters passed. Any parameters not provided will be left unchanged./p	location (string) required
get_v1_terminal_readers	pReturns a list of codeReader/code objects./p	device_type (string) ending_before (string) expand (array) limit (integer) location (string) serial_number (string) starting_after (string) status (string)
post_v1_terminal_readers	pCreates a new codeReader/code object./p	No parameters
delete_v1_terminal_readers_by_reader	pDeletes a codeReader/code object./p	reader (string) required
get_v1_terminal_readers_by_reader	pRetrieves a codeReader/code object./p	reader (string) required expand (array)
post_v1_terminal_readers_by_reader	pUpdates a codeReader/code object by setting the values of the parameters passed. Any parameters not provided will be left unchanged./p	reader (string) required
post_v1_terminal_readers_by_reader_cancel_action	pCancels the current reader action./p	reader (string) required
post_v1_terminal_readers_by_reader_collect_inputs	pInitiates an input collection flow on a Reader./p	reader (string) required
post_v1_terminal_readers_by_reader_collect_payment_method	pInitiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation./p	reader (string) required
post_v1_terminal_readers_by_reader_confirm_payment_intent	pFinalizes a payment on a Reader./p	reader (string) required
post_v1_terminal_readers_by_reader_process_payment_intent	pInitiates a payment flow on a Reader./p	reader (string) required
post_v1_terminal_readers_by_reader_process_setup_intent	pInitiates a setup intent flow on a Reader./p	reader (string) required
post_v1_terminal_readers_by_reader_refund_payment	pInitiates a refund on a Reader/p	reader (string) required
post_v1_terminal_readers_by_reader_set_reader_display	pSets reader display to show cart details./p	reader (string) required
post_v1_test_helpers_confirmation_tokens	pCreates a test mode Confirmation Token server side for your integration tests./p	No parameters
post_v1_test_helpers_customers_by_customer_fund_cash_balance	pCreate an incoming testmode bank transfer/p	customer (string) required
post_v1_test_helpers_issuing_authorizations	pCreate a test-mode authorization./p	No parameters
post_v1_test_helpers_issuing_authorizations_by_authorization_capture	pCapture a test-mode authorization./p	authorization (string) required
post_v1_test_helpers_issuing_authorizations_by_authorization_expire	pExpire a test-mode Authorization./p	authorization (string) required
post_v1_test_helpers_issuing_authorizations_by_authorization_finalize_amount	pFinalize the amount on an Authorization prior to capture, when the initial authorization was for an estimated amount./p	authorization (string) required
post_v1_test_helpers_issuing_authorizations_by_authorization_fraud_challenges_respond	pRespond to a fraud challenge on a testmode Issuing authorization, simulating either a confirmation of fraud or a correction of legitimacy./p	authorization (string) required
post_v1_test_helpers_issuing_authorizations_by_authorization_increment	pIncrement a test-mode Authorization./p	authorization (string) required
post_v1_test_helpers_issuing_authorizations_by_authorization_reverse	pReverse a test-mode Authorization./p	authorization (string) required
post_v1_test_helpers_issuing_cards_by_card_shipping_deliver	pUpdates the shipping status of the specified Issuing codeCard/code object to codedelivered/code./p	card (string) required
post_v1_test_helpers_issuing_cards_by_card_shipping_fail	pUpdates the shipping status of the specified Issuing codeCard/code object to codefailure/code./p	card (string) required
post_v1_test_helpers_issuing_cards_by_card_shipping_return	pUpdates the shipping status of the specified Issuing codeCard/code object to codereturned/code./p	card (string) required
post_v1_test_helpers_issuing_cards_by_card_shipping_ship	pUpdates the shipping status of the specified Issuing codeCard/code object to codeshipped/code./p	card (string) required
post_v1_test_helpers_issuing_cards_by_card_shipping_submit	pUpdates the shipping status of the specified Issuing codeCard/code object to codesubmitted/code. This method requires Stripe Version ‘2024-09-30.acacia’ or later./p	card (string) required
post_v1_test_helpers_issuing_personalization_designs_by_personalization_design_activate	pUpdates the codestatus/code of the specified testmode personalization design object to codeactive/code./p	personalization_design (string) required
post_v1_test_helpers_issuing_personalization_designs_by_personalization_design_deactivate	pUpdates the codestatus/code of the specified testmode personalization design object to codeinactive/code./p	personalization_design (string) required
post_v1_test_helpers_issuing_personalization_designs_by_personalization_design_reject	pUpdates the codestatus/code of the specified testmode personalization design object to coderejected/code./p	personalization_design (string) required
post_v1_test_helpers_issuing_settlements	pAllows the user to create an Issuing settlement./p	No parameters
post_v1_test_helpers_issuing_settlements_by_settlement_complete	pAllows the user to mark an Issuing settlement as complete./p	settlement (string) required
post_v1_test_helpers_issuing_transactions_create_force_capture	pAllows the user to capture an arbitrary amount, also known as a forced capture./p	No parameters
post_v1_test_helpers_issuing_transactions_create_unlinked_refund	pAllows the user to refund an arbitrary amount, also known as a unlinked refund./p	No parameters
post_v1_test_helpers_issuing_transactions_by_transaction_refund	pRefund a test-mode Transaction./p	transaction (string) required
post_v1_test_helpers_refunds_by_refund_expire	pExpire a refund with a status of coderequires_action/code./p	refund (string) required
post_v1_test_helpers_terminal_readers_by_reader_present_payment_method	pPresents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction./p	reader (string) required
post_v1_test_helpers_terminal_readers_by_reader_succeed_input_collection	pUse this endpoint to trigger a successful input collection on a simulated reader./p	reader (string) required
post_v1_test_helpers_terminal_readers_by_reader_timeout_input_collection	pUse this endpoint to complete an input collection with a timeout error on a simulated reader./p	reader (string) required
get_v1_test_helpers_test_clocks	pReturns a list of your test clocks./p	ending_before (string) expand (array) limit (integer) starting_after (string)
post_v1_test_helpers_test_clocks	pCreates a new test clock that can be attached to new customers and quotes./p	No parameters
delete_v1_test_helpers_test_clocks_by_test_clock	pDeletes a test clock./p	test_clock (string) required
get_v1_test_helpers_test_clocks_by_test_clock	pRetrieves a test clock./p	test_clock (string) required expand (array)
post_v1_test_helpers_test_clocks_by_test_clock_advance	pStarts advancing a test clock to a specified time in the future. Advancement is done when status changes to codeReady/code./p	test_clock (string) required
post_v1_test_helpers_treasury_inbound_transfers_by_id_fail	pTransitions a test mode created InboundTransfer to the codefailed/code status. The InboundTransfer must already be in the codeprocessing/code state./p	id (string) required
post_v1_test_helpers_treasury_inbound_transfers_by_id_return	pMarks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the codesucceeded/code state./p	id (string) required
post_v1_test_helpers_treasury_inbound_transfers_by_id_succeed	pTransitions a test mode created InboundTransfer to the codesucceeded/code status. The InboundTransfer must already be in the codeprocessing/code state./p	id (string) required
post_v1_test_helpers_treasury_outbound_payments_by_id	pUpdates 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./p	id (string) required
post_v1_test_helpers_treasury_outbound_payments_by_id_fail	pTransitions a test mode created OutboundPayment to the codefailed/code status. The OutboundPayment must already be in the codeprocessing/code state./p	id (string) required
post_v1_test_helpers_treasury_outbound_payments_by_id_post	pTransitions a test mode created OutboundPayment to the codeposted/code status. The OutboundPayment must already be in the codeprocessing/code state./p	id (string) required
post_v1_test_helpers_treasury_outbound_payments_by_id_return	pTransitions a test mode created OutboundPayment to the codereturned/code status. The OutboundPayment must already be in the codeprocessing/code state./p	id (string) required
post_v1_test_helpers_treasury_outbound_transfers_by_outbound_transfer	pUpdates 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./p	outbound_transfer (string) required
post_v1_test_helpers_treasury_outbound_transfers_by_outbound_transfer_fail	pTransitions a test mode created OutboundTransfer to the codefailed/code status. The OutboundTransfer must already be in the codeprocessing/code state./p	outbound_transfer (string) required
post_v1_test_helpers_treasury_outbound_transfers_by_outbound_transfer_post	pTransitions a test mode created OutboundTransfer to the codeposted/code status. The OutboundTransfer must already be in the codeprocessing/code state./p	outbound_transfer (string) required
post_v1_test_helpers_treasury_outbound_transfers_by_outbound_transfer_return	pTransitions a test mode created OutboundTransfer to the codereturned/code status. The OutboundTransfer must already be in the codeprocessing/code state./p	outbound_transfer (string) required
post_v1_test_helpers_treasury_received_credits	pUse 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./p	No parameters
post_v1_test_helpers_treasury_received_debits	pUse 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./p	No parameters
post_v1_tokens	pCreates 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./p	No parameters
get_v1_tokens_by_token	pRetrieves the token with the given ID./p	token (string) required expand (array)
get_v1_topups	pReturns a list of top-ups./p	amount created ending_before (string) expand (array) limit (integer) starting_after (string) status (string)
post_v1_topups	pTop up the balance of an account/p	No parameters
get_v1_topups_by_topup	pRetrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information./p	topup (string) required expand (array)
post_v1_topups_by_topup	pUpdates the metadata of a top-up. Other top-up details are not editable by design./p	topup (string) required
post_v1_topups_by_topup_cancel	pCancels a top-up. Only pending top-ups can be canceled./p	topup (string) required
get_v1_transfers	pReturns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first./p	created destination (string) ending_before (string) expand (array) limit (integer) starting_after (string) transfer_group (string)
post_v1_transfers	pTo 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./p	No parameters
get_v1_transfers_by_id_reversals	pYou 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./p	id (string) required ending_before (string) expand (array) limit (integer) starting_after (string)
post_v1_transfers_by_id_reversals	pWhen 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./p	id (string) required
get_v1_transfers_by_transfer	pRetrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information./p	transfer (string) required expand (array)
post_v1_transfers_by_transfer	pUpdates 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./p	transfer (string) required
get_v1_transfers_by_transfer_reversals_by_id	pBy default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer./p	id (string) required transfer (string) required expand (array)
post_v1_transfers_by_transfer_reversals_by_id	pUpdates 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./p	id (string) required transfer (string) required
get_v1_treasury_credit_reversals	pReturns a list of CreditReversals./p	ending_before (string) expand (array) financial_account (string) required limit (integer) received_credit (string) starting_after (string) status (string)
post_v1_treasury_credit_reversals	pReverses a ReceivedCredit and creates a CreditReversal object./p	No parameters
get_v1_treasury_credit_reversals_by_credit_reversal	pRetrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list/p	credit_reversal (string) required expand (array)
get_v1_treasury_debit_reversals	pReturns a list of DebitReversals./p	ending_before (string) expand (array) financial_account (string) required limit (integer) received_debit (string) resolution (string) starting_after (string) status (string)
post_v1_treasury_debit_reversals	pReverses a ReceivedDebit and creates a DebitReversal object./p	No parameters
get_v1_treasury_debit_reversals_by_debit_reversal	pRetrieves a DebitReversal object./p	debit_reversal (string) required expand (array)
get_v1_treasury_financial_accounts	pReturns a list of FinancialAccounts./p	created ending_before (string) expand (array) limit (integer) starting_after (string) status (string)
post_v1_treasury_financial_accounts	pCreates a new FinancialAccount. Each connected account can have up to three FinancialAccounts by default./p	No parameters
get_v1_treasury_financial_accounts_by_financial_account	pRetrieves the details of a FinancialAccount./p	financial_account (string) required expand (array)
post_v1_treasury_financial_accounts_by_financial_account	pUpdates the details of a FinancialAccount./p	financial_account (string) required
post_v1_treasury_financial_accounts_by_financial_account_close	pCloses 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./p	financial_account (string) required
get_v1_treasury_financial_accounts_by_financial_account_features	pRetrieves Features information associated with the FinancialAccount./p	financial_account (string) required expand (array)
post_v1_treasury_financial_accounts_by_financial_account_features	pUpdates the Features associated with a FinancialAccount./p	financial_account (string) required
get_v1_treasury_inbound_transfers	pReturns a list of InboundTransfers sent from the specified FinancialAccount./p	ending_before (string) expand (array) financial_account (string) required limit (integer) starting_after (string) status (string)
post_v1_treasury_inbound_transfers	pCreates an InboundTransfer./p	No parameters
get_v1_treasury_inbound_transfers_by_id	pRetrieves the details of an existing InboundTransfer./p	id (string) required expand (array)
post_v1_treasury_inbound_transfers_by_inbound_transfer_cancel	pCancels an InboundTransfer./p	inbound_transfer (string) required
get_v1_treasury_outbound_payments	pReturns a list of OutboundPayments sent from the specified FinancialAccount./p	created customer (string) ending_before (string) expand (array) financial_account (string) required limit (integer) starting_after (string) status (string)
post_v1_treasury_outbound_payments	pCreates an OutboundPayment./p	No parameters
get_v1_treasury_outbound_payments_by_id	pRetrieves the details of an existing OutboundPayment by passing the unique OutboundPayment ID from either the OutboundPayment creation request or OutboundPayment list./p	id (string) required expand (array)
post_v1_treasury_outbound_payments_by_id_cancel	pCancel an OutboundPayment./p	id (string) required
get_v1_treasury_outbound_transfers	pReturns a list of OutboundTransfers sent from the specified FinancialAccount./p	ending_before (string) expand (array) financial_account (string) required limit (integer) starting_after (string) status (string)
post_v1_treasury_outbound_transfers	pCreates an OutboundTransfer./p	No parameters
get_v1_treasury_outbound_transfers_by_outbound_transfer	pRetrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list./p	outbound_transfer (string) required expand (array)
post_v1_treasury_outbound_transfers_by_outbound_transfer_cancel	pAn OutboundTransfer can be canceled if the funds have not yet been paid out./p	outbound_transfer (string) required
get_v1_treasury_received_credits	pReturns a list of ReceivedCredits./p	ending_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_id	pRetrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list./p	id (string) required expand (array)
get_v1_treasury_received_debits	pReturns a list of ReceivedDebits./p	ending_before (string) expand (array) financial_account (string) required limit (integer) starting_after (string) status (string)
get_v1_treasury_received_debits_by_id	pRetrieves the details of an existing ReceivedDebit by passing the unique ReceivedDebit ID from the ReceivedDebit list/p	id (string) required expand (array)
get_v1_treasury_transaction_entries	pRetrieves a list of TransactionEntry objects./p	created effective_at 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_id	pRetrieves a TransactionEntry object./p	id (string) required expand (array)
get_v1_treasury_transactions	pRetrieves a list of Transaction objects./p	created 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_id	pRetrieves the details of an existing Transaction./p	id (string) required expand (array)
get_v1_webhook_endpoints	pReturns a list of your webhook endpoints./p	ending_before (string) expand (array) limit (integer) starting_after (string)
post_v1_webhook_endpoints	pA 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.co	No parameters
delete_v1_webhook_endpoints_by_webhook_endpoint	pYou can also delete webhook endpoints via the a href='https://dashboard.stripe.com/account/webhooks'webhook endpoint management/a page of the Stripe dashboard./p	webhook_endpoint (string) required
get_v1_webhook_endpoints_by_webhook_endpoint	pRetrieves the webhook endpoint with the given ID./p	webhook_endpoint (string) required expand (array)
post_v1_webhook_endpoints_by_webhook_endpoint	pUpdates the webhook endpoint. You may edit the codeurl/code, the list of codeenabled_events/code, and the status of your endpoint./p	webhook_endpoint (string) required
custom	Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body.	_url (string) required _method (string) _query (object) _body _headers (object)