export const comments = { getAccount: { comment: '

Retrieves the details of an account.

', doc: '

Retrieves the details of an account.

', }, postAccountLinks: { comment: '

Creates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow.

', doc: '

Creates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow.

', }, postAccountSessions: { comment: '

Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.

', doc: '

Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.

', }, getAccounts: { comment: '

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

', doc: '

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

', }, postAccounts: { comment: '

With Connect, you can create Stripe accounts for your users.', doc: '

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

\n \n

If you’ve already collected information for your connected accounts, you can prefill that information when\n creating the account. Connect Onboarding won’t ask for the prefilled information during account onboarding.\n You can prefill any information on the account.

', }, deleteAccountsAccount: { comment: '

With Connect, you can delete accounts you manage.

', doc: '

With Connect, you can delete accounts you manage.

\n \n

Test-mode accounts can be deleted at any time.

\n \n

Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all balances are zero.

\n \n

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

', }, getAccountsAccount: { comment: '

Retrieves the details of an account.

', doc: '

Retrieves the details of an account.

', }, postAccountsAccount: { comment: '

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are', doc: '

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

\n \n

For accounts where controller.requirement_collection\n is application, which includes Custom accounts, you can update any information on the account.

\n \n

For accounts where controller.requirement_collection\n is stripe, which includes Standard and Express accounts, you can update all information until you create\n an Account Link or Account Session to start Connect onboarding,\n after which some properties can no longer be updated.

\n \n

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

', }, postAccountsAccountBankAccounts: { comment: '

Create an external account for a given account.

', doc: '

Create an external account for a given account.

', }, deleteAccountsAccountBankAccountsId: { comment: '

Delete a specified external account for a given account.

', doc: '

Delete a specified external account for a given account.

', }, getAccountsAccountBankAccountsId: { comment: '

Retrieve a specified external account for a given account.

', doc: '

Retrieve a specified external account for a given account.

', }, postAccountsAccountBankAccountsId: { comment: '

Updates the metadata, account holder name, account holder type of a bank account belonging to', doc: '

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

\n \n

You can only update bank accounts when account.controller.requirement_collection is application, which includes Custom accounts.

\n \n

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

', }, getAccountsAccountCapabilities: { comment: '

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

', doc: '

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

', }, getAccountsAccountCapabilitiesCapability: { comment: '

Retrieves information about the specified Account Capability.

', doc: '

Retrieves information about the specified Account Capability.

', }, postAccountsAccountCapabilitiesCapability: { comment: '

Updates an existing Account Capability. Request or remove a capability by updating its requested parameter.

', doc: '

Updates an existing Account Capability. Request or remove a capability by updating its requested parameter.

', }, getAccountsAccountExternalAccounts: { comment: '

List external accounts for an account.

', doc: '

List external accounts for an account.

', }, postAccountsAccountExternalAccounts: { comment: '

Create an external account for a given account.

', doc: '

Create an external account for a given account.

', }, deleteAccountsAccountExternalAccountsId: { comment: '

Delete a specified external account for a given account.

', doc: '

Delete a specified external account for a given account.

', }, getAccountsAccountExternalAccountsId: { comment: '

Retrieve a specified external account for a given account.

', doc: '

Retrieve a specified external account for a given account.

', }, postAccountsAccountExternalAccountsId: { comment: '

Updates the metadata, account holder name, account holder type of a bank account belonging to', doc: '

\n \n

You can only update bank accounts when account.controller.requirement_collection is application, which includes Custom accounts.

\n \n

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

', }, postAccountsAccountLoginLinks: { comment: '

Creates a single-use login link for a connected account to access the Express Dashboard.

', doc: '

Creates a single-use login link for a connected account to access the Express Dashboard.

\n \n

You can only create login links for accounts that use the Express Dashboard and are connected to your platform.

', }, getAccountsAccountPeople: { comment: '

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

', doc: '

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

', }, postAccountsAccountPeople: { comment: '

Creates a new person.

', doc: '

Creates a new person.

', }, deleteAccountsAccountPeoplePerson: { comment: '

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

', doc: '

', }, getAccountsAccountPeoplePerson: { comment: '

Retrieves an existing person.

', doc: '

Retrieves an existing person.

', }, postAccountsAccountPeoplePerson: { comment: '

Updates an existing person.

', doc: '

Updates an existing person.

', }, getAccountsAccountPersons: { comment: '

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

', doc: '

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

', }, postAccountsAccountPersons: { comment: '

Creates a new person.

', doc: '

Creates a new person.

', }, deleteAccountsAccountPersonsPerson: { comment: '

', doc: '

', }, getAccountsAccountPersonsPerson: { comment: '

Retrieves an existing person.

', doc: '

Retrieves an existing person.

', }, postAccountsAccountPersonsPerson: { comment: '

Updates an existing person.

', doc: '

Updates an existing person.

', }, postAccountsAccountReject: { comment: '

With Connect, you can reject accounts that you have flagged as suspicious.

', doc: '

With Connect, you can reject accounts that you have flagged as suspicious.

\n \n

Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.

', }, getApplePayDomains: { comment: '

List apple pay domains.

', doc: '

List apple pay domains.

', }, postApplePayDomains: { comment: '

Create an apple pay domain.

', doc: '

Create an apple pay domain.

', }, deleteApplePayDomainsDomain: { comment: '

Delete an apple pay domain.

', doc: '

Delete an apple pay domain.

', }, getApplePayDomainsDomain: { comment: '

Retrieve an apple pay domain.

', doc: '

Retrieve an apple pay domain.

', }, getApplicationFees: { comment: '

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

', doc: '

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

', }, getApplicationFeesFeeRefundsId: { comment: '

By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.

', doc: '

By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.

', }, postApplicationFeesFeeRefundsId: { comment: '

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

', doc: '

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

\n \n

This request only accepts metadata as an argument.

', }, getApplicationFeesId: { comment: '

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

', doc: '

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

', }, getApplicationFeesIdRefunds: { comment: '

You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

', doc: '

', }, postApplicationFeesIdRefunds: { comment: '

Refunds an application fee that has previously been collected but not yet refunded.', doc: '

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

\n \n

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

\n \n

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

', }, getAppsSecrets: { comment: '

List all secrets stored on the given scope.

', doc: '

List all secrets stored on the given scope.

', }, postAppsSecrets: { comment: '

Create or replace a secret in the secret store.

', doc: '

Create or replace a secret in the secret store.

', }, postAppsSecretsDelete: { comment: '

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

', doc: '

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

', }, getAppsSecretsFind: { comment: '

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

', doc: '

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

', }, getBalance: { comment: '

Retrieves the current account balance, based on the authentication that was used to make the request.', doc: '

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

', }, getBalanceHistory: { comment: '

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

', doc: '

\n \n

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

', }, getBalanceHistoryId: { comment: '

Retrieves the balance transaction with the given ID.

', doc: '

Retrieves the balance transaction with the given ID.

\n \n

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

', }, getBalanceTransactions: { comment: '

', doc: '

\n \n

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

', }, getBalanceTransactionsId: { comment: '

Retrieves the balance transaction with the given ID.

', doc: '

Retrieves the balance transaction with the given ID.

\n \n

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

', }, postBillingMeterEventAdjustments: { comment: '

Creates a billing meter event adjustment

', doc: '

Creates a billing meter event adjustment

', }, postBillingMeterEvents: { comment: '

Creates a billing meter event

', doc: '

Creates a billing meter event

', }, getBillingMeters: { comment: '

Retrieve a list of billing meters.

', doc: '

Retrieve a list of billing meters.

', }, postBillingMeters: { comment: '

Creates a billing meter

', doc: '

Creates a billing meter

', }, getBillingMetersId: { comment: '

Retrieves a billing meter given an ID

', doc: '

Retrieves a billing meter given an ID

', }, postBillingMetersId: { comment: '

Updates a billing meter

', doc: '

Updates a billing meter

', }, postBillingMetersIdDeactivate: { comment: '

Deactivates a billing meter

', doc: '

Deactivates a billing meter

', }, getBillingMetersIdEventSummaries: { comment: '

Retrieve a list of billing meter event summaries.

', doc: '

Retrieve a list of billing meter event summaries.

', }, postBillingMetersIdReactivate: { comment: '

Reactivates a billing meter

', doc: '

Reactivates a billing meter

', }, getBillingPortalConfigurations: { comment: '

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

', doc: '

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

', }, postBillingPortalConfigurations: { comment: '

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

', doc: '

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

', }, getBillingPortalConfigurationsConfiguration: { comment: '

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

', doc: '

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

', }, postBillingPortalConfigurationsConfiguration: { comment: '

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

', doc: '

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

', }, postBillingPortalSessions: { comment: '

Creates a session of the customer portal.

', doc: '

Creates a session of the customer portal.

', }, getCharges: { comment: '

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

', doc: '

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

', }, postCharges: { comment: '

This method is no longer recommended—use the Payment Intents API', doc: '

This method is no longer recommended—use the Payment Intents API\n to initiate a new payment instead. Confirmation of the PaymentIntent creates the Charge\n object used to request payment.

', }, getChargesSearch: { comment: '

Search for charges you’ve previously created using Stripe’s Search Query Language.', doc: '

Search for charges you’ve previously created using Stripe’s Search Query Language.\n Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\n conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\n to an hour behind during outages. Search functionality is not available to merchants in India.

', }, getChargesCharge: { comment: '

Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.

', doc: '

', }, postChargesCharge: { comment: '

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

', doc: '

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

', }, postChargesChargeCapture: { comment: '

Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.

', doc: '

Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.

\n \n

Uncaptured payments expire a set number of days after they are created (7 by default), after which they are marked as refunded and capture attempts will fail.

\n \n

Don’t use this method to capture a PaymentIntent-initiated charge. Use Capture a PaymentIntent.

', }, getChargesChargeDispute: { comment: '

Retrieve a dispute for a specified charge.

', doc: '

Retrieve a dispute for a specified charge.

', }, postChargesChargeRefund: { comment: '

When you create a new refund, you must specify either a Charge or a PaymentIntent object.

', doc: '

When you create a new refund, you must specify either a Charge or a PaymentIntent object.

\n \n

This action refunds a previously created charge that’s not refunded yet.\n Funds are refunded to the credit or debit card that’s originally charged.

\n \n

You can optionally refund only part of a charge.\n You can repeat this until the entire charge is refunded.

\n \n

After you entirely refund a charge, you can’t refund it again.\n This method raises an error when it’s called on an already-refunded charge,\n or when you attempt to refund more money than is left on a charge.

', }, getChargesChargeRefunds: { comment: '

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

', doc: '

', }, postChargesChargeRefunds: { comment: '

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

', doc: '

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

\n \n

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

\n \n

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

\n \n

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

', }, getChargesChargeRefundsRefund: { comment: '

Retrieves the details of an existing refund.

', doc: '

Retrieves the details of an existing refund.

', }, postChargesChargeRefundsRefund: { comment: '

Update a specified refund.

', doc: '

Update a specified refund.

', }, getCheckoutSessions: { comment: '

Returns a list of Checkout Sessions.

', doc: '

Returns a list of Checkout Sessions.

', }, postCheckoutSessions: { comment: '

Creates a Session object.

', doc: '

Creates a Session object.

', }, getCheckoutSessionsSession: { comment: '

Retrieves a Session object.

', doc: '

Retrieves a Session object.

', }, postCheckoutSessionsSessionExpire: { comment: '

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

', doc: '

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

\n \n

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

', }, getCheckoutSessionsSessionLineItems: { comment: '

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

', doc: '

', }, getClimateOrders: { comment: '

Lists all Climate order objects. The orders are returned sorted by creation date, with the', doc: '

Lists all Climate order objects. The orders are returned sorted by creation date, with the\n most recently created orders appearing first.

', }, postClimateOrders: { comment: '

Creates a Climate order object for a given Climate product. The order will be processed immediately', doc: '

Creates a Climate order object for a given Climate product. The order will be processed immediately\n after creation and payment will be deducted your Stripe balance.

', }, getClimateOrdersOrder: { comment: '

Retrieves the details of a Climate order object with the given ID.

', doc: '

Retrieves the details of a Climate order object with the given ID.

', }, postClimateOrdersOrder: { comment: '

Updates the specified order by setting the values of the parameters passed.

', doc: '

Updates the specified order by setting the values of the parameters passed.

', }, postClimateOrdersOrderCancel: { comment: '

Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the', doc: '

Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the\n reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier\n might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe\n provides 90 days advance notice and refunds the amount_total.

', }, getClimateProducts: { comment: '

Lists all available Climate product objects.

', doc: '

Lists all available Climate product objects.

', }, getClimateProductsProduct: { comment: '

Retrieves the details of a Climate product with the given ID.

', doc: '

Retrieves the details of a Climate product with the given ID.

', }, getClimateSuppliers: { comment: '

Lists all available Climate supplier objects.

', doc: '

Lists all available Climate supplier objects.

', }, getClimateSuppliersSupplier: { comment: '

Retrieves a Climate supplier object.

', doc: '

Retrieves a Climate supplier object.

', }, getConfirmationTokensConfirmationToken: { comment: '

Retrieves an existing ConfirmationToken object

', doc: '

Retrieves an existing ConfirmationToken object

', }, getCountrySpecs: { comment: '

Lists all Country Spec objects available in the API.

', doc: '

Lists all Country Spec objects available in the API.

', }, getCountrySpecsCountry: { comment: '

Returns a Country Spec for a given Country code.

', doc: '

Returns a Country Spec for a given Country code.

', }, getCoupons: { comment: '

Returns a list of your coupons.

', doc: '

Returns a list of your coupons.

', }, postCoupons: { comment: '

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

', doc: '

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

\n \n

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

', }, deleteCouponsCoupon: { comment: '

You can delete coupons via the coupon management page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can’t redeem the coupon. You can also delete coupons via the API.

', doc: '

', }, getCouponsCoupon: { comment: '

Retrieves the coupon with the given ID.

', doc: '

Retrieves the coupon with the given ID.

', }, postCouponsCoupon: { comment: '

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

', doc: '

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

', }, getCreditNotes: { comment: '

Returns a list of credit notes.

', doc: '

Returns a list of credit notes.

', }, postCreditNotes: { comment: '

Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces', doc: '

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

\n \n

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

\n \n

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

\n \n

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

', }, getCreditNotesPreview: { comment: '

Get a preview of a credit note without creating it.

', doc: '

Get a preview of a credit note without creating it.

', }, getCreditNotesPreviewLines: { comment: '

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

', doc: '

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

', }, getCreditNotesCreditNoteLines: { comment: '

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

', doc: '

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

', }, getCreditNotesId: { comment: '

Retrieves the credit note object with the given identifier.

', doc: '

Retrieves the credit note object with the given identifier.

', }, postCreditNotesId: { comment: '

Updates an existing credit note.

', doc: '

Updates an existing credit note.

', }, postCreditNotesIdVoid: { comment: '

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

', doc: '

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

', }, postCustomerSessions: { comment: '

Creates a customer session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.

', doc: '

Creates a customer session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.

', }, getCustomers: { comment: '

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

', doc: '

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

', }, postCustomers: { comment: '

Creates a new customer object.

', doc: '

Creates a new customer object.

', }, getCustomersSearch: { comment: '

Search for customers you’ve previously created using Stripe’s Search Query Language.', doc: '

Search for customers you’ve previously created using Stripe’s Search Query Language.\n Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\n conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\n to an hour behind during outages. Search functionality is not available to merchants in India.

', }, deleteCustomersCustomer: { comment: '

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

', doc: '

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

', }, getCustomersCustomer: { comment: '

Retrieves a Customer object.

', doc: '

Retrieves a Customer object.

', }, postCustomersCustomer: { comment: '

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

', doc: '

\n \n

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

', }, getCustomersCustomerBalanceTransactions: { comment: '

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

', doc: '

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

', }, postCustomersCustomerBalanceTransactions: { comment: '

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

', doc: '

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

', }, getCustomersCustomerBalanceTransactionsTransaction: { comment: '

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

', doc: '

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

', }, postCustomersCustomerBalanceTransactionsTransaction: { comment: '

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

', doc: '

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

', }, getCustomersCustomerBankAccounts: { comment: '@deprecated', doc: '@deprecated\n

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

', }, postCustomersCustomerBankAccounts: { comment: '

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

', doc: '

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

\n \n

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

', }, deleteCustomersCustomerBankAccountsId: { comment: '

Delete a specified source for a given customer.

', doc: '

Delete a specified source for a given customer.

', }, getCustomersCustomerBankAccountsId: { comment: '@deprecated', doc: '@deprecated\n

By default, you can see the 10 most recent sources stored on a Customer directly on the object, but you can also retrieve details about a specific bank account stored on the Stripe account.

', }, postCustomersCustomerBankAccountsId: { comment: '

Update a specified source for a given customer.

', doc: '

Update a specified source for a given customer.

', }, postCustomersCustomerBankAccountsIdVerify: { comment: '

Verify a specified bank account for a given customer.

', doc: '

Verify a specified bank account for a given customer.

', }, getCustomersCustomerCards: { comment: '@deprecated', doc: '@deprecated\n

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

', }, postCustomersCustomerCards: { comment: '

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

', doc: '

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

\n \n

', }, deleteCustomersCustomerCardsId: { comment: '

Delete a specified source for a given customer.

', doc: '

Delete a specified source for a given customer.

', }, getCustomersCustomerCardsId: { comment: '@deprecated', doc: '@deprecated\n

You can always see the 10 most recent cards directly on a customer; this method lets you retrieve details about a specific card stored on the customer.

', }, postCustomersCustomerCardsId: { comment: '

Update a specified source for a given customer.

', doc: '

Update a specified source for a given customer.

', }, getCustomersCustomerCashBalance: { comment: '

Retrieves a customer’s cash balance.

', doc: '

Retrieves a customer’s cash balance.

', }, postCustomersCustomerCashBalance: { comment: '

Changes the settings on a customer’s cash balance.

', doc: '

Changes the settings on a customer’s cash balance.

', }, getCustomersCustomerCashBalanceTransactions: { comment: '

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

', doc: '

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

', }, getCustomersCustomerCashBalanceTransactionsTransaction: { comment: '

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

', doc: '

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

', }, deleteCustomersCustomerDiscount: { comment: '

Removes the currently applied discount on a customer.

', doc: '

Removes the currently applied discount on a customer.

', }, postCustomersCustomerFundingInstructions: { comment: '

Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new', doc: '

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

', }, getCustomersCustomerPaymentMethods: { comment: '

Returns a list of PaymentMethods for a given Customer

', doc: '

Returns a list of PaymentMethods for a given Customer

', }, getCustomersCustomerPaymentMethodsPaymentMethod: { comment: '

Retrieves a PaymentMethod object for a given Customer.

', doc: '

Retrieves a PaymentMethod object for a given Customer.

', }, getCustomersCustomerSources: { comment: '

List sources for a specified customer.

', doc: '

List sources for a specified customer.

', }, postCustomersCustomerSources: { comment: '

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

', doc: '

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

\n \n

', }, deleteCustomersCustomerSourcesId: { comment: '

Delete a specified source for a given customer.

', doc: '

Delete a specified source for a given customer.

', }, getCustomersCustomerSourcesId: { comment: '

Retrieve a specified source for a given customer.

', doc: '

Retrieve a specified source for a given customer.

', }, postCustomersCustomerSourcesId: { comment: '

Update a specified source for a given customer.

', doc: '

Update a specified source for a given customer.

', }, postCustomersCustomerSourcesIdVerify: { comment: '

Verify a specified bank account for a given customer.

', doc: '

Verify a specified bank account for a given customer.

', }, getCustomersCustomerSubscriptions: { comment: '

You can see a list of the customer’s active subscriptions. Note that the 10 most recent active subscriptions are always available by default on the customer object. If you need more than those 10, you can use the limit and starting_after parameters to page through additional subscriptions.

', doc: '

', }, postCustomersCustomerSubscriptions: { comment: '

Creates a new subscription on an existing customer.

', doc: '

Creates a new subscription on an existing customer.

', }, deleteCustomersCustomerSubscriptionsSubscriptionExposedId: { comment: '

Cancels a customer’s subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default false value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription.

', doc: '

\n \n

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

\n \n

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

', }, getCustomersCustomerSubscriptionsSubscriptionExposedId: { comment: '

Retrieves the subscription with the given ID.

', doc: '

Retrieves the subscription with the given ID.

', }, postCustomersCustomerSubscriptionsSubscriptionExposedId: { comment: '

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

', doc: '

', }, deleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount: { comment: '

Removes the currently applied discount on a customer.

', doc: '

Removes the currently applied discount on a customer.

', }, getCustomersCustomerTaxIds: { comment: '

Returns a list of tax IDs for a customer.

', doc: '

Returns a list of tax IDs for a customer.

', }, postCustomersCustomerTaxIds: { comment: '

Creates a new tax_id object for a customer.

', doc: '

Creates a new tax_id object for a customer.

', }, deleteCustomersCustomerTaxIdsId: { comment: '

Deletes an existing tax_id object.

', doc: '

Deletes an existing tax_id object.

', }, getCustomersCustomerTaxIdsId: { comment: '

Retrieves the tax_id object with the given identifier.

', doc: '

Retrieves the tax_id object with the given identifier.

', }, getDisputes: { comment: '

Returns a list of your disputes.

', doc: '

Returns a list of your disputes.

', }, getDisputesDispute: { comment: '

Retrieves the dispute with the given ID.

', doc: '

Retrieves the dispute with the given ID.

', }, postDisputesDispute: { comment: '

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

', doc: '

\n \n

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

', }, postDisputesDisputeClose: { comment: '

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

', doc: '

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

\n \n

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

', }, getEntitlementsActiveEntitlements: { comment: '

Retrieve a list of active entitlements for a customer

', doc: '

Retrieve a list of active entitlements for a customer

', }, getEntitlementsActiveEntitlementsId: { comment: '

Retrieve an active entitlement

', doc: '

Retrieve an active entitlement

', }, getEntitlementsFeatures: { comment: '

Retrieve a list of features

', doc: '

Retrieve a list of features

', }, postEntitlementsFeatures: { comment: '

Creates a feature

', doc: '

Creates a feature

', }, getEntitlementsFeaturesId: { comment: '

Retrieves a feature

', doc: '

Retrieves a feature

', }, postEntitlementsFeaturesId: { comment: '

Update a feature’s metadata or permanently deactivate it.

', doc: '

Update a feature’s metadata or permanently deactivate it.

', }, postEphemeralKeys: { comment: '

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

', doc: '

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

', }, deleteEphemeralKeysKey: { comment: '

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

', doc: '

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

', }, getEvents: { comment: '

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

', doc: '

', }, getEventsId: { comment: '

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

', doc: '

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

', }, getExchangeRates: { comment: '

Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.

', doc: '

Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.

', }, getExchangeRatesRateId: { comment: '

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

', doc: '

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

', }, getFileLinks: { comment: '

Returns a list of file links.

', doc: '

Returns a list of file links.

', }, postFileLinks: { comment: '

Creates a new file link object.

', doc: '

Creates a new file link object.

', }, getFileLinksLink: { comment: '

Retrieves the file link with the given ID.

', doc: '

Retrieves the file link with the given ID.

', }, postFileLinksLink: { comment: '

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

', doc: '

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

', }, getFiles: { comment: '

Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.

', doc: '

Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.

', }, postFiles: { comment: '

To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.

', doc: '

To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.

\n \n

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

', }, getFilesFile: { comment: '

Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to access file contents.

', doc: '

Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to access file contents.

', }, getFinancialConnectionsAccounts: { comment: '

Returns a list of Financial Connections Account objects.

', doc: '

Returns a list of Financial Connections Account objects.

', }, getFinancialConnectionsAccountsAccount: { comment: '

Retrieves the details of an Financial Connections Account.

', doc: '

Retrieves the details of an Financial Connections Account.

', }, postFinancialConnectionsAccountsAccountDisconnect: { comment: '

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

', doc: '

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

', }, getFinancialConnectionsAccountsAccountOwners: { comment: '

Lists all owners for a given Account

', doc: '

Lists all owners for a given Account

', }, postFinancialConnectionsAccountsAccountRefresh: { comment: '

Refreshes the data associated with a Financial Connections Account.

', doc: '

Refreshes the data associated with a Financial Connections Account.

', }, postFinancialConnectionsAccountsAccountSubscribe: { comment: '

Subscribes to periodic refreshes of data associated with a Financial Connections Account.

', doc: '

Subscribes to periodic refreshes of data associated with a Financial Connections Account.

', }, postFinancialConnectionsAccountsAccountUnsubscribe: { comment: '

Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.

', doc: '

Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.

', }, postFinancialConnectionsSessions: { comment: '

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

', doc: '

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

', }, getFinancialConnectionsSessionsSession: { comment: '

Retrieves the details of a Financial Connections Session

', doc: '

Retrieves the details of a Financial Connections Session

', }, getFinancialConnectionsTransactions: { comment: '

Returns a list of Financial Connections Transaction objects.

', doc: '

Returns a list of Financial Connections Transaction objects.

', }, getFinancialConnectionsTransactionsTransaction: { comment: '

Retrieves the details of a Financial Connections Transaction

', doc: '

Retrieves the details of a Financial Connections Transaction

', }, getForwardingRequests: { comment: '

Lists all ForwardingRequest objects.

', doc: '

Lists all ForwardingRequest objects.

', }, postForwardingRequests: { comment: '

Creates a ForwardingRequest object.

', doc: '

Creates a ForwardingRequest object.

', }, getForwardingRequestsId: { comment: '

Retrieves a ForwardingRequest object.

', doc: '

Retrieves a ForwardingRequest object.

', }, getIdentityVerificationReports: { comment: '

List all verification reports.

', doc: '

List all verification reports.

', }, getIdentityVerificationReportsReport: { comment: '

Retrieves an existing VerificationReport

', doc: '

Retrieves an existing VerificationReport

', }, getIdentityVerificationSessions: { comment: '

Returns a list of VerificationSessions

', doc: '

Returns a list of VerificationSessions

', }, postIdentityVerificationSessions: { comment: '

Creates a VerificationSession object.

', doc: '

Creates a VerificationSession object.

\n \n

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

\n \n

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

\n \n

', }, getIdentityVerificationSessionsSession: { comment: '

Retrieves the details of a VerificationSession that was previously created.

', doc: '

Retrieves the details of a VerificationSession that was previously created.

\n \n

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

', }, postIdentityVerificationSessionsSession: { comment: '

Updates a VerificationSession object.

', doc: '

Updates a VerificationSession object.

\n \n

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

', }, postIdentityVerificationSessionsSessionCancel: { comment: '

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

', doc: '

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

\n \n

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

', }, postIdentityVerificationSessionsSessionRedact: { comment: '

Redact a VerificationSession to remove all collected information from Stripe. This will redact', doc: '

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

\n \n

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

\n \n

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

\n \n

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

\n \n

Learn more.

', }, getInvoiceitems: { comment: '

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

', doc: '

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

', }, postInvoiceitems: { comment: '

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

', doc: '

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

', }, deleteInvoiceitemsInvoiceitem: { comment: '

Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they’re not attached to invoices, or if it’s attached to a draft invoice.

', doc: '

Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they’re not attached to invoices, or if it’s attached to a draft invoice.

', }, getInvoiceitemsInvoiceitem: { comment: '

Retrieves the invoice item with the given ID.

', doc: '

Retrieves the invoice item with the given ID.

', }, postInvoiceitemsInvoiceitem: { comment: '

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

', doc: '

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

', }, getInvoices: { comment: '

You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.

', doc: '

You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.

', }, postInvoices: { comment: '

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

', doc: '

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

', }, postInvoicesCreatePreview: { comment: '

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

', doc: '

\n \n

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

\n \n

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

\n \n

Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. Learn more

', }, getInvoicesSearch: { comment: '

Search for invoices you’ve previously created using Stripe’s Search Query Language.', doc: '

Search for invoices you’ve previously created using Stripe’s Search Query Language.\n Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\n conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\n to an hour behind during outages. Search functionality is not available to merchants in India.

', }, getInvoicesUpcoming: { comment: '

', doc: '

\n \n

Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. Learn more

', }, getInvoicesUpcomingLines: { comment: '

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

', doc: '

', }, deleteInvoicesInvoice: { comment: '

Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be voided.

', doc: '

', }, getInvoicesInvoice: { comment: '

Retrieves the invoice with the given ID.

', doc: '

Retrieves the invoice with the given ID.

', }, postInvoicesInvoice: { comment: '

Draft invoices are fully editable. Once an invoice is finalized,', doc: '

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

\n \n

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

', }, postInvoicesInvoiceFinalize: { comment: '

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

', doc: '

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

', }, getInvoicesInvoiceLines: { comment: '

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

', doc: '

', }, postInvoicesInvoiceLinesLineItemId: { comment: '

Updates an invoice’s line item. Some fields, such as tax_amounts, only live on the invoice line item,', doc: '

Updates an invoice’s line item. Some fields, such as tax_amounts, only live on the invoice line item,\n so they can only be updated through this endpoint. Other fields, such as amount, live on both the invoice\n item and the invoice line item, so updates on this endpoint will propagate to the invoice item as well.\n Updating an invoice’s line item is only possible before the invoice is finalized.

', }, postInvoicesInvoiceMarkUncollectible: { comment: '

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

', doc: '

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

', }, postInvoicesInvoicePay: { comment: '

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

', doc: '

', }, postInvoicesInvoiceSend: { comment: '

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

', doc: '

\n \n

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

', }, postInvoicesInvoiceVoid: { comment: '

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

', doc: '

\n \n

Consult 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 issue another invoice or credit note instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.

', }, getIssuingAuthorizations: { comment: '

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

', doc: '

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

', }, getIssuingAuthorizationsAuthorization: { comment: '

Retrieves an Issuing Authorization object.

', doc: '

Retrieves an Issuing Authorization object.

', }, postIssuingAuthorizationsAuthorization: { comment: '

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

', doc: '

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

', }, postIssuingAuthorizationsAuthorizationApprove: { comment: '@deprecated', doc: '@deprecated\n

[Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow.\n This method is deprecated. Instead, respond directly to the webhook request to approve an authorization.

', }, postIssuingAuthorizationsAuthorizationDecline: { comment: '@deprecated', doc: '@deprecated\n

[Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow.\n This method is deprecated. Instead, respond directly to the webhook request to decline an authorization.

', }, getIssuingCardholders: { comment: '

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

', doc: '

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

', }, postIssuingCardholders: { comment: '

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

', doc: '

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

', }, getIssuingCardholdersCardholder: { comment: '

Retrieves an Issuing Cardholder object.

', doc: '

Retrieves an Issuing Cardholder object.

', }, postIssuingCardholdersCardholder: { comment: '

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

', doc: '

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

', }, getIssuingCards: { comment: '

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

', doc: '

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

', }, postIssuingCards: { comment: '

Creates an Issuing Card object.

', doc: '

Creates an Issuing Card object.

', }, getIssuingCardsCard: { comment: '

Retrieves an Issuing Card object.

', doc: '

Retrieves an Issuing Card object.

', }, postIssuingCardsCard: { comment: '

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

', doc: '

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

', }, getIssuingDisputes: { comment: '

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

', doc: '

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

', }, postIssuingDisputes: { comment: '

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

', doc: '

', }, getIssuingDisputesDispute: { comment: '

Retrieves an Issuing Dispute object.

', doc: '

Retrieves an Issuing Dispute object.

', }, postIssuingDisputesDispute: { comment: '

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

', doc: '

', }, postIssuingDisputesDisputeSubmit: { comment: '

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

', doc: '

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

', }, getIssuingPersonalizationDesigns: { comment: '

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

', doc: '

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

', }, postIssuingPersonalizationDesigns: { comment: '

Creates a personalization design object.

', doc: '

Creates a personalization design object.

', }, getIssuingPersonalizationDesignsPersonalizationDesign: { comment: '

Retrieves a personalization design object.

', doc: '

Retrieves a personalization design object.

', }, postIssuingPersonalizationDesignsPersonalizationDesign: { comment: '

Updates a card personalization object.

', doc: '

Updates a card personalization object.

', }, getIssuingPhysicalBundles: { comment: '

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

', doc: '

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

', }, getIssuingPhysicalBundlesPhysicalBundle: { comment: '

Retrieves a physical bundle object.

', doc: '

Retrieves a physical bundle object.

', }, getIssuingSettlementsSettlement: { comment: '

Retrieves an Issuing Settlement object.

', doc: '

Retrieves an Issuing Settlement object.

', }, postIssuingSettlementsSettlement: { comment: '

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

', doc: '

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

', }, getIssuingTokens: { comment: '

Lists all Issuing Token objects for a given card.

', doc: '

Lists all Issuing Token objects for a given card.

', }, getIssuingTokensToken: { comment: '

Retrieves an Issuing Token object.

', doc: '

Retrieves an Issuing Token object.

', }, postIssuingTokensToken: { comment: '

Attempts to update the specified Issuing Token object to the status specified.

', doc: '

Attempts to update the specified Issuing Token object to the status specified.

', }, getIssuingTransactions: { comment: '

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

', doc: '

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

', }, getIssuingTransactionsTransaction: { comment: '

Retrieves an Issuing Transaction object.

', doc: '

Retrieves an Issuing Transaction object.

', }, postIssuingTransactionsTransaction: { comment: '

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

', doc: '

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

', }, postLinkAccountSessions: { comment: '

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

', doc: '

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

', }, getLinkAccountSessionsSession: { comment: '

Retrieves the details of a Financial Connections Session

', doc: '

Retrieves the details of a Financial Connections Session

', }, getLinkedAccounts: { comment: '

Returns a list of Financial Connections Account objects.

', doc: '

Returns a list of Financial Connections Account objects.

', }, getLinkedAccountsAccount: { comment: '

Retrieves the details of an Financial Connections Account.

', doc: '

Retrieves the details of an Financial Connections Account.

', }, postLinkedAccountsAccountDisconnect: { comment: '

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

', doc: '

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

', }, getLinkedAccountsAccountOwners: { comment: '

Lists all owners for a given Account

', doc: '

Lists all owners for a given Account

', }, postLinkedAccountsAccountRefresh: { comment: '

Refreshes the data associated with a Financial Connections Account.

', doc: '

Refreshes the data associated with a Financial Connections Account.

', }, getMandatesMandate: { comment: '

Retrieves a Mandate object.

', doc: '

Retrieves a Mandate object.

', }, getPaymentIntents: { comment: '

Returns a list of PaymentIntents.

', doc: '

Returns a list of PaymentIntents.

', }, postPaymentIntents: { comment: '

Creates a PaymentIntent object.

', doc: '

Creates a PaymentIntent object.

\n \n

After the PaymentIntent is created, attach a payment method and confirm\n to continue the payment. Learn more about the available payment flows\n with the Payment Intents API.

\n \n

When you use confirm=true during creation, it’s equivalent to creating\n and confirming the PaymentIntent in the same call. You can use any parameters\n available in the confirm API when you supply\n confirm=true.

', }, getPaymentIntentsSearch: { comment: '

Search for PaymentIntents you’ve previously created using Stripe’s Search Query Language.', doc: '

Search for PaymentIntents you’ve previously created using Stripe’s Search Query Language.\n Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\n conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\n to an hour behind during outages. Search functionality is not available to merchants in India.

', }, getPaymentIntentsIntent: { comment: '

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

', doc: '

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

\n \n

You can retrieve a PaymentIntent client-side using a publishable key when the client_secret is in the query string.

\n \n

If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the payment intent object reference for more details.

', }, postPaymentIntentsIntent: { comment: '

Updates properties on a PaymentIntent object without confirming.

', doc: '

Updates properties on a PaymentIntent object without confirming.

\n \n

Depending on which properties you update, you might need to confirm the\n PaymentIntent again. For example, updating the payment_method\n always requires you to confirm the PaymentIntent again. If you prefer to\n update and confirm at the same time, we recommend updating properties through\n the confirm API instead.

', }, postPaymentIntentsIntentApplyCustomerBalance: { comment: '

Manually reconcile the remaining amount for a customer_balance PaymentIntent.

', doc: '

Manually reconcile the remaining amount for a customer_balance PaymentIntent.

', }, postPaymentIntentsIntentCancel: { comment: '

You can cancel a PaymentIntent object when it’s in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, in rare cases, processing.

', doc: '

You can cancel a PaymentIntent object when it’s in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, in rare cases, processing.

\n \n

After 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 status of requires_capture, the remaining amount_capturable is automatically refunded.

\n \n

You can’t cancel the PaymentIntent for a Checkout Session. Expire the Checkout Session instead.

', }, postPaymentIntentsIntentCapture: { comment: '

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

', doc: '

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

\n \n

Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.

\n \n

Learn more about separate authorization and capture.

', }, postPaymentIntentsIntentConfirm: { comment: '

Confirm that your customer intends to pay with current or provided', doc: '

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

', }, postPaymentIntentsIntentIncrementAuthorization: { comment: '

Perform an incremental authorization on an eligible', doc: '

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

\n \n

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

\n \n

If the incremental authorization succeeds, the PaymentIntent object\n returns with the updated\n amount.\n If the incremental authorization fails, a\n card_declined error returns, and no other\n fields on the PaymentIntent or Charge update. The PaymentIntent\n object remains capturable for the previously authorized amount.

\n \n

Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines.\n After it’s captured, a PaymentIntent can no longer be incremented.

\n \n

Learn more about incremental authorizations.

', }, postPaymentIntentsIntentVerifyMicrodeposits: { comment: '

Verifies microdeposits on a PaymentIntent object.

', doc: '

Verifies microdeposits on a PaymentIntent object.

', }, getPaymentLinks: { comment: '

Returns a list of your payment links.

', doc: '

Returns a list of your payment links.

', }, postPaymentLinks: { comment: '

Creates a payment link.

', doc: '

Creates a payment link.

', }, getPaymentLinksPaymentLink: { comment: '

Retrieve a payment link.

', doc: '

Retrieve a payment link.

', }, postPaymentLinksPaymentLink: { comment: '

Updates a payment link.

', doc: '

Updates a payment link.

', }, getPaymentLinksPaymentLinkLineItems: { comment: '

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

', doc: '

', }, getPaymentMethodConfigurations: { comment: '

List payment method configurations

', doc: '

List payment method configurations

', }, postPaymentMethodConfigurations: { comment: '

Creates a payment method configuration

', doc: '

Creates a payment method configuration

', }, getPaymentMethodConfigurationsConfiguration: { comment: '

Retrieve payment method configuration

', doc: '

Retrieve payment method configuration

', }, postPaymentMethodConfigurationsConfiguration: { comment: '

Update payment method configuration

', doc: '

Update payment method configuration

', }, getPaymentMethodDomains: { comment: '

Lists the details of existing payment method domains.

', doc: '

Lists the details of existing payment method domains.

', }, postPaymentMethodDomains: { comment: '

Creates a payment method domain.

', doc: '

Creates a payment method domain.

', }, getPaymentMethodDomainsPaymentMethodDomain: { comment: '

Retrieves the details of an existing payment method domain.

', doc: '

Retrieves the details of an existing payment method domain.

', }, postPaymentMethodDomainsPaymentMethodDomain: { comment: '

Updates an existing payment method domain.

', doc: '

Updates an existing payment method domain.

', }, postPaymentMethodDomainsPaymentMethodDomainValidate: { comment: '

Some payment methods such as Apple Pay require additional steps to verify a domain. If the requirements weren’t satisfied when the domain was created, the payment method will be inactive on the domain.', doc: '

\n \n

To activate a payment method on an existing payment method domain, complete the required validation steps specific to the payment method, and then validate the payment method domain with this endpoint.

\n \n

Related guides: Payment method domains.

', }, getPaymentMethods: { comment: '

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

', doc: '

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

', }, postPaymentMethods: { comment: '

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

', doc: '

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

\n \n

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

', }, getPaymentMethodsPaymentMethod: { comment: '

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

', doc: '

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

', }, postPaymentMethodsPaymentMethod: { comment: '

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

', doc: '

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

', }, postPaymentMethodsPaymentMethodAttach: { comment: '

Attaches a PaymentMethod object to a Customer.

', doc: '

Attaches a PaymentMethod object to a Customer.

\n \n

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

\n \n

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

', }, postPaymentMethodsPaymentMethodDetach: { comment: '

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

', doc: '

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

', }, getPayouts: { comment: '

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

', doc: '

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

', }, postPayouts: { comment: '

To send funds to your own bank account, create a new payout object. Your Stripe balance must cover the payout amount. If it doesn’t, you receive an “Insufficient Funds” error.

', doc: '

To send funds to your own bank account, create a new payout object. Your Stripe balance must cover the payout amount. If it doesn’t, you receive an “Insufficient Funds” error.

\n \n

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

\n \n

If 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 balance object details available and pending amounts by source type.

', }, getPayoutsPayout: { comment: '

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

', doc: '

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

', }, postPayoutsPayout: { comment: '

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

', doc: '

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

', }, postPayoutsPayoutCancel: { comment: '

You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.

', doc: '

You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.

', }, postPayoutsPayoutReverse: { comment: '

Reverses 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 pending status, use /v1/payouts/:id/cancel instead.

', doc: '

\n \n

By requesting a reversal through /v1/payouts/:id/reverse, 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.

', }, getPlans: { comment: '

Returns a list of your plans.

', doc: '

Returns a list of your plans.

', }, postPlans: { comment: '

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

', doc: '

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

', }, deletePlansPlan: { comment: '

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

', doc: '

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

', }, getPlansPlan: { comment: '

Retrieves the plan with the given ID.

', doc: '

Retrieves the plan with the given ID.

', }, postPlansPlan: { comment: '

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

', doc: '

', }, getPrices: { comment: '

Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active to false.

', doc: '

Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active to false.

', }, postPrices: { comment: '

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

', doc: '

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

', }, getPricesSearch: { comment: '

Search for prices you’ve previously created using Stripe’s Search Query Language.', doc: '

Search for prices you’ve previously created using Stripe’s Search Query Language.\n Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\n conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\n to an hour behind during outages. Search functionality is not available to merchants in India.

', }, getPricesPrice: { comment: '

Retrieves the price with the given ID.

', doc: '

Retrieves the price with the given ID.

', }, postPricesPrice: { comment: '

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

', doc: '

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

', }, getProducts: { comment: '

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

', doc: '

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

', }, postProducts: { comment: '

Creates a new product object.

', doc: '

Creates a new product object.

', }, getProductsSearch: { comment: '

Search for products you’ve previously created using Stripe’s Search Query Language.', doc: '

Search for products you’ve previously created using Stripe’s Search Query Language.\n Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\n conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\n to an hour behind during outages. Search functionality is not available to merchants in India.

', }, deleteProductsId: { comment: '

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

', doc: '

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

', }, getProductsId: { comment: '

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

', doc: '

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

', }, postProductsId: { comment: '

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

', doc: '

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

', }, getProductsProductFeatures: { comment: '

Retrieve a list of features for a product

', doc: '

Retrieve a list of features for a product

', }, postProductsProductFeatures: { comment: '

Creates a product_feature, which represents a feature attachment to a product

', doc: '

Creates a product_feature, which represents a feature attachment to a product

', }, deleteProductsProductFeaturesId: { comment: '

Deletes the feature attachment to a product

', doc: '

Deletes the feature attachment to a product

', }, getProductsProductFeaturesId: { comment: '

Retrieves a product_feature, which represents a feature attachment to a product

', doc: '

Retrieves a product_feature, which represents a feature attachment to a product

', }, getPromotionCodes: { comment: '

Returns a list of your promotion codes.

', doc: '

Returns a list of your promotion codes.

', }, postPromotionCodes: { comment: '

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

', doc: '

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

', }, getPromotionCodesPromotionCode: { comment: '

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

', doc: '

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

', }, postPromotionCodesPromotionCode: { comment: '

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

', doc: '

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

', }, getQuotes: { comment: '

Returns a list of your quotes.

', doc: '

Returns a list of your quotes.

', }, postQuotes: { comment: '

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

', doc: '

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

', }, getQuotesQuote: { comment: '

Retrieves the quote with the given ID.

', doc: '

Retrieves the quote with the given ID.

', }, postQuotesQuote: { comment: '

A quote models prices and services for a customer.

', doc: '

A quote models prices and services for a customer.

', }, postQuotesQuoteAccept: { comment: '

Accepts the specified quote.

', doc: '

Accepts the specified quote.

', }, postQuotesQuoteCancel: { comment: '

Cancels the quote.

', doc: '

Cancels the quote.

', }, getQuotesQuoteComputedUpfrontLineItems: { comment: '

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

', doc: '

', }, postQuotesQuoteFinalize: { comment: '

Finalizes the quote.

', doc: '

Finalizes the quote.

', }, getQuotesQuoteLineItems: { comment: '

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

', doc: '

', }, getQuotesQuotePdf: { comment: '

Download the PDF for a finalized quote. Explanation for special handling can be found here

', doc: '

Download the PDF for a finalized quote. Explanation for special handling can be found here

', }, getRadarEarlyFraudWarnings: { comment: '

Returns a list of early fraud warnings.

', doc: '

Returns a list of early fraud warnings.

', }, getRadarEarlyFraudWarningsEarlyFraudWarning: { comment: '

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

', doc: '

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

\n \n

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

', }, getRadarValueListItems: { comment: '

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

', doc: '

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

', }, postRadarValueListItems: { comment: '

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

', doc: '

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

', }, deleteRadarValueListItemsItem: { comment: '

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

', doc: '

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

', }, getRadarValueListItemsItem: { comment: '

Retrieves a ValueListItem object.

', doc: '

Retrieves a ValueListItem object.

', }, getRadarValueLists: { comment: '

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

', doc: '

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

', }, postRadarValueLists: { comment: '

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

', doc: '

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

', }, deleteRadarValueListsValueList: { comment: '

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

', doc: '

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

', }, getRadarValueListsValueList: { comment: '

Retrieves a ValueList object.

', doc: '

Retrieves a ValueList object.

', }, postRadarValueListsValueList: { comment: '

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

', doc: '

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

', }, getRefunds: { comment: '

Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first The 10 most recent refunds are always available by default on the Charge object.

', doc: '

', }, postRefunds: { comment: '

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

', doc: '

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

\n \n

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

\n \n

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

\n \n

', }, getRefundsRefund: { comment: '

Retrieves the details of an existing refund.

', doc: '

Retrieves the details of an existing refund.

', }, postRefundsRefund: { comment: '

Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don’t provide remain unchanged.

', doc: '

Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don’t provide remain unchanged.

\n \n

This request only accepts metadata as an argument.

', }, postRefundsRefundCancel: { comment: '

Cancels a refund with a status of requires_action.

', doc: '

Cancels a refund with a status of requires_action.

\n \n

You can’t cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.

', }, getReportingReportRuns: { comment: '

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

', doc: '

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

', }, postReportingReportRuns: { comment: '

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

', doc: '

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

', }, getReportingReportRunsReportRun: { comment: '

Retrieves the details of an existing Report Run.

', doc: '

Retrieves the details of an existing Report Run.

', }, getReportingReportTypes: { comment: '

Returns a full list of Report Types.

', doc: '

Returns a full list of Report Types.

', }, getReportingReportTypesReportType: { comment: '

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

', doc: '

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

', }, getReviews: { comment: '

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

', doc: '

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

', }, getReviewsReview: { comment: '

Retrieves a Review object.

', doc: '

Retrieves a Review object.

', }, postReviewsReviewApprove: { comment: '

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

', doc: '

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

', }, getSetupAttempts: { comment: '

Returns a list of SetupAttempts that associate with a provided SetupIntent.

', doc: '

Returns a list of SetupAttempts that associate with a provided SetupIntent.

', }, getSetupIntents: { comment: '

Returns a list of SetupIntents.

', doc: '

Returns a list of SetupIntents.

', }, postSetupIntents: { comment: '

Creates a SetupIntent object.

', doc: '

Creates a SetupIntent object.

\n \n

After you create the SetupIntent, attach a payment method and confirm\n it to collect any required permissions to charge the payment method later.

', }, getSetupIntentsIntent: { comment: '

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

', doc: '

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

\n \n

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

\n \n

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

', }, postSetupIntentsIntent: { comment: '

Updates a SetupIntent object.

', doc: '

Updates a SetupIntent object.

', }, postSetupIntentsIntentCancel: { comment: '

You can cancel a SetupIntent object when it’s in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

', doc: '

You can cancel a SetupIntent object when it’s in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

\n \n

After 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. Expire the Checkout Session instead.

', }, postSetupIntentsIntentConfirm: { comment: '

Confirm that your customer intends to set up the current or', doc: '

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

\n \n

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

\n \n

Otherwise, it will transition to the requires_action status and\n suggest additional actions via next_action. If setup fails,\n the SetupIntent will transition to the\n requires_payment_method status or the canceled status if the\n confirmation limit is reached.

', }, postSetupIntentsIntentVerifyMicrodeposits: { comment: '

Verifies microdeposits on a SetupIntent object.

', doc: '

Verifies microdeposits on a SetupIntent object.

', }, getShippingRates: { comment: '

Returns a list of your shipping rates.

', doc: '

Returns a list of your shipping rates.

', }, postShippingRates: { comment: '

Creates a new shipping rate object.

', doc: '

Creates a new shipping rate object.

', }, getShippingRatesShippingRateToken: { comment: '

Returns the shipping rate object with the given ID.

', doc: '

Returns the shipping rate object with the given ID.

', }, postShippingRatesShippingRateToken: { comment: '

Updates an existing shipping rate object.

', doc: '

Updates an existing shipping rate object.

', }, getSigmaScheduledQueryRuns: { comment: '

Returns a list of scheduled query runs.

', doc: '

Returns a list of scheduled query runs.

', }, getSigmaScheduledQueryRunsScheduledQueryRun: { comment: '

Retrieves the details of an scheduled query run.

', doc: '

Retrieves the details of an scheduled query run.

', }, postSources: { comment: '

Creates a new source object.

', doc: '

Creates a new source object.

', }, getSourcesSource: { comment: '

Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.

', doc: '

Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.

', }, postSourcesSource: { comment: '

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

', doc: '

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

\n \n

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

', }, getSourcesSourceMandateNotificationsMandateNotification: { comment: '

Retrieves a new Source MandateNotification.

', doc: '

Retrieves a new Source MandateNotification.

', }, getSourcesSourceSourceTransactions: { comment: '

List source transactions for a given source.

', doc: '

List source transactions for a given source.

', }, getSourcesSourceSourceTransactionsSourceTransaction: { comment: '

Retrieve an existing source transaction object. Supply the unique source ID from a source creation request and the source transaction ID and Stripe will return the corresponding up-to-date source object information.

', doc: '

', }, postSourcesSourceVerify: { comment: '

Verify a given source.

', doc: '

Verify a given source.

', }, getSubscriptionItems: { comment: '

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

', doc: '

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

', }, postSubscriptionItems: { comment: '

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

', doc: '

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

', }, deleteSubscriptionItemsItem: { comment: '

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

', doc: '

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

', }, getSubscriptionItemsItem: { comment: '

Retrieves the subscription item with the given ID.

', doc: '

Retrieves the subscription item with the given ID.

', }, postSubscriptionItemsItem: { comment: '

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

', doc: '

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

', }, getSubscriptionItemsSubscriptionItemUsageRecordSummaries: { comment: '

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

', doc: '

\n \n

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

', }, postSubscriptionItemsSubscriptionItemUsageRecords: { comment: '

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

', doc: '

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

\n \n

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

\n \n

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

\n \n

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

', }, getSubscriptionSchedules: { comment: '

Retrieves the list of your subscription schedules.

', doc: '

Retrieves the list of your subscription schedules.

', }, postSubscriptionSchedules: { comment: '

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

', doc: '

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

', }, getSubscriptionSchedulesSchedule: { comment: '

Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.

', doc: '

Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.

', }, postSubscriptionSchedulesSchedule: { comment: '

Updates an existing subscription schedule.

', doc: '

Updates an existing subscription schedule.

', }, postSubscriptionSchedulesScheduleCancel: { comment: '

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

', doc: '

', }, postSubscriptionSchedulesScheduleRelease: { comment: '

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

', doc: '

', }, getSubscriptions: { comment: '

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

', doc: '

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

', }, postSubscriptions: { comment: '

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

', doc: '

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

\n \n

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

\n \n

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

', }, getSubscriptionsSearch: { comment: '

Search for subscriptions you’ve previously created using Stripe’s Search Query Language.', doc: '

Search for subscriptions you’ve previously created using Stripe’s Search Query Language.\n Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating\n conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up\n to an hour behind during outages. Search functionality is not available to merchants in India.

', }, deleteSubscriptionsSubscriptionExposedId: { comment: '

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

', doc: '

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

\n \n

', }, getSubscriptionsSubscriptionExposedId: { comment: '

Retrieves the subscription with the given ID.

', doc: '

Retrieves the subscription with the given ID.

', }, postSubscriptionsSubscriptionExposedId: { comment: '

Updates an existing subscription to match the specified parameters.', doc: '

Updates an existing subscription to match the specified parameters.\n When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes.\n To preview how the proration is calculated, use the upcoming invoice endpoint.

\n \n

By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they’ll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they’ll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month’s 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes.

\n \n

Switching prices does not normally change the billing date or generate an immediate charge unless:

\n \n

The billing interval is changed (for example, from monthly to yearly).
The subscription moves from free to paid, or paid to free.
A trial starts or ends.

\n \n

In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date.

\n \n

If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription’s renewal date, you need to manually invoice the customer.

\n \n

If you don’t want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 on May 1 and 200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don’t generate any credits for the old subscription’s unused time. We still reset the billing date and bill immediately for the new subscription.

\n \n

Updating the quantity on a subscription many times in an hour may result in rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing instead.

', }, deleteSubscriptionsSubscriptionExposedIdDiscount: { comment: '

Removes the currently applied discount on a subscription.

', doc: '

Removes the currently applied discount on a subscription.

', }, postSubscriptionsSubscriptionResume: { comment: '

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

', doc: '

', }, postTaxCalculations: { comment: '

Calculates tax based on input and returns a Tax Calculation object.

', doc: '

Calculates tax based on input and returns a Tax Calculation object.

', }, getTaxCalculationsCalculationLineItems: { comment: '

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

', doc: '

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

', }, getTaxRegistrations: { comment: '

Returns a list of Tax Registration objects.

', doc: '

Returns a list of Tax Registration objects.

', }, postTaxRegistrations: { comment: '

Creates a new Tax Registration object.

', doc: '

Creates a new Tax Registration object.

', }, getTaxRegistrationsId: { comment: '

Returns a Tax Registration object.

', doc: '

Returns a Tax Registration object.

', }, postTaxRegistrationsId: { comment: '

Updates an existing Tax Registration object.

', doc: '

Updates an existing Tax Registration object.

\n \n

A registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting expires_at.

', }, getTaxSettings: { comment: '

Retrieves Tax Settings for a merchant.

', doc: '

Retrieves Tax Settings for a merchant.

', }, postTaxSettings: { comment: '

Updates Tax Settings parameters used in tax calculations. All parameters are editable but none can be removed once set.

', doc: '

Updates Tax Settings parameters used in tax calculations. All parameters are editable but none can be removed once set.

', }, postTaxTransactionsCreateFromCalculation: { comment: '

Creates a Tax Transaction from a calculation, if that calculation hasn’t expired. Calculations expire after 90 days.

', doc: '

Creates a Tax Transaction from a calculation, if that calculation hasn’t expired. Calculations expire after 90 days.

', }, postTaxTransactionsCreateReversal: { comment: '

Partially or fully reverses a previously created Transaction.

', doc: '

Partially or fully reverses a previously created Transaction.

', }, getTaxTransactionsTransaction: { comment: '

Retrieves a Tax Transaction object.

', doc: '

Retrieves a Tax Transaction object.

', }, getTaxTransactionsTransactionLineItems: { comment: '

Retrieves the line items of a committed standalone transaction as a collection.

', doc: '

Retrieves the line items of a committed standalone transaction as a collection.

', }, getTaxCodes: { comment: '

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

', doc: '

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

', }, getTaxCodesId: { comment: '

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

', doc: '

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

', }, getTaxIds: { comment: '

Returns a list of tax IDs.

', doc: '

Returns a list of tax IDs.

', }, postTaxIds: { comment: '

Creates a new account or customer tax_id object.

', doc: '

Creates a new account or customer tax_id object.

', }, deleteTaxIdsId: { comment: '

Deletes an existing account or customer tax_id object.

', doc: '

Deletes an existing account or customer tax_id object.

', }, getTaxIdsId: { comment: '

Retrieves an account or customer tax_id object.

', doc: '

Retrieves an account or customer tax_id object.

', }, getTaxRates: { comment: '

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

', doc: '

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

', }, postTaxRates: { comment: '

Creates a new tax rate.

', doc: '

Creates a new tax rate.

', }, getTaxRatesTaxRate: { comment: '

Retrieves a tax rate with the given ID

', doc: '

Retrieves a tax rate with the given ID

', }, postTaxRatesTaxRate: { comment: '

Updates an existing tax rate.

', doc: '

Updates an existing tax rate.

', }, getTerminalConfigurations: { comment: '

Returns a list of Configuration objects.

', doc: '

Returns a list of Configuration objects.

', }, postTerminalConfigurations: { comment: '

Creates a new Configuration object.

', doc: '

Creates a new Configuration object.

', }, deleteTerminalConfigurationsConfiguration: { comment: '

Deletes a Configuration object.

', doc: '

Deletes a Configuration object.

', }, getTerminalConfigurationsConfiguration: { comment: '

Retrieves a Configuration object.

', doc: '

Retrieves a Configuration object.

', }, postTerminalConfigurationsConfiguration: { comment: '

Updates a new Configuration object.

', doc: '

Updates a new Configuration object.

', }, postTerminalConnectionTokens: { comment: '

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

', doc: '

', }, getTerminalLocations: { comment: '

Returns a list of Location objects.

', doc: '

Returns a list of Location objects.

', }, postTerminalLocations: { comment: '

Creates a new Location object.', doc: '

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

', }, deleteTerminalLocationsLocation: { comment: '

Deletes a Location object.

', doc: '

Deletes a Location object.

', }, getTerminalLocationsLocation: { comment: '

Retrieves a Location object.

', doc: '

Retrieves a Location object.

', }, postTerminalLocationsLocation: { comment: '

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

', doc: '

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

', }, getTerminalReaders: { comment: '

Returns a list of Reader objects.

', doc: '

Returns a list of Reader objects.

', }, postTerminalReaders: { comment: '

Creates a new Reader object.

', doc: '

Creates a new Reader object.

', }, deleteTerminalReadersReader: { comment: '

Deletes a Reader object.

', doc: '

Deletes a Reader object.

', }, getTerminalReadersReader: { comment: '

Retrieves a Reader object.

', doc: '

Retrieves a Reader object.

', }, postTerminalReadersReader: { comment: '

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

', doc: '

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

', }, postTerminalReadersReaderCancelAction: { comment: '

Cancels the current reader action.

', doc: '

Cancels the current reader action.

', }, postTerminalReadersReaderProcessPaymentIntent: { comment: '

Initiates a payment flow on a Reader.

', doc: '

Initiates a payment flow on a Reader.

', }, postTerminalReadersReaderProcessSetupIntent: { comment: '

Initiates a setup intent flow on a Reader.

', doc: '

Initiates a setup intent flow on a Reader.

', }, postTerminalReadersReaderRefundPayment: { comment: '

Initiates a refund on a Reader

', doc: '

Initiates a refund on a Reader

', }, postTerminalReadersReaderSetReaderDisplay: { comment: '

Sets reader display to show cart details.

', doc: '

Sets reader display to show cart details.

', }, postTestHelpersConfirmationTokens: { comment: '

Creates a test mode Confirmation Token server side for your integration tests.

', doc: '

Creates a test mode Confirmation Token server side for your integration tests.

', }, postTestHelpersCustomersCustomerFundCashBalance: { comment: '

Create an incoming testmode bank transfer

', doc: '

Create an incoming testmode bank transfer

', }, postTestHelpersIssuingAuthorizations: { comment: '

Create a test-mode authorization.

', doc: '

Create a test-mode authorization.

', }, postTestHelpersIssuingAuthorizationsAuthorizationCapture: { comment: '

Capture a test-mode authorization.

', doc: '

Capture a test-mode authorization.

', }, postTestHelpersIssuingAuthorizationsAuthorizationExpire: { comment: '

Expire a test-mode Authorization.

', doc: '

Expire a test-mode Authorization.

', }, postTestHelpersIssuingAuthorizationsAuthorizationIncrement: { comment: '

Increment a test-mode Authorization.

', doc: '

Increment a test-mode Authorization.

', }, postTestHelpersIssuingAuthorizationsAuthorizationReverse: { comment: '

Reverse a test-mode Authorization.

', doc: '

Reverse a test-mode Authorization.

', }, postTestHelpersIssuingCardsCardShippingDeliver: { comment: '

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

', doc: '

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

', }, postTestHelpersIssuingCardsCardShippingFail: { comment: '

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

', doc: '

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

', }, postTestHelpersIssuingCardsCardShippingReturn: { comment: '

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

', doc: '

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

', }, postTestHelpersIssuingCardsCardShippingShip: { comment: '

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

', doc: '

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

', }, postTestHelpersIssuingPersonalizationDesignsPersonalizationDesignActivate: { comment: '

Updates the status of the specified testmode personalization design object to active.

', doc: '

Updates the status of the specified testmode personalization design object to active.

', }, postTestHelpersIssuingPersonalizationDesignsPersonalizationDesignDeactivate: { comment: '

Updates the status of the specified testmode personalization design object to inactive.

', doc: '

Updates the status of the specified testmode personalization design object to inactive.

', }, postTestHelpersIssuingPersonalizationDesignsPersonalizationDesignReject: { comment: '

Updates the status of the specified testmode personalization design object to rejected.

', doc: '

Updates the status of the specified testmode personalization design object to rejected.

', }, postTestHelpersIssuingTransactionsCreateForceCapture: { comment: '

Allows the user to capture an arbitrary amount, also known as a forced capture.

', doc: '

Allows the user to capture an arbitrary amount, also known as a forced capture.

', }, postTestHelpersIssuingTransactionsCreateUnlinkedRefund: { comment: '

Allows the user to refund an arbitrary amount, also known as a unlinked refund.

', doc: '

Allows the user to refund an arbitrary amount, also known as a unlinked refund.

', }, postTestHelpersIssuingTransactionsTransactionRefund: { comment: '

Refund a test-mode Transaction.

', doc: '

Refund a test-mode Transaction.

', }, postTestHelpersRefundsRefundExpire: { comment: '

Expire a refund with a status of requires_action.

', doc: '

Expire a refund with a status of requires_action.

', }, postTestHelpersTerminalReadersReaderPresentPaymentMethod: { comment: '

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

', doc: '

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

', }, getTestHelpersTestClocks: { comment: '

Returns a list of your test clocks.

', doc: '

Returns a list of your test clocks.

', }, postTestHelpersTestClocks: { comment: '

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

', doc: '

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

', }, deleteTestHelpersTestClocksTestClock: { comment: '

Deletes a test clock.

', doc: '

Deletes a test clock.

', }, getTestHelpersTestClocksTestClock: { comment: '

Retrieves a test clock.

', doc: '

Retrieves a test clock.

', }, postTestHelpersTestClocksTestClockAdvance: { comment: '

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

', doc: '

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

', }, postTestHelpersTreasuryInboundTransfersIdFail: { comment: '

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

', doc: '

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

', }, postTestHelpersTreasuryInboundTransfersIdReturn: { comment: '

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

', doc: '

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

', }, postTestHelpersTreasuryInboundTransfersIdSucceed: { comment: '

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

', doc: '

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

', }, postTestHelpersTreasuryOutboundPaymentsId: { comment: '

Updates a test mode created OutboundPayment with tracking details. The OutboundPayment must not be cancelable, and cannot be in the canceled or failed states.

', doc: '

Updates a test mode created OutboundPayment with tracking details. The OutboundPayment must not be cancelable, and cannot be in the canceled or failed states.

', }, postTestHelpersTreasuryOutboundPaymentsIdFail: { comment: '

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

', doc: '

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

', }, postTestHelpersTreasuryOutboundPaymentsIdPost: { comment: '

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

', doc: '

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

', }, postTestHelpersTreasuryOutboundPaymentsIdReturn: { comment: '

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

', doc: '

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

', }, postTestHelpersTreasuryOutboundTransfersOutboundTransfer: { comment: '

Updates a test mode created OutboundTransfer with tracking details. The OutboundTransfer must not be cancelable, and cannot be in the canceled or failed states.

', doc: '

Updates a test mode created OutboundTransfer with tracking details. The OutboundTransfer must not be cancelable, and cannot be in the canceled or failed states.

', }, postTestHelpersTreasuryOutboundTransfersOutboundTransferFail: { comment: '

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

', doc: '

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

', }, postTestHelpersTreasuryOutboundTransfersOutboundTransferPost: { comment: '

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

', doc: '

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

', }, postTestHelpersTreasuryOutboundTransfersOutboundTransferReturn: { comment: '

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

', doc: '

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

', }, postTestHelpersTreasuryReceivedCredits: { comment: '

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

', doc: '

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

', }, postTestHelpersTreasuryReceivedDebits: { comment: '

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

', doc: '

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

', }, postTokens: { comment: '

Creates a single-use token that represents a bank account’s details.', doc: '

Creates a single-use token that represents a bank account’s details.\n You can use this token with any API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a connected account where controller.requirement_collection is application, which includes Custom accounts.

', }, getTokensToken: { comment: '

Retrieves the token with the given ID.

', doc: '

Retrieves the token with the given ID.

', }, getTopups: { comment: '

Returns a list of top-ups.

', doc: '

Returns a list of top-ups.

', }, postTopups: { comment: '

Top up the balance of an account

', doc: '

Top up the balance of an account

', }, getTopupsTopup: { comment: '

Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.

', doc: '

', }, postTopupsTopup: { comment: '

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

', doc: '

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

', }, postTopupsTopupCancel: { comment: '

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

', doc: '

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

', }, getTransfers: { comment: '

Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.

', doc: '

Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.

', }, postTransfers: { comment: '

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

', doc: '

', }, getTransfersIdReversals: { comment: '

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

', doc: '

', }, postTransfersIdReversals: { comment: '

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

', doc: '

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

\n \n

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

\n \n

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

', }, getTransfersTransfer: { comment: '

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

', doc: '

', }, postTransfersTransfer: { comment: '

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

', doc: '

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

\n \n

This request accepts only metadata as an argument.

', }, getTransfersTransferReversalsId: { comment: '

By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.

', doc: '

By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.

', }, postTransfersTransferReversalsId: { comment: '

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

', doc: '

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

\n \n

This request only accepts metadata and description as arguments.

', }, getTreasuryCreditReversals: { comment: '

Returns a list of CreditReversals.

', doc: '

Returns a list of CreditReversals.

', }, postTreasuryCreditReversals: { comment: '

Reverses a ReceivedCredit and creates a CreditReversal object.

', doc: '

Reverses a ReceivedCredit and creates a CreditReversal object.

', }, getTreasuryCreditReversalsCreditReversal: { comment: '

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

', doc: '

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

', }, getTreasuryDebitReversals: { comment: '

Returns a list of DebitReversals.

', doc: '

Returns a list of DebitReversals.

', }, postTreasuryDebitReversals: { comment: '

Reverses a ReceivedDebit and creates a DebitReversal object.

', doc: '

Reverses a ReceivedDebit and creates a DebitReversal object.

', }, getTreasuryDebitReversalsDebitReversal: { comment: '

Retrieves a DebitReversal object.

', doc: '

Retrieves a DebitReversal object.

', }, getTreasuryFinancialAccounts: { comment: '

Returns a list of FinancialAccounts.

', doc: '

Returns a list of FinancialAccounts.

', }, postTreasuryFinancialAccounts: { comment: '

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

', doc: '

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

', }, getTreasuryFinancialAccountsFinancialAccount: { comment: '

Retrieves the details of a FinancialAccount.

', doc: '

Retrieves the details of a FinancialAccount.

', }, postTreasuryFinancialAccountsFinancialAccount: { comment: '

Updates the details of a FinancialAccount.

', doc: '

Updates the details of a FinancialAccount.

', }, getTreasuryFinancialAccountsFinancialAccountFeatures: { comment: '

Retrieves Features information associated with the FinancialAccount.

', doc: '

Retrieves Features information associated with the FinancialAccount.

', }, postTreasuryFinancialAccountsFinancialAccountFeatures: { comment: '

Updates the Features associated with a FinancialAccount.

', doc: '

Updates the Features associated with a FinancialAccount.

', }, getTreasuryInboundTransfers: { comment: '

Returns a list of InboundTransfers sent from the specified FinancialAccount.

', doc: '

Returns a list of InboundTransfers sent from the specified FinancialAccount.

', }, postTreasuryInboundTransfers: { comment: '

Creates an InboundTransfer.

', doc: '

Creates an InboundTransfer.

', }, getTreasuryInboundTransfersId: { comment: '

Retrieves the details of an existing InboundTransfer.

', doc: '

Retrieves the details of an existing InboundTransfer.

', }, postTreasuryInboundTransfersInboundTransferCancel: { comment: '

Cancels an InboundTransfer.

', doc: '

Cancels an InboundTransfer.

', }, getTreasuryOutboundPayments: { comment: '

Returns a list of OutboundPayments sent from the specified FinancialAccount.

', doc: '

Returns a list of OutboundPayments sent from the specified FinancialAccount.

', }, postTreasuryOutboundPayments: { comment: '

Creates an OutboundPayment.

', doc: '

Creates an OutboundPayment.

', }, getTreasuryOutboundPaymentsId: { comment: '

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

', doc: '

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

', }, postTreasuryOutboundPaymentsIdCancel: { comment: '

Cancel an OutboundPayment.

', doc: '

Cancel an OutboundPayment.

', }, getTreasuryOutboundTransfers: { comment: '

Returns a list of OutboundTransfers sent from the specified FinancialAccount.

', doc: '

Returns a list of OutboundTransfers sent from the specified FinancialAccount.

', }, postTreasuryOutboundTransfers: { comment: '

Creates an OutboundTransfer.

', doc: '

Creates an OutboundTransfer.

', }, getTreasuryOutboundTransfersOutboundTransfer: { comment: '

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

', doc: '

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

', }, postTreasuryOutboundTransfersOutboundTransferCancel: { comment: '

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

', doc: '

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

', }, getTreasuryReceivedCredits: { comment: '

Returns a list of ReceivedCredits.

', doc: '

Returns a list of ReceivedCredits.

', }, getTreasuryReceivedCreditsId: { comment: '

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

', doc: '

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

', }, getTreasuryReceivedDebits: { comment: '

Returns a list of ReceivedDebits.

', doc: '

Returns a list of ReceivedDebits.

', }, getTreasuryReceivedDebitsId: { comment: '

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

', doc: '

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

', }, getTreasuryTransactionEntries: { comment: '

Retrieves a list of TransactionEntry objects.

', doc: '

Retrieves a list of TransactionEntry objects.

', }, getTreasuryTransactionEntriesId: { comment: '

Retrieves a TransactionEntry object.

', doc: '

Retrieves a TransactionEntry object.

', }, getTreasuryTransactions: { comment: '

Retrieves a list of Transaction objects.

', doc: '

Retrieves a list of Transaction objects.

', }, getTreasuryTransactionsId: { comment: '

Retrieves the details of an existing Transaction.

', doc: '

Retrieves the details of an existing Transaction.

', }, getWebhookEndpoints: { comment: '

Returns a list of your webhook endpoints.

', doc: '

Returns a list of your webhook endpoints.

', }, postWebhookEndpoints: { comment: '

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

', doc: '

', }, deleteWebhookEndpointsWebhookEndpoint: { comment: '

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

', doc: '

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

', }, getWebhookEndpointsWebhookEndpoint: { comment: '

Retrieves the webhook endpoint with the given ID.

', doc: '

Retrieves the webhook endpoint with the given ID.

', }, postWebhookEndpointsWebhookEndpoint: { comment: '

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

', doc: '

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

', }, };