Module stripe
ballerinax/stripe Ballerina library
2.0.1
Overview
Stripe is a leading online payment processing platform that simplifies the handling of financial transactions over the Internet. Stripe is renowned for its ease of integration, comprehensive documentation, and robust API that supports a wide range of payment operations including credit card transactions, subscription management, and direct payouts to user bank accounts.
The Ballerina Stripe Connector allows developers to interact with the Stripe REST API V1, enabling seamless integration of Stripe’s extensive payment processing capabilities into Ballerina applications. This connector facilitates the automation of various payment-related operations such as charge creation, customer management, billing, and direct payouts. By leveraging the Ballerina Stripe Connector, developers can build secure and scalable payment solutions that enhance the e-commerce capabilities of their applications.
Setup guide
To use the Ballerina Stripe connector, you must have a Stripe account and an API token for authentication. Follow the steps below to set up the connector with your Stripe account. If you don't have an account, you can create one by visiting Stripe Sign Up page and completing the registration process.
Step 1: Log in to Stripe
- Sign in to your Stripe dashboard.
Step 2: Go to the developer portal
-
Click on the Developers button in the top-right corner.
Step 3: Retrieve the secret key
-
Go to API keys section in the nav-bar.
-
Retrieve the Secret key.
Note: If you need to have more granular permissions for the keys, you could setup and use
Restricted keys.
Quickstart
To begin using the Stripe connector in your Ballerina application, you'll need to follow these steps:
Step 1: Import the connector
First, import the ballerinax/stripe package into your Ballerina project.
import ballerinax/stripe;
Step 2: Instantiate a new connector
Create a stripe:ConnectionConfig object with API token, and initialize the connector.
configurable string secretKey = ?; stripe:ConnectionConfig configuration = { auth: { token: secretKey } }; stripe:Client stripe = check new (configuration);
Step 3: Invoke the connector operation
Now, utilize the available connector operations.
Create a new customer
stripe:customers_body newCustomer = { name: "John Doe", email: "john.doe@sample.com", address: { city: "Colombo", country: "Sri Lanka" } }; stripe:Customer customerDetails = check stripe->/customers.post(newCustomer);
List all customers
stripe:CustomerResourceCustomerList availableCustomers = check stripe->/customers;
Examples
The ballerinax/stripe connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering various Stripe functionalities.
-
Manage Stripe payments - Manage business payments with Stripe.
-
Manage one-time charges - Manage one-time charges with Stripe.
Clients
stripe: Client
Isolated
The Stripe REST API. Please see https://stripe.com/docs/api for more details.
Constructor
Gets invoked to initialize the connector.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.stripe.com/v1" - URL of the target service
delete accounts/[string account]
Isolated FunctionResource Function
function delete accounts/[string account](map<string|string[]> headers) returns Deleted_account|errorWith Connect, you can delete accounts you manage.
Test-mode accounts can be deleted at any time.
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.
If you want to delete your own account, use the account information tab in your account settings instead.
Return Type
- Deleted_account|error - Successful response.
delete accounts/[string account]/bank_accounts/[string id]
Isolated FunctionResource Function
function delete accounts/[string account]/bank_accounts/[string id](map<string|string[]> headers) returns Deleted_external_account|errorDelete a specified external account for a given account.
Return Type
- Deleted_external_account|error - Successful response.
delete accounts/[string account]/external_accounts/[string id]
Isolated FunctionResource Function
function delete accounts/[string account]/external_accounts/[string id](map<string|string[]> headers) returns Deleted_external_account|errorDelete a specified external account for a given account.
Return Type
- Deleted_external_account|error - Successful response.
delete accounts/[string account]/people/[string person]
Isolated FunctionResource Function
function delete accounts/[string account]/people/[string person](map<string|string[]> headers) returns Deleted_person|errorDeletes 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.
Return Type
- Deleted_person|error - Successful response.
delete accounts/[string account]/persons/[string person]
Isolated FunctionResource Function
function delete accounts/[string account]/persons/[string person](map<string|string[]> headers) returns Deleted_person|errorDeletes 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.
Return Type
- Deleted_person|error - Successful response.
delete apple_pay/domains/[string domain]
Isolated FunctionResource Function
function delete apple_pay/domains/[string domain](map<string|string[]> headers) returns Deleted_apple_pay_domain|errorDelete an apple pay domain.
Return Type
- Deleted_apple_pay_domain|error - Successful response.
delete coupons/[string coupon]
Isolated FunctionResource Function
function delete coupons/[string coupon](map<string|string[]> headers) returns Deleted_coupon|errorYou 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.
Return Type
- Deleted_coupon|error - Successful response.
delete customers/[string customer]
Isolated FunctionResource Function
function delete customers/[string customer](map<string|string[]> headers) returns Deleted_customer|errorPermanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.
Return Type
- Deleted_customer|error - Successful response.
delete customers/[string customer]/bank_accounts/[string id]
Isolated FunctionResource Function
function delete customers/[string customer]/bank_accounts/[string id](bank_accounts_id_body_2 payload, map<string|string[]> headers) returns inline_response_200_2|errorDelete a specified source for a given customer.
Parameters
- payload bank_accounts_id_body_2 -
Return Type
- inline_response_200_2|error - Successful response.
delete customers/[string customer]/cards/[string id]
Isolated FunctionResource Function
function delete customers/[string customer]/cards/[string id](cards_id_body_1 payload, map<string|string[]> headers) returns inline_response_200_2|errorDelete a specified source for a given customer.
Parameters
- payload cards_id_body_1 -
Return Type
- inline_response_200_2|error - Successful response.
delete customers/[string customer]/discount
Isolated FunctionResource Function
function delete customers/[string customer]/discount(map<string|string[]> headers) returns Deleted_discount|errorRemoves the currently applied discount on a customer.
Return Type
- Deleted_discount|error - Successful response.
delete customers/[string customer]/sources/[string id]
Isolated FunctionResource Function
function delete customers/[string customer]/sources/[string id](sources_id_body_1 payload, map<string|string[]> headers) returns inline_response_200_2|errorDelete a specified source for a given customer.
Parameters
- payload sources_id_body_1 -
Return Type
- inline_response_200_2|error - Successful response.
delete customers/[string customer]/subscriptions/[string subscription_exposed_id]
Isolated FunctionResource Function
function delete customers/[string customer]/subscriptions/[string subscription_exposed_id](subscriptions_subscription_exposed_id_body_1 payload, map<string|string[]> headers) returns Subscription|errorCancels a customer’s subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default false value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription.
Note, however, that any pending invoice items that you’ve created will still be charged for at the end of the period, unless manually deleted. If you’ve set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.
By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.
Parameters
Return Type
- Subscription|error - Successful response.
delete customers/[string customer]/subscriptions/[string subscription_exposed_id]/discount
Isolated FunctionResource Function
function delete customers/[string customer]/subscriptions/[string subscription_exposed_id]/discount(map<string|string[]> headers) returns Deleted_discount|errorRemoves the currently applied discount on a customer.
Return Type
- Deleted_discount|error - Successful response.
delete customers/[string customer]/tax_ids/[string id]
Isolated FunctionResource Function
function delete customers/[string customer]/tax_ids/[string id](map<string|string[]> headers) returns Deleted_tax_id|errorDeletes an existing tax_id object.
Return Type
- Deleted_tax_id|error - Successful response.
delete ephemeral_keys/[string 'key]
Isolated FunctionResource Function
function delete ephemeral_keys/[string 'key](ephemeral_keys_key_body payload, map<string|string[]> headers) returns Ephemeral_key|errorInvalidates a short-lived API key for a given resource.
Parameters
- payload ephemeral_keys_key_body -
Return Type
- Ephemeral_key|error - Successful response.
delete invoiceitems/[string invoiceitem]
Isolated FunctionResource Function
function delete invoiceitems/[string invoiceitem](map<string|string[]> headers) returns Deleted_invoiceitem|errorDeletes 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.
Return Type
- Deleted_invoiceitem|error - Successful response.
delete invoices/[string invoice]
Isolated FunctionResource Function
function delete invoices/[string invoice](map<string|string[]> headers) returns Deleted_invoice|errorPermanently 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.
Return Type
- Deleted_invoice|error - Successful response.
delete plans/[string plan]
Isolated FunctionResource Function
function delete plans/[string plan](map<string|string[]> headers) returns Deleted_plan|errorDeleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.
Return Type
- Deleted_plan|error - Successful response.
delete products/[string id]
Isolated FunctionResource Function
function delete products/[string id](map<string|string[]> headers) returns Deleted_product|errorDelete 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.
Return Type
- Deleted_product|error - Successful response.
delete products/[string product]/features/[string id]
Isolated FunctionResource Function
function delete products/[string product]/features/[string id](map<string|string[]> headers) returns Deleted_product_feature|errorDeletes the feature attachment to a product
Return Type
- Deleted_product_feature|error - Successful response.
delete radar/value_list_items/[string item]
Isolated FunctionResource Function
function delete radar/value_list_items/[string item](map<string|string[]> headers) returns Deleted_radar\.value_list_item|errorDeletes a ValueListItem object, removing it from its parent value list.
Return Type
- Deleted_radar\.value_list_item|error - Successful response.
delete radar/value_lists/[string value_list]
Isolated FunctionResource Function
function delete radar/value_lists/[string value_list](map<string|string[]> headers) returns Deleted_radar\.value_list|errorDeletes 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.
Return Type
- Deleted_radar\.value_list|error - Successful response.
delete subscription_items/[string item]
Isolated FunctionResource Function
function delete subscription_items/[string item](subscription_items_item_body_1 payload, map<string|string[]> headers) returns Deleted_subscription_item|errorDeletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.
Parameters
- payload subscription_items_item_body_1 -
Return Type
- Deleted_subscription_item|error - Successful response.
delete subscriptions/[string subscription_exposed_id]
Isolated FunctionResource Function
function delete subscriptions/[string subscription_exposed_id](subscriptions_subscription_exposed_id_body_3 payload, map<string|string[]> headers) returns Subscription|errorCancels a customer’s subscription immediately. The customer will not be charged again for the subscription.
Note, however, that any pending invoice items that you’ve created will still be charged for at the end of the period, unless manually deleted. If you’ve set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.
By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.
Parameters
Return Type
- Subscription|error - Successful response.
delete subscriptions/[string subscription_exposed_id]/discount
Isolated FunctionResource Function
function delete subscriptions/[string subscription_exposed_id]/discount(map<string|string[]> headers) returns Deleted_discount|errorRemoves the currently applied discount on a subscription.
Return Type
- Deleted_discount|error - Successful response.
delete tax_ids/[string id]
Isolated FunctionResource Function
function delete tax_ids/[string id](map<string|string[]> headers) returns Deleted_tax_id|errorDeletes an existing account or customer tax_id object.
Return Type
- Deleted_tax_id|error - Successful response.
delete terminal/configurations/[string configuration]
Isolated FunctionResource Function
function delete terminal/configurations/[string configuration](map<string|string[]> headers) returns Deleted_terminal\.configuration|errorDeletes a Configuration object.
Return Type
- Deleted_terminal\.configuration|error - Successful response.
delete terminal/locations/[string location]
Isolated FunctionResource Function
function delete terminal/locations/[string location](map<string|string[]> headers) returns Deleted_terminal\.location|errorDeletes a Location object.
Return Type
- Deleted_terminal\.location|error - Successful response.
delete terminal/readers/[string reader]
Isolated FunctionResource Function
function delete terminal/readers/[string reader](map<string|string[]> headers) returns Deleted_terminal\.reader|errorDeletes a Reader object.
Return Type
- Deleted_terminal\.reader|error - Successful response.
delete test_helpers/test_clocks/[string test_clock]
Isolated FunctionResource Function
function delete test_helpers/test_clocks/[string test_clock](map<string|string[]> headers) returns Deleted_test_helpers\.test_clock|errorDeletes a test clock.
Return Type
- Deleted_test_helpers\.test_clock|error - Successful response.
delete webhook_endpoints/[string webhook_endpoint]
Isolated FunctionResource Function
function delete webhook_endpoints/[string webhook_endpoint](map<string|string[]> headers) returns Deleted_webhook_endpoint|errorYou can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.
Return Type
- Deleted_webhook_endpoint|error - Successful response.
get account
Isolated FunctionResource Function
function get account(map<string|string[]> headers, *GetAccountQueries queries) returns Account|errorRetrieves the details of an account.
Parameters
- queries *GetAccountQueries - Queries to be sent with the request
get accounts
Isolated FunctionResource Function
function get accounts(map<string|string[]> headers, *GetAccountsQueries queries) returns AccountList|errorReturns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.
Parameters
- queries *GetAccountsQueries - Queries to be sent with the request
Return Type
- AccountList|error - Successful response.
get accounts/[string account]
Isolated FunctionResource Function
function get accounts/[string account](map<string|string[]> headers, *GetAccountsAccountQueries queries) returns Account|errorRetrieves the details of an account.
Parameters
- queries *GetAccountsAccountQueries - Queries to be sent with the request
get accounts/[string account]/bank_accounts/[string id]
Isolated FunctionResource Function
function get accounts/[string account]/bank_accounts/[string id](map<string|string[]> headers, *GetAccountsAccountBankAccountsIdQueries queries) returns External_account|errorRetrieve a specified external account for a given account.
Parameters
- queries *GetAccountsAccountBankAccountsIdQueries - Queries to be sent with the request
Return Type
- External_account|error - Successful response.
get accounts/[string account]/capabilities
Isolated FunctionResource Function
function get accounts/[string account]/capabilities(map<string|string[]> headers, *GetAccountsAccountCapabilitiesQueries queries) returns ListAccountCapability|errorReturns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.
Parameters
- queries *GetAccountsAccountCapabilitiesQueries - Queries to be sent with the request
Return Type
- ListAccountCapability|error - Successful response.
get accounts/[string account]/capabilities/[string capability]
Isolated FunctionResource Function
function get accounts/[string account]/capabilities/[string capability](map<string|string[]> headers, *GetAccountsAccountCapabilitiesCapabilityQueries queries) returns Capability|errorRetrieves information about the specified Account Capability.
Parameters
- queries *GetAccountsAccountCapabilitiesCapabilityQueries - Queries to be sent with the request
Return Type
- Capability|error - Successful response.
get accounts/[string account]/external_accounts
Isolated FunctionResource Function
function get accounts/[string account]/external_accounts(map<string|string[]> headers, *GetAccountsAccountExternalAccountsQueries queries) returns ExternalAccountList|errorList external accounts for an account.
Parameters
- queries *GetAccountsAccountExternalAccountsQueries - Queries to be sent with the request
Return Type
- ExternalAccountList|error - Successful response.
get accounts/[string account]/external_accounts/[string id]
Isolated FunctionResource Function
function get accounts/[string account]/external_accounts/[string id](map<string|string[]> headers, *GetAccountsAccountExternalAccountsIdQueries queries) returns External_account|errorRetrieve a specified external account for a given account.
Parameters
- queries *GetAccountsAccountExternalAccountsIdQueries - Queries to be sent with the request
Return Type
- External_account|error - Successful response.
get accounts/[string account]/people
Isolated FunctionResource Function
function get accounts/[string account]/people(map<string|string[]> headers, *GetAccountsAccountPeopleQueries queries) returns PersonList|errorReturns 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.
Parameters
- queries *GetAccountsAccountPeopleQueries - Queries to be sent with the request
Return Type
- PersonList|error - Successful response.
get accounts/[string account]/people/[string person]
Isolated FunctionResource Function
function get accounts/[string account]/people/[string person](map<string|string[]> headers, *GetAccountsAccountPeoplePersonQueries queries) returns Person|errorRetrieves an existing person.
Parameters
- queries *GetAccountsAccountPeoplePersonQueries - Queries to be sent with the request
get accounts/[string account]/persons
Isolated FunctionResource Function
function get accounts/[string account]/persons(map<string|string[]> headers, *GetAccountsAccountPersonsQueries queries) returns PersonList|errorReturns 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.
Parameters
- queries *GetAccountsAccountPersonsQueries - Queries to be sent with the request
Return Type
- PersonList|error - Successful response.
get accounts/[string account]/persons/[string person]
Isolated FunctionResource Function
function get accounts/[string account]/persons/[string person](map<string|string[]> headers, *GetAccountsAccountPersonsPersonQueries queries) returns Person|errorRetrieves an existing person.
Parameters
- queries *GetAccountsAccountPersonsPersonQueries - Queries to be sent with the request
get apple_pay/domains
Isolated FunctionResource Function
function get apple_pay/domains(map<string|string[]> headers, *GetApplePayDomainsQueries queries) returns ApplePayDomainList|errorList apple pay domains.
Parameters
- queries *GetApplePayDomainsQueries - Queries to be sent with the request
Return Type
- ApplePayDomainList|error - Successful response.
get apple_pay/domains/[string domain]
Isolated FunctionResource Function
function get apple_pay/domains/[string domain](map<string|string[]> headers, *GetApplePayDomainsDomainQueries queries) returns Apple_pay_domain|errorRetrieve an apple pay domain.
Parameters
- queries *GetApplePayDomainsDomainQueries - Queries to be sent with the request
Return Type
- Apple_pay_domain|error - Successful response.
get application_fees
Isolated FunctionResource Function
function get application_fees(map<string|string[]> headers, *GetApplicationFeesQueries queries) returns PlatformEarningList|errorReturns a list of application fees you’ve previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.
Parameters
- queries *GetApplicationFeesQueries - Queries to be sent with the request
Return Type
- PlatformEarningList|error - Successful response.
get application_fees/[string fee]/refunds/[string id]
Isolated FunctionResource Function
function get application_fees/[string fee]/refunds/[string id](map<string|string[]> headers, *GetApplicationFeesFeeRefundsIdQueries queries) returns Fee_refund|errorBy 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.
Parameters
- queries *GetApplicationFeesFeeRefundsIdQueries - Queries to be sent with the request
Return Type
- Fee_refund|error - Successful response.
get application_fees/[string id]
Isolated FunctionResource Function
function get application_fees/[string id](map<string|string[]> headers, *GetApplicationFeesIdQueries queries) returns Application_fee|errorRetrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.
Parameters
- queries *GetApplicationFeesIdQueries - Queries to be sent with the request
Return Type
- Application_fee|error - Successful response.
get application_fees/[string id]/refunds
Isolated FunctionResource Function
function get application_fees/[string id]/refunds(map<string|string[]> headers, *GetApplicationFeesIdRefundsQueries queries) returns FeeRefundList|errorYou 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.
Parameters
- queries *GetApplicationFeesIdRefundsQueries - Queries to be sent with the request
Return Type
- FeeRefundList|error - Successful response.
get apps/secrets
Isolated FunctionResource Function
function get apps/secrets(map<string|string[]> headers, *GetAppsSecretsQueries queries) returns SecretServiceResourceSecretList|errorList all secrets stored on the given scope.
Parameters
- queries *GetAppsSecretsQueries - Queries to be sent with the request
Return Type
- SecretServiceResourceSecretList|error - Successful response.
get apps/secrets/find
Isolated FunctionResource Function
function get apps/secrets/find(map<string|string[]> headers, *GetAppsSecretsFindQueries queries) returns Apps\.secret|errorFinds a secret in the secret store by name and scope.
Parameters
- queries *GetAppsSecretsFindQueries - Queries to be sent with the request
Return Type
- Apps\.secret|error - Successful response.
get balance
Isolated FunctionResource Function
function get balance(map<string|string[]> headers, *GetBalanceQueries queries) returns Balance|errorRetrieves the current account balance, based on the authentication that was used to make the request. For a sample request, see Accounting for negative balances.
Parameters
- queries *GetBalanceQueries - Queries to be sent with the request
get balance/history
Isolated FunctionResource Function
function get balance/history(map<string|string[]> headers, *GetBalanceHistoryQueries queries) returns BalanceTransactionsList|errorReturns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.
Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.
Parameters
- queries *GetBalanceHistoryQueries - Queries to be sent with the request
Return Type
- BalanceTransactionsList|error - Successful response.
get balance/history/[string id]
Isolated FunctionResource Function
function get balance/history/[string id](map<string|string[]> headers, *GetBalanceHistoryIdQueries queries) returns Balance_transaction|errorRetrieves the balance transaction with the given ID.
Note that this endpoint previously used the path /v1/balance/history/:id.
Parameters
- queries *GetBalanceHistoryIdQueries - Queries to be sent with the request
Return Type
- Balance_transaction|error - Successful response.
get balance_transactions
Isolated FunctionResource Function
function get balance_transactions(map<string|string[]> headers, *GetBalanceTransactionsQueries queries) returns BalanceTransactionsList|errorReturns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.
Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.
Parameters
- queries *GetBalanceTransactionsQueries - Queries to be sent with the request
Return Type
- BalanceTransactionsList|error - Successful response.
get balance_transactions/[string id]
Isolated FunctionResource Function
function get balance_transactions/[string id](map<string|string[]> headers, *GetBalanceTransactionsIdQueries queries) returns Balance_transaction|errorRetrieves the balance transaction with the given ID.
Note that this endpoint previously used the path /v1/balance/history/:id.
Parameters
- queries *GetBalanceTransactionsIdQueries - Queries to be sent with the request
Return Type
- Balance_transaction|error - Successful response.
get billing/meters
Isolated FunctionResource Function
function get billing/meters(map<string|string[]> headers, *GetBillingMetersQueries queries) returns BillingMeterResourceBillingMeterList|errorRetrieve a list of billing meters.
Parameters
- queries *GetBillingMetersQueries - Queries to be sent with the request
Return Type
- BillingMeterResourceBillingMeterList|error - Successful response.
get billing/meters/[string id]
Isolated FunctionResource Function
function get billing/meters/[string id](map<string|string[]> headers, *GetBillingMetersIdQueries queries) returns Billing\.meter|errorRetrieves a billing meter given an ID
Parameters
- queries *GetBillingMetersIdQueries - Queries to be sent with the request
Return Type
- Billing\.meter|error - Successful response.
get billing/meters/[string id]/event_summaries
Isolated FunctionResource Function
function get billing/meters/[string id]/event_summaries(map<string|string[]> headers, *GetBillingMetersIdEventSummariesQueries queries) returns BillingMeterResourceBillingMeterEventSummaryList|errorRetrieve a list of billing meter event summaries.
Parameters
- queries *GetBillingMetersIdEventSummariesQueries - Queries to be sent with the request
Return Type
- BillingMeterResourceBillingMeterEventSummaryList|error - Successful response.
get billing_portal/configurations
Isolated FunctionResource Function
function get billing_portal/configurations(map<string|string[]> headers, *GetBillingPortalConfigurationsQueries queries) returns PortalPublicResourceConfigurationList|errorReturns a list of configurations that describe the functionality of the customer portal.
Parameters
- queries *GetBillingPortalConfigurationsQueries - Queries to be sent with the request
Return Type
- PortalPublicResourceConfigurationList|error - Successful response.
get billing_portal/configurations/[string configuration]
Isolated FunctionResource Function
function get billing_portal/configurations/[string configuration](map<string|string[]> headers, *GetBillingPortalConfigurationsConfigurationQueries queries) returns Billing_portal\.configuration|errorRetrieves a configuration that describes the functionality of the customer portal.
Parameters
- queries *GetBillingPortalConfigurationsConfigurationQueries - Queries to be sent with the request
Return Type
- Billing_portal\.configuration|error - Successful response.
get charges
Isolated FunctionResource Function
function get charges(map<string|string[]> headers, *GetChargesQueries queries) returns ChargeList|errorReturns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.
Parameters
- queries *GetChargesQueries - Queries to be sent with the request
Return Type
- ChargeList|error - Successful response.
get charges/[string charge]
Isolated FunctionResource Function
function get charges/[string charge](map<string|string[]> headers, *GetChargesChargeQueries queries) returns Charge|errorRetrieves 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.
Parameters
- queries *GetChargesChargeQueries - Queries to be sent with the request
get charges/[string charge]/dispute
Isolated FunctionResource Function
function get charges/[string charge]/dispute(map<string|string[]> headers, *GetChargesChargeDisputeQueries queries) returns Dispute|errorRetrieve a dispute for a specified charge.
Parameters
- queries *GetChargesChargeDisputeQueries - Queries to be sent with the request
get charges/[string charge]/refunds
Isolated FunctionResource Function
function get charges/[string charge]/refunds(map<string|string[]> headers, *GetChargesChargeRefundsQueries queries) returns RefundList|errorYou 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.
Parameters
- queries *GetChargesChargeRefundsQueries - Queries to be sent with the request
Return Type
- RefundList|error - Successful response.
get charges/[string charge]/refunds/[string refund]
Isolated FunctionResource Function
function get charges/[string charge]/refunds/[string refund](map<string|string[]> headers, *GetChargesChargeRefundsRefundQueries queries) returns Refund|errorRetrieves the details of an existing refund.
Parameters
- queries *GetChargesChargeRefundsRefundQueries - Queries to be sent with the request
get charges/search
Isolated FunctionResource Function
function get charges/search(map<string|string[]> headers, *GetChargesSearchQueries queries) returns SearchResult|errorSearch for charges you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.
Parameters
- queries *GetChargesSearchQueries - Queries to be sent with the request
Return Type
- SearchResult|error - Successful response.
get checkout/sessions
Isolated FunctionResource Function
function get checkout/sessions(map<string|string[]> headers, *GetCheckoutSessionsQueries queries) returns PaymentPagesCheckoutSessionList|errorReturns a list of Checkout Sessions.
Parameters
- queries *GetCheckoutSessionsQueries - Queries to be sent with the request
Return Type
- PaymentPagesCheckoutSessionList|error - Successful response.
get checkout/sessions/[string session]
Isolated FunctionResource Function
function get checkout/sessions/[string session](map<string|string[]> headers, *GetCheckoutSessionsSessionQueries queries) returns Checkout\.session|errorRetrieves a Session object.
Parameters
- queries *GetCheckoutSessionsSessionQueries - Queries to be sent with the request
Return Type
- Checkout\.session|error - Successful response.
get checkout/sessions/[string session]/line_items
Isolated FunctionResource Function
function get checkout/sessions/[string session]/line_items(map<string|string[]> headers, *GetCheckoutSessionsSessionLineItemsQueries queries) returns PaymentPagesCheckoutSessionListLineItems|errorWhen 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.
Parameters
- queries *GetCheckoutSessionsSessionLineItemsQueries - Queries to be sent with the request
Return Type
- PaymentPagesCheckoutSessionListLineItems|error - Successful response.
get climate/orders
Isolated FunctionResource Function
function get climate/orders(map<string|string[]> headers, *GetClimateOrdersQueries queries) returns ClimateRemovalsOrdersList|errorLists all Climate order objects. The orders are returned sorted by creation date, with the most recently created orders appearing first.
Parameters
- queries *GetClimateOrdersQueries - Queries to be sent with the request
Return Type
- ClimateRemovalsOrdersList|error - Successful response.
get climate/orders/[string 'order]
Isolated FunctionResource Function
function get climate/orders/[string 'order](map<string|string[]> headers, *GetClimateOrdersOrderQueries queries) returns Climate\.order|errorRetrieves the details of a Climate order object with the given ID.
Parameters
- queries *GetClimateOrdersOrderQueries - Queries to be sent with the request
Return Type
- Climate\.order|error - Successful response.
get climate/products
Isolated FunctionResource Function
function get climate/products(map<string|string[]> headers, *GetClimateProductsQueries queries) returns ClimateRemovalsProductsList|errorLists all available Climate product objects.
Parameters
- queries *GetClimateProductsQueries - Queries to be sent with the request
Return Type
- ClimateRemovalsProductsList|error - Successful response.
get climate/products/[string product]
Isolated FunctionResource Function
function get climate/products/[string product](map<string|string[]> headers, *GetClimateProductsProductQueries queries) returns Climate\.product|errorRetrieves the details of a Climate product with the given ID.
Parameters
- queries *GetClimateProductsProductQueries - Queries to be sent with the request
Return Type
- Climate\.product|error - Successful response.
get climate/suppliers
Isolated FunctionResource Function
function get climate/suppliers(map<string|string[]> headers, *GetClimateSuppliersQueries queries) returns ClimateRemovalsSuppliersList|errorLists all available Climate supplier objects.
Parameters
- queries *GetClimateSuppliersQueries - Queries to be sent with the request
Return Type
- ClimateRemovalsSuppliersList|error - Successful response.
get climate/suppliers/[string supplier]
Isolated FunctionResource Function
function get climate/suppliers/[string supplier](map<string|string[]> headers, *GetClimateSuppliersSupplierQueries queries) returns Climate\.supplier|errorRetrieves a Climate supplier object.
Parameters
- queries *GetClimateSuppliersSupplierQueries - Queries to be sent with the request
Return Type
- Climate\.supplier|error - Successful response.
get confirmation_tokens/[string confirmation_token]
Isolated FunctionResource Function
function get confirmation_tokens/[string confirmation_token](map<string|string[]> headers, *GetConfirmationTokensConfirmationTokenQueries queries) returns Confirmation_token|errorRetrieves an existing ConfirmationToken object
Parameters
- queries *GetConfirmationTokensConfirmationTokenQueries - Queries to be sent with the request
Return Type
- Confirmation_token|error - Successful response.
get country_specs
Isolated FunctionResource Function
function get country_specs(map<string|string[]> headers, *GetCountrySpecsQueries queries) returns CountrySpecList|errorLists all Country Spec objects available in the API.
Parameters
- queries *GetCountrySpecsQueries - Queries to be sent with the request
Return Type
- CountrySpecList|error - Successful response.
get country_specs/[string country]
Isolated FunctionResource Function
function get country_specs/[string country](map<string|string[]> headers, *GetCountrySpecsCountryQueries queries) returns Country_spec|errorReturns a Country Spec for a given Country code.
Parameters
- queries *GetCountrySpecsCountryQueries - Queries to be sent with the request
Return Type
- Country_spec|error - Successful response.
get coupons
Isolated FunctionResource Function
function get coupons(map<string|string[]> headers, *GetCouponsQueries queries) returns CouponsResourceCouponList|errorReturns a list of your coupons.
Parameters
- queries *GetCouponsQueries - Queries to be sent with the request
Return Type
- CouponsResourceCouponList|error - Successful response.
get coupons/[string coupon]
Isolated FunctionResource Function
function get coupons/[string coupon](map<string|string[]> headers, *GetCouponsCouponQueries queries) returns Coupon|errorRetrieves the coupon with the given ID.
Parameters
- queries *GetCouponsCouponQueries - Queries to be sent with the request
get credit_notes
Isolated FunctionResource Function
function get credit_notes(map<string|string[]> headers, *GetCreditNotesQueries queries) returns CreditNotesList|errorReturns a list of credit notes.
Parameters
- queries *GetCreditNotesQueries - Queries to be sent with the request
Return Type
- CreditNotesList|error - Successful response.
get credit_notes/[string credit_note]/lines
Isolated FunctionResource Function
function get credit_notes/[string credit_note]/lines(map<string|string[]> headers, *GetCreditNotesCreditNoteLinesQueries queries) returns CreditNoteLinesList|errorWhen 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.
Parameters
- queries *GetCreditNotesCreditNoteLinesQueries - Queries to be sent with the request
Return Type
- CreditNoteLinesList|error - Successful response.
get credit_notes/[string id]
Isolated FunctionResource Function
function get credit_notes/[string id](map<string|string[]> headers, *GetCreditNotesIdQueries queries) returns Credit_note|errorRetrieves the credit note object with the given identifier.
Parameters
- queries *GetCreditNotesIdQueries - Queries to be sent with the request
Return Type
- Credit_note|error - Successful response.
get credit_notes/preview
Isolated FunctionResource Function
function get credit_notes/preview(map<string|string[]> headers, *GetCreditNotesPreviewQueries queries) returns Credit_note|errorGet a preview of a credit note without creating it.
Parameters
- queries *GetCreditNotesPreviewQueries - Queries to be sent with the request
Return Type
- Credit_note|error - Successful response.
get credit_notes/preview/lines
Isolated FunctionResource Function
function get credit_notes/preview/lines(map<string|string[]> headers, *GetCreditNotesPreviewLinesQueries queries) returns CreditNoteLinesList|errorWhen 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.
Parameters
- queries *GetCreditNotesPreviewLinesQueries - Queries to be sent with the request
Return Type
- CreditNoteLinesList|error - Successful response.
get customers
Isolated FunctionResource Function
function get customers(map<string|string[]> headers, *GetCustomersQueries queries) returns CustomerResourceCustomerList|errorReturns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.
Parameters
- queries *GetCustomersQueries - Queries to be sent with the request
Return Type
- CustomerResourceCustomerList|error - Successful response.
get customers/[string customer]
Isolated FunctionResource Function
function get customers/[string customer](map<string|string[]> headers, *GetCustomersCustomerQueries queries) returns inline_response_200|errorRetrieves a Customer object.
Parameters
- queries *GetCustomersCustomerQueries - Queries to be sent with the request
Return Type
- inline_response_200|error - Successful response.
get customers/[string customer]/balance_transactions
Isolated FunctionResource Function
function get customers/[string customer]/balance_transactions(map<string|string[]> headers, *GetCustomersCustomerBalanceTransactionsQueries queries) returns CustomerBalanceTransactionList|errorReturns a list of transactions that updated the customer’s balances.
Parameters
- queries *GetCustomersCustomerBalanceTransactionsQueries - Queries to be sent with the request
Return Type
- CustomerBalanceTransactionList|error - Successful response.
get customers/[string customer]/balance_transactions/[string 'transaction]
Isolated FunctionResource Function
function get customers/[string customer]/balance_transactions/[string 'transaction](map<string|string[]> headers, *GetCustomersCustomerBalanceTransactionsTransactionQueries queries) returns Customer_balance_transaction|errorRetrieves a specific customer balance transaction that updated the customer’s balances.
Parameters
- queries *GetCustomersCustomerBalanceTransactionsTransactionQueries - Queries to be sent with the request
Return Type
- Customer_balance_transaction|error - Successful response.
get customers/[string customer]/bank_accounts
DeprecatedIsolated FunctionResource Function
function get customers/[string customer]/bank_accounts(map<string|string[]> headers, *GetCustomersCustomerBankAccountsQueries queries) returns BankAccountList|errorYou 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.
Parameters
- queries *GetCustomersCustomerBankAccountsQueries - Queries to be sent with the request
Return Type
- BankAccountList|error - Successful response.
Deprecated
get customers/[string customer]/bank_accounts/[string id]
DeprecatedIsolated FunctionResource Function
function get customers/[string customer]/bank_accounts/[string id](map<string|string[]> headers, *GetCustomersCustomerBankAccountsIdQueries queries) returns Bank_account|errorBy 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.
Parameters
- queries *GetCustomersCustomerBankAccountsIdQueries - Queries to be sent with the request
Return Type
- Bank_account|error - Successful response.
Deprecated
get customers/[string customer]/cards
DeprecatedIsolated FunctionResource Function
function get customers/[string customer]/cards(map<string|string[]> headers, *GetCustomersCustomerCardsQueries queries) returns CardList|errorYou can see a list of the cards belonging to a customer.
Note that the 10 most recent sources are always available on the Customer object.
If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional cards.
Parameters
- queries *GetCustomersCustomerCardsQueries - Queries to be sent with the request
Deprecated
get customers/[string customer]/cards/[string id]
DeprecatedIsolated FunctionResource Function
function get customers/[string customer]/cards/[string id](map<string|string[]> headers, *GetCustomersCustomerCardsIdQueries queries) returns Card|errorYou 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.
Parameters
- queries *GetCustomersCustomerCardsIdQueries - Queries to be sent with the request
Deprecated
get customers/[string customer]/cash_balance
Isolated FunctionResource Function
function get customers/[string customer]/cash_balance(map<string|string[]> headers, *GetCustomersCustomerCashBalanceQueries queries) returns Cash_balance|errorRetrieves a customer’s cash balance.
Parameters
- queries *GetCustomersCustomerCashBalanceQueries - Queries to be sent with the request
Return Type
- Cash_balance|error - Successful response.
get customers/[string customer]/cash_balance_transactions
Isolated FunctionResource Function
function get customers/[string customer]/cash_balance_transactions(map<string|string[]> headers, *GetCustomersCustomerCashBalanceTransactionsQueries queries) returns CustomerCashBalanceTransactionList|errorReturns a list of transactions that modified the customer’s cash balance.
Parameters
- queries *GetCustomersCustomerCashBalanceTransactionsQueries - Queries to be sent with the request
Return Type
- CustomerCashBalanceTransactionList|error - Successful response.
get customers/[string customer]/cash_balance_transactions/[string 'transaction]
Isolated FunctionResource Function
function get customers/[string customer]/cash_balance_transactions/[string 'transaction](map<string|string[]> headers, *GetCustomersCustomerCashBalanceTransactionsTransactionQueries queries) returns Customer_cash_balance_transaction|errorRetrieves a specific cash balance transaction, which updated the customer’s cash balance.
Parameters
- queries *GetCustomersCustomerCashBalanceTransactionsTransactionQueries - Queries to be sent with the request
Return Type
- Customer_cash_balance_transaction|error - Successful response.
get customers/[string customer]/discount
Isolated FunctionResource Function
function get customers/[string customer]/discount(map<string|string[]> headers, *GetCustomersCustomerDiscountQueries queries) returns Discount|errorParameters
- queries *GetCustomersCustomerDiscountQueries - Queries to be sent with the request
get customers/[string customer]/payment_methods
Isolated FunctionResource Function
function get customers/[string customer]/payment_methods(map<string|string[]> headers, *GetCustomersCustomerPaymentMethodsQueries queries) returns CustomerPaymentMethodResourceList|errorReturns a list of PaymentMethods for a given Customer
Parameters
- queries *GetCustomersCustomerPaymentMethodsQueries - Queries to be sent with the request
Return Type
- CustomerPaymentMethodResourceList|error - Successful response.
get customers/[string customer]/payment_methods/[string payment_method]
Isolated FunctionResource Function
function get customers/[string customer]/payment_methods/[string payment_method](map<string|string[]> headers, *GetCustomersCustomerPaymentMethodsPaymentMethodQueries queries) returns Payment_method|errorRetrieves a PaymentMethod object for a given Customer.
Parameters
- queries *GetCustomersCustomerPaymentMethodsPaymentMethodQueries - Queries to be sent with the request
Return Type
- Payment_method|error - Successful response.
get customers/[string customer]/sources
Isolated FunctionResource Function
function get customers/[string customer]/sources(map<string|string[]> headers, *GetCustomersCustomerSourcesQueries queries) returns ApmsSourcesSourceList|errorList sources for a specified customer.
Parameters
- queries *GetCustomersCustomerSourcesQueries - Queries to be sent with the request
Return Type
- ApmsSourcesSourceList|error - Successful response.
get customers/[string customer]/sources/[string id]
Isolated FunctionResource Function
function get customers/[string customer]/sources/[string id](map<string|string[]> headers, *GetCustomersCustomerSourcesIdQueries queries) returns Payment_source|errorRetrieve a specified source for a given customer.
Parameters
- queries *GetCustomersCustomerSourcesIdQueries - Queries to be sent with the request
Return Type
- Payment_source|error - Successful response.
get customers/[string customer]/subscriptions
Isolated FunctionResource Function
function get customers/[string customer]/subscriptions(map<string|string[]> headers, *GetCustomersCustomerSubscriptionsQueries queries) returns SubscriptionList|errorYou 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.
Parameters
- queries *GetCustomersCustomerSubscriptionsQueries - Queries to be sent with the request
Return Type
- SubscriptionList|error - Successful response.
get customers/[string customer]/subscriptions/[string subscription_exposed_id]
Isolated FunctionResource Function
function get customers/[string customer]/subscriptions/[string subscription_exposed_id](map<string|string[]> headers, *GetCustomersCustomerSubscriptionsSubscriptionExposedIdQueries queries) returns Subscription|errorRetrieves the subscription with the given ID.
Parameters
- queries *GetCustomersCustomerSubscriptionsSubscriptionExposedIdQueries - Queries to be sent with the request
Return Type
- Subscription|error - Successful response.
get customers/[string customer]/subscriptions/[string subscription_exposed_id]/discount
Isolated FunctionResource Function
function get customers/[string customer]/subscriptions/[string subscription_exposed_id]/discount(map<string|string[]> headers, *GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscountQueries queries) returns Discount|errorParameters
- queries *GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscountQueries - Queries to be sent with the request
get customers/[string customer]/tax_ids
Isolated FunctionResource Function
function get customers/[string customer]/tax_ids(map<string|string[]> headers, *GetCustomersCustomerTaxIdsQueries queries) returns TaxIDsList|errorReturns a list of tax IDs for a customer.
Parameters
- queries *GetCustomersCustomerTaxIdsQueries - Queries to be sent with the request
Return Type
- TaxIDsList|error - Successful response.
get customers/[string customer]/tax_ids/[string id]
Isolated FunctionResource Function
function get customers/[string customer]/tax_ids/[string id](map<string|string[]> headers, *GetCustomersCustomerTaxIdsIdQueries queries) returns Tax_id|errorRetrieves the tax_id object with the given identifier.
Parameters
- queries *GetCustomersCustomerTaxIdsIdQueries - Queries to be sent with the request
get customers/search
Isolated FunctionResource Function
function get customers/search(map<string|string[]> headers, *GetCustomersSearchQueries queries) returns SearchResult_1|errorSearch for customers you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.
Parameters
- queries *GetCustomersSearchQueries - Queries to be sent with the request
Return Type
- SearchResult_1|error - Successful response.
get disputes
Isolated FunctionResource Function
function get disputes(map<string|string[]> headers, *GetDisputesQueries queries) returns DisputeList|errorReturns a list of your disputes.
Parameters
- queries *GetDisputesQueries - Queries to be sent with the request
Return Type
- DisputeList|error - Successful response.
get disputes/[string dispute]
Isolated FunctionResource Function
function get disputes/[string dispute](map<string|string[]> headers, *GetDisputesDisputeQueries queries) returns Dispute|errorRetrieves the dispute with the given ID.
Parameters
- queries *GetDisputesDisputeQueries - Queries to be sent with the request
get entitlements/active_entitlements
Isolated FunctionResource Function
function get entitlements/active_entitlements(map<string|string[]> headers, *GetEntitlementsActiveEntitlementsQueries queries) returns EntitlementsResourceCustomerEntitlementList|errorRetrieve a list of active entitlements for a customer
Parameters
- queries *GetEntitlementsActiveEntitlementsQueries - Queries to be sent with the request
Return Type
- EntitlementsResourceCustomerEntitlementList|error - Successful response.
get entitlements/active_entitlements/[string id]
Isolated FunctionResource Function
function get entitlements/active_entitlements/[string id](map<string|string[]> headers, *GetEntitlementsActiveEntitlementsIdQueries queries) returns Entitlements\.active_entitlement|errorRetrieve an active entitlement
Parameters
- queries *GetEntitlementsActiveEntitlementsIdQueries - Queries to be sent with the request
Return Type
- Entitlements\.active_entitlement|error - Successful response.
get entitlements/features
Isolated FunctionResource Function
function get entitlements/features(map<string|string[]> headers, *GetEntitlementsFeaturesQueries queries) returns EntitlementsResourceFeatureList|errorRetrieve a list of features
Parameters
- queries *GetEntitlementsFeaturesQueries - Queries to be sent with the request
Return Type
- EntitlementsResourceFeatureList|error - Successful response.
get entitlements/features/[string id]
Isolated FunctionResource Function
function get entitlements/features/[string id](map<string|string[]> headers, *GetEntitlementsFeaturesIdQueries queries) returns Entitlements\.feature|errorRetrieves a feature
Parameters
- queries *GetEntitlementsFeaturesIdQueries - Queries to be sent with the request
Return Type
- Entitlements\.feature|error - Successful response.
get events
Isolated FunctionResource Function
function get events(map<string|string[]> headers, *GetEventsQueries queries) returns NotificationEventList|errorList 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).
Parameters
- queries *GetEventsQueries - Queries to be sent with the request
Return Type
- NotificationEventList|error - Successful response.
get events/[string id]
Isolated FunctionResource Function
function get events/[string id](map<string|string[]> headers, *GetEventsIdQueries queries) returns Event|errorRetrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.
Parameters
- queries *GetEventsIdQueries - Queries to be sent with the request
get exchange_rates
Isolated FunctionResource Function
function get exchange_rates(map<string|string[]> headers, *GetExchangeRatesQueries queries) returns ExchangeRateList|errorReturns 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.
Parameters
- queries *GetExchangeRatesQueries - Queries to be sent with the request
Return Type
- ExchangeRateList|error - Successful response.
get exchange_rates/[string rate_id]
Isolated FunctionResource Function
function get exchange_rates/[string rate_id](map<string|string[]> headers, *GetExchangeRatesRateIdQueries queries) returns Exchange_rate|errorRetrieves the exchange rates from the given currency to every supported currency.
Parameters
- queries *GetExchangeRatesRateIdQueries - Queries to be sent with the request
Return Type
- Exchange_rate|error - Successful response.
get file_links
Isolated FunctionResource Function
function get file_links(map<string|string[]> headers, *GetFileLinksQueries queries) returns FileResourceFileLinkList|errorReturns a list of file links.
Parameters
- queries *GetFileLinksQueries - Queries to be sent with the request
Return Type
- FileResourceFileLinkList|error - Successful response.
get file_links/[string link]
Isolated FunctionResource Function
function get file_links/[string link](map<string|string[]> headers, *GetFileLinksLinkQueries queries) returns File_link|errorRetrieves the file link with the given ID.
Parameters
- queries *GetFileLinksLinkQueries - Queries to be sent with the request
get files
Isolated FunctionResource Function
function get files(map<string|string[]> headers, *GetFilesQueries queries) returns FileResourceFileList|errorReturns 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.
Parameters
- queries *GetFilesQueries - Queries to be sent with the request
Return Type
- FileResourceFileList|error - Successful response.
get files/[string file]
Isolated FunctionResource Function
function get files/[string file](map<string|string[]> headers, *GetFilesFileQueries queries) returns File|errorRetrieves 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.
Parameters
- queries *GetFilesFileQueries - Queries to be sent with the request
get financial_connections/accounts
Isolated FunctionResource Function
function get financial_connections/accounts(map<string|string[]> headers, *GetFinancialConnectionsAccountsQueries queries) returns BankConnectionsResourceLinkedAccountList|errorReturns a list of Financial Connections Account objects.
Parameters
- queries *GetFinancialConnectionsAccountsQueries - Queries to be sent with the request
Return Type
- BankConnectionsResourceLinkedAccountList|error - Successful response.
get financial_connections/accounts/[string account]
Isolated FunctionResource Function
function get financial_connections/accounts/[string account](map<string|string[]> headers, *GetFinancialConnectionsAccountsAccountQueries queries) returns Financial_connections\.account|errorRetrieves the details of an Financial Connections Account.
Parameters
- queries *GetFinancialConnectionsAccountsAccountQueries - Queries to be sent with the request
Return Type
- Financial_connections\.account|error - Successful response.
get financial_connections/accounts/[string account]/owners
Isolated FunctionResource Function
function get financial_connections/accounts/[string account]/owners(map<string|string[]> headers, *GetFinancialConnectionsAccountsAccountOwnersQueries queries) returns BankConnectionsResourceOwnerList|errorLists all owners for a given Account
Parameters
- queries *GetFinancialConnectionsAccountsAccountOwnersQueries - Queries to be sent with the request
Return Type
- BankConnectionsResourceOwnerList|error - Successful response.
get financial_connections/sessions/[string session]
Isolated FunctionResource Function
function get financial_connections/sessions/[string session](map<string|string[]> headers, *GetFinancialConnectionsSessionsSessionQueries queries) returns Financial_connections\.session|errorRetrieves the details of a Financial Connections Session
Parameters
- queries *GetFinancialConnectionsSessionsSessionQueries - Queries to be sent with the request
Return Type
- Financial_connections\.session|error - Successful response.
get financial_connections/transactions
Isolated FunctionResource Function
function get financial_connections/transactions(map<string|string[]> headers, *GetFinancialConnectionsTransactionsQueries queries) returns BankConnectionsResourceTransactionList|errorReturns a list of Financial Connections Transaction objects.
Parameters
- queries *GetFinancialConnectionsTransactionsQueries - Queries to be sent with the request
Return Type
- BankConnectionsResourceTransactionList|error - Successful response.
get financial_connections/transactions/[string 'transaction]
Isolated FunctionResource Function
function get financial_connections/transactions/[string 'transaction](map<string|string[]> headers, *GetFinancialConnectionsTransactionsTransactionQueries queries) returns Financial_connections\.transaction|errorRetrieves the details of a Financial Connections Transaction
Parameters
- queries *GetFinancialConnectionsTransactionsTransactionQueries - Queries to be sent with the request
Return Type
- Financial_connections\.transaction|error - Successful response.
get forwarding/requests
Isolated FunctionResource Function
function get forwarding/requests(map<string|string[]> headers, *GetForwardingRequestsQueries queries) returns ForwardingRequestList|errorLists all ForwardingRequest objects.
Parameters
- queries *GetForwardingRequestsQueries - Queries to be sent with the request
Return Type
- ForwardingRequestList|error - Successful response.
get forwarding/requests/[string id]
Isolated FunctionResource Function
function get forwarding/requests/[string id](map<string|string[]> headers, *GetForwardingRequestsIdQueries queries) returns Forwarding\.request|errorRetrieves a ForwardingRequest object.
Parameters
- queries *GetForwardingRequestsIdQueries - Queries to be sent with the request
Return Type
- Forwarding\.request|error - Successful response.
get identity/verification_reports
Isolated FunctionResource Function
function get identity/verification_reports(map<string|string[]> headers, *GetIdentityVerificationReportsQueries queries) returns GelatoVerificationReportList|errorList all verification reports.
Parameters
- queries *GetIdentityVerificationReportsQueries - Queries to be sent with the request
Return Type
- GelatoVerificationReportList|error - Successful response.
get identity/verification_reports/[string report]
Isolated FunctionResource Function
function get identity/verification_reports/[string report](map<string|string[]> headers, *GetIdentityVerificationReportsReportQueries queries) returns Identity\.verification_report|errorRetrieves an existing VerificationReport
Parameters
- queries *GetIdentityVerificationReportsReportQueries - Queries to be sent with the request
Return Type
- Identity\.verification_report|error - Successful response.
get identity/verification_sessions
Isolated FunctionResource Function
function get identity/verification_sessions(map<string|string[]> headers, *GetIdentityVerificationSessionsQueries queries) returns GelatoVerificationSessionList|errorReturns a list of VerificationSessions
Parameters
- queries *GetIdentityVerificationSessionsQueries - Queries to be sent with the request
Return Type
- GelatoVerificationSessionList|error - Successful response.
get identity/verification_sessions/[string session]
Isolated FunctionResource Function
function get identity/verification_sessions/[string session](map<string|string[]> headers, *GetIdentityVerificationSessionsSessionQueries queries) returns Identity\.verification_session|errorRetrieves the details of a VerificationSession that was previously created.
When the session status is requires_input, you can use this method to retrieve a valid
client_secret or url to allow re-submission.
Parameters
- queries *GetIdentityVerificationSessionsSessionQueries - Queries to be sent with the request
Return Type
- Identity\.verification_session|error - Successful response.
get invoiceitems
Isolated FunctionResource Function
function get invoiceitems(map<string|string[]> headers, *GetInvoiceitemsQueries queries) returns InvoicesItemsList|errorReturns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.
Parameters
- queries *GetInvoiceitemsQueries - Queries to be sent with the request
Return Type
- InvoicesItemsList|error - Successful response.
get invoiceitems/[string invoiceitem]
Isolated FunctionResource Function
function get invoiceitems/[string invoiceitem](map<string|string[]> headers, *GetInvoiceitemsInvoiceitemQueries queries) returns Invoiceitem|errorRetrieves the invoice item with the given ID.
Parameters
- queries *GetInvoiceitemsInvoiceitemQueries - Queries to be sent with the request
Return Type
- Invoiceitem|error - Successful response.
get invoices
Isolated FunctionResource Function
function get invoices(map<string|string[]> headers, *GetInvoicesQueries queries) returns InvoicesResourceList|errorYou 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.
Parameters
- queries *GetInvoicesQueries - Queries to be sent with the request
Return Type
- InvoicesResourceList|error - Successful response.
get invoices/[string invoice]
Isolated FunctionResource Function
function get invoices/[string invoice](map<string|string[]> headers, *GetInvoicesInvoiceQueries queries) returns Invoice|errorRetrieves the invoice with the given ID.
Parameters
- queries *GetInvoicesInvoiceQueries - Queries to be sent with the request
get invoices/[string invoice]/lines
Isolated FunctionResource Function
function get invoices/[string invoice]/lines(map<string|string[]> headers, *GetInvoicesInvoiceLinesQueries queries) returns InvoiceLinesList|errorWhen 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.
Parameters
- queries *GetInvoicesInvoiceLinesQueries - Queries to be sent with the request
Return Type
- InvoiceLinesList|error - Successful response.
get invoices/search
Isolated FunctionResource Function
function get invoices/search(map<string|string[]> headers, *GetInvoicesSearchQueries queries) returns SearchResult_2|errorSearch for invoices you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.
Parameters
- queries *GetInvoicesSearchQueries - Queries to be sent with the request
Return Type
- SearchResult_2|error - Successful response.
get invoices/upcoming
Isolated FunctionResource Function
function get invoices/upcoming(map<string|string[]> headers, *GetInvoicesUpcomingQueries queries) returns Invoice|errorAt any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.
Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.
You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass 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.
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
Parameters
- queries *GetInvoicesUpcomingQueries - Queries to be sent with the request
get invoices/upcoming/lines
Isolated FunctionResource Function
function get invoices/upcoming/lines(map<string|string[]> headers, *GetInvoicesUpcomingLinesQueries queries) returns InvoiceLinesList|errorWhen 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.
Parameters
- queries *GetInvoicesUpcomingLinesQueries - Queries to be sent with the request
Return Type
- InvoiceLinesList|error - Successful response.
get issuing/authorizations
Isolated FunctionResource Function
function get issuing/authorizations(map<string|string[]> headers, *GetIssuingAuthorizationsQueries queries) returns IssuingAuthorizationList|errorReturns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Parameters
- queries *GetIssuingAuthorizationsQueries - Queries to be sent with the request
Return Type
- IssuingAuthorizationList|error - Successful response.
get issuing/authorizations/[string authorization]
Isolated FunctionResource Function
function get issuing/authorizations/[string authorization](map<string|string[]> headers, *GetIssuingAuthorizationsAuthorizationQueries queries) returns Issuing\.authorization|errorRetrieves an Issuing Authorization object.
Parameters
- queries *GetIssuingAuthorizationsAuthorizationQueries - Queries to be sent with the request
Return Type
- Issuing\.authorization|error - Successful response.
get issuing/cardholders
Isolated FunctionResource Function
function get issuing/cardholders(map<string|string[]> headers, *GetIssuingCardholdersQueries queries) returns IssuingCardholderList|errorReturns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Parameters
- queries *GetIssuingCardholdersQueries - Queries to be sent with the request
Return Type
- IssuingCardholderList|error - Successful response.
get issuing/cardholders/[string cardholder]
Isolated FunctionResource Function
function get issuing/cardholders/[string cardholder](map<string|string[]> headers, *GetIssuingCardholdersCardholderQueries queries) returns Issuing\.cardholder|errorRetrieves an Issuing Cardholder object.
Parameters
- queries *GetIssuingCardholdersCardholderQueries - Queries to be sent with the request
Return Type
- Issuing\.cardholder|error - Successful response.
get issuing/cards
Isolated FunctionResource Function
function get issuing/cards(map<string|string[]> headers, *GetIssuingCardsQueries queries) returns IssuingCardList|errorReturns a list of Issuing Card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Parameters
- queries *GetIssuingCardsQueries - Queries to be sent with the request
Return Type
- IssuingCardList|error - Successful response.
get issuing/cards/[string card]
Isolated FunctionResource Function
function get issuing/cards/[string card](map<string|string[]> headers, *GetIssuingCardsCardQueries queries) returns Issuing\.card|errorRetrieves an Issuing Card object.
Parameters
- queries *GetIssuingCardsCardQueries - Queries to be sent with the request
Return Type
- Issuing\.card|error - Successful response.
get issuing/disputes
Isolated FunctionResource Function
function get issuing/disputes(map<string|string[]> headers, *GetIssuingDisputesQueries queries) returns IssuingDisputeList|errorReturns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Parameters
- queries *GetIssuingDisputesQueries - Queries to be sent with the request
Return Type
- IssuingDisputeList|error - Successful response.
get issuing/disputes/[string dispute]
Isolated FunctionResource Function
function get issuing/disputes/[string dispute](map<string|string[]> headers, *GetIssuingDisputesDisputeQueries queries) returns Issuing\.dispute|errorRetrieves an Issuing Dispute object.
Parameters
- queries *GetIssuingDisputesDisputeQueries - Queries to be sent with the request
Return Type
- Issuing\.dispute|error - Successful response.
get issuing/personalization_designs
Isolated FunctionResource Function
function get issuing/personalization_designs(map<string|string[]> headers, *GetIssuingPersonalizationDesignsQueries queries) returns IssuingPersonalizationDesignList|errorReturns a list of personalization design objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Parameters
- queries *GetIssuingPersonalizationDesignsQueries - Queries to be sent with the request
Return Type
- IssuingPersonalizationDesignList|error - Successful response.
get issuing/personalization_designs/[string personalization_design]
Isolated FunctionResource Function
function get issuing/personalization_designs/[string personalization_design](map<string|string[]> headers, *GetIssuingPersonalizationDesignsPersonalizationDesignQueries queries) returns Issuing\.personalization_design|errorRetrieves a personalization design object.
Parameters
- queries *GetIssuingPersonalizationDesignsPersonalizationDesignQueries - Queries to be sent with the request
Return Type
- Issuing\.personalization_design|error - Successful response.
get issuing/physical_bundles
Isolated FunctionResource Function
function get issuing/physical_bundles(map<string|string[]> headers, *GetIssuingPhysicalBundlesQueries queries) returns IssuingPhysicalBundleList|errorReturns a list of physical bundle objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Parameters
- queries *GetIssuingPhysicalBundlesQueries - Queries to be sent with the request
Return Type
- IssuingPhysicalBundleList|error - Successful response.
get issuing/physical_bundles/[string physical_bundle]
Isolated FunctionResource Function
function get issuing/physical_bundles/[string physical_bundle](map<string|string[]> headers, *GetIssuingPhysicalBundlesPhysicalBundleQueries queries) returns Issuing\.physical_bundle|errorRetrieves a physical bundle object.
Parameters
- queries *GetIssuingPhysicalBundlesPhysicalBundleQueries - Queries to be sent with the request
Return Type
- Issuing\.physical_bundle|error - Successful response.
get issuing/settlements/[string settlement]
Isolated FunctionResource Function
function get issuing/settlements/[string settlement](map<string|string[]> headers, *GetIssuingSettlementsSettlementQueries queries) returns Issuing\.settlement|errorRetrieves an Issuing Settlement object.
Parameters
- queries *GetIssuingSettlementsSettlementQueries - Queries to be sent with the request
Return Type
- Issuing\.settlement|error - Successful response.
get issuing/tokens
Isolated FunctionResource Function
function get issuing/tokens(map<string|string[]> headers, *GetIssuingTokensQueries queries) returns IssuingNetworkTokenList|errorLists all Issuing Token objects for a given card.
Parameters
- queries *GetIssuingTokensQueries - Queries to be sent with the request
Return Type
- IssuingNetworkTokenList|error - Successful response.
get issuing/tokens/[string token]
Isolated FunctionResource Function
function get issuing/tokens/[string token](map<string|string[]> headers, *GetIssuingTokensTokenQueries queries) returns Issuing\.token|errorRetrieves an Issuing Token object.
Parameters
- queries *GetIssuingTokensTokenQueries - Queries to be sent with the request
Return Type
- Issuing\.token|error - Successful response.
get issuing/transactions
Isolated FunctionResource Function
function get issuing/transactions(map<string|string[]> headers, *GetIssuingTransactionsQueries queries) returns IssuingTransactionList|errorReturns a list of Issuing Transaction objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Parameters
- queries *GetIssuingTransactionsQueries - Queries to be sent with the request
Return Type
- IssuingTransactionList|error - Successful response.
get issuing/transactions/[string 'transaction]
Isolated FunctionResource Function
function get issuing/transactions/[string 'transaction](map<string|string[]> headers, *GetIssuingTransactionsTransactionQueries queries) returns Issuing\.transaction|errorRetrieves an Issuing Transaction object.
Parameters
- queries *GetIssuingTransactionsTransactionQueries - Queries to be sent with the request
Return Type
- Issuing\.transaction|error - Successful response.
get link_account_sessions/[string session]
Isolated FunctionResource Function
function get link_account_sessions/[string session](map<string|string[]> headers, *GetLinkAccountSessionsSessionQueries queries) returns Financial_connections\.session|errorRetrieves the details of a Financial Connections Session
Parameters
- queries *GetLinkAccountSessionsSessionQueries - Queries to be sent with the request
Return Type
- Financial_connections\.session|error - Successful response.
get linked_accounts
Isolated FunctionResource Function
function get linked_accounts(map<string|string[]> headers, *GetLinkedAccountsQueries queries) returns BankConnectionsResourceLinkedAccountList|errorReturns a list of Financial Connections Account objects.
Parameters
- queries *GetLinkedAccountsQueries - Queries to be sent with the request
Return Type
- BankConnectionsResourceLinkedAccountList|error - Successful response.
get linked_accounts/[string account]
Isolated FunctionResource Function
function get linked_accounts/[string account](map<string|string[]> headers, *GetLinkedAccountsAccountQueries queries) returns Financial_connections\.account|errorRetrieves the details of an Financial Connections Account.
Parameters
- queries *GetLinkedAccountsAccountQueries - Queries to be sent with the request
Return Type
- Financial_connections\.account|error - Successful response.
get linked_accounts/[string account]/owners
Isolated FunctionResource Function
function get linked_accounts/[string account]/owners(map<string|string[]> headers, *GetLinkedAccountsAccountOwnersQueries queries) returns BankConnectionsResourceOwnerList|errorLists all owners for a given Account
Parameters
- queries *GetLinkedAccountsAccountOwnersQueries - Queries to be sent with the request
Return Type
- BankConnectionsResourceOwnerList|error - Successful response.
get mandates/[string mandate]
Isolated FunctionResource Function
function get mandates/[string mandate](map<string|string[]> headers, *GetMandatesMandateQueries queries) returns Mandate|errorRetrieves a Mandate object.
Parameters
- queries *GetMandatesMandateQueries - Queries to be sent with the request
get payment_intents
Isolated FunctionResource Function
function get payment_intents(map<string|string[]> headers, *GetPaymentIntentsQueries queries) returns PaymentFlowsPaymentIntentList|errorReturns a list of PaymentIntents.
Parameters
- queries *GetPaymentIntentsQueries - Queries to be sent with the request
Return Type
- PaymentFlowsPaymentIntentList|error - Successful response.
get payment_intents/[string intent]
Isolated FunctionResource Function
function get payment_intents/[string intent](map<string|string[]> headers, *GetPaymentIntentsIntentQueries queries) returns Payment_intent|errorRetrieves the details of a PaymentIntent that has previously been created.
You can retrieve a PaymentIntent client-side using a publishable key when the client_secret is in the query string.
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.
Parameters
- queries *GetPaymentIntentsIntentQueries - Queries to be sent with the request
Return Type
- Payment_intent|error - Successful response.
get payment_intents/search
Isolated FunctionResource Function
function get payment_intents/search(map<string|string[]> headers, *GetPaymentIntentsSearchQueries queries) returns SearchResult_3|errorSearch for PaymentIntents you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.
Parameters
- queries *GetPaymentIntentsSearchQueries - Queries to be sent with the request
Return Type
- SearchResult_3|error - Successful response.
get payment_links
Isolated FunctionResource Function
function get payment_links(map<string|string[]> headers, *GetPaymentLinksQueries queries) returns PaymentLinksResourcePaymentLinkList|errorReturns a list of your payment links.
Parameters
- queries *GetPaymentLinksQueries - Queries to be sent with the request
Return Type
- PaymentLinksResourcePaymentLinkList|error - Successful response.
get payment_links/[string payment_link]
Isolated FunctionResource Function
function get payment_links/[string payment_link](map<string|string[]> headers, *GetPaymentLinksPaymentLinkQueries queries) returns Payment_link|errorRetrieve a payment link.
Parameters
- queries *GetPaymentLinksPaymentLinkQueries - Queries to be sent with the request
Return Type
- Payment_link|error - Successful response.
get payment_links/[string payment_link]/line_items
Isolated FunctionResource Function
function get payment_links/[string payment_link]/line_items(map<string|string[]> headers, *GetPaymentLinksPaymentLinkLineItemsQueries queries) returns PaymentLinksResourceListLineItems|errorWhen 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.
Parameters
- queries *GetPaymentLinksPaymentLinkLineItemsQueries - Queries to be sent with the request
Return Type
- PaymentLinksResourceListLineItems|error - Successful response.
get payment_method_configurations
Isolated FunctionResource Function
function get payment_method_configurations(map<string|string[]> headers, *GetPaymentMethodConfigurationsQueries queries) returns PaymentMethodConfigResourcePaymentMethodConfigurationsList|errorList payment method configurations
Parameters
- queries *GetPaymentMethodConfigurationsQueries - Queries to be sent with the request
Return Type
- PaymentMethodConfigResourcePaymentMethodConfigurationsList|error - Successful response.
get payment_method_configurations/[string configuration]
Isolated FunctionResource Function
function get payment_method_configurations/[string configuration](map<string|string[]> headers, *GetPaymentMethodConfigurationsConfigurationQueries queries) returns Payment_method_configuration|errorRetrieve payment method configuration
Parameters
- queries *GetPaymentMethodConfigurationsConfigurationQueries - Queries to be sent with the request
Return Type
- Payment_method_configuration|error - Successful response.
get payment_method_domains
Isolated FunctionResource Function
function get payment_method_domains(map<string|string[]> headers, *GetPaymentMethodDomainsQueries queries) returns PaymentMethodDomainResourcePaymentMethodDomainList|errorLists the details of existing payment method domains.
Parameters
- queries *GetPaymentMethodDomainsQueries - Queries to be sent with the request
Return Type
- PaymentMethodDomainResourcePaymentMethodDomainList|error - Successful response.
get payment_method_domains/[string payment_method_domain]
Isolated FunctionResource Function
function get payment_method_domains/[string payment_method_domain](map<string|string[]> headers, *GetPaymentMethodDomainsPaymentMethodDomainQueries queries) returns Payment_method_domain|errorRetrieves the details of an existing payment method domain.
Parameters
- queries *GetPaymentMethodDomainsPaymentMethodDomainQueries - Queries to be sent with the request
Return Type
- Payment_method_domain|error - Successful response.
get payment_methods
Isolated FunctionResource Function
function get payment_methods(map<string|string[]> headers, *GetPaymentMethodsQueries queries) returns PaymentFlowsPaymentMethodList|errorReturns 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.
Parameters
- queries *GetPaymentMethodsQueries - Queries to be sent with the request
Return Type
- PaymentFlowsPaymentMethodList|error - Successful response.
get payment_methods/[string payment_method]
Isolated FunctionResource Function
function get payment_methods/[string payment_method](map<string|string[]> headers, *GetPaymentMethodsPaymentMethodQueries queries) returns Payment_method|errorRetrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use Retrieve a Customer’s PaymentMethods
Parameters
- queries *GetPaymentMethodsPaymentMethodQueries - Queries to be sent with the request
Return Type
- Payment_method|error - Successful response.
get payouts
Isolated FunctionResource Function
function get payouts(map<string|string[]> headers, *GetPayoutsQueries queries) returns PayoutList|errorReturns 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.
Parameters
- queries *GetPayoutsQueries - Queries to be sent with the request
Return Type
- PayoutList|error - Successful response.
get payouts/[string payout]
Isolated FunctionResource Function
function get payouts/[string payout](map<string|string[]> headers, *GetPayoutsPayoutQueries queries) returns Payout|errorRetrieves 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.
Parameters
- queries *GetPayoutsPayoutQueries - Queries to be sent with the request
get plans
Isolated FunctionResource Function
Returns a list of your plans.
Parameters
- queries *GetPlansQueries - Queries to be sent with the request
get plans/[string plan]
Isolated FunctionResource Function
function get plans/[string plan](map<string|string[]> headers, *GetPlansPlanQueries queries) returns Plan|errorRetrieves the plan with the given ID.
Parameters
- queries *GetPlansPlanQueries - Queries to be sent with the request
get prices
Isolated FunctionResource Function
function get prices(map<string|string[]> headers, *GetPricesQueries queries) returns PriceList|errorReturns a list of your active prices, excluding inline prices. For the list of inactive prices, set active to false.
Parameters
- queries *GetPricesQueries - Queries to be sent with the request
get prices/[string price]
Isolated FunctionResource Function
function get prices/[string price](map<string|string[]> headers, *GetPricesPriceQueries queries) returns Price|errorRetrieves the price with the given ID.
Parameters
- queries *GetPricesPriceQueries - Queries to be sent with the request
get prices/search
Isolated FunctionResource Function
function get prices/search(map<string|string[]> headers, *GetPricesSearchQueries queries) returns SearchResult_4|errorSearch for prices you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.
Parameters
- queries *GetPricesSearchQueries - Queries to be sent with the request
Return Type
- SearchResult_4|error - Successful response.
get products
Isolated FunctionResource Function
function get products(map<string|string[]> headers, *GetProductsQueries queries) returns ProductList|errorReturns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.
Parameters
- queries *GetProductsQueries - Queries to be sent with the request
Return Type
- ProductList|error - Successful response.
get products/[string id]
Isolated FunctionResource Function
function get products/[string id](map<string|string[]> headers, *GetProductsIdQueries queries) returns Product|errorRetrieves 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.
Parameters
- queries *GetProductsIdQueries - Queries to be sent with the request
get products/[string product]/features
Isolated FunctionResource Function
function get products/[string product]/features(map<string|string[]> headers, *GetProductsProductFeaturesQueries queries) returns EntitlementsResourceProductFeatureList|errorRetrieve a list of features for a product
Parameters
- queries *GetProductsProductFeaturesQueries - Queries to be sent with the request
Return Type
- EntitlementsResourceProductFeatureList|error - Successful response.
get products/[string product]/features/[string id]
Isolated FunctionResource Function
function get products/[string product]/features/[string id](map<string|string[]> headers, *GetProductsProductFeaturesIdQueries queries) returns Product_feature|errorRetrieves a product_feature, which represents a feature attachment to a product
Parameters
- queries *GetProductsProductFeaturesIdQueries - Queries to be sent with the request
Return Type
- Product_feature|error - Successful response.
get products/search
Isolated FunctionResource Function
function get products/search(map<string|string[]> headers, *GetProductsSearchQueries queries) returns SearchResult_5|errorSearch for products you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.
Parameters
- queries *GetProductsSearchQueries - Queries to be sent with the request
Return Type
- SearchResult_5|error - Successful response.
get promotion_codes
Isolated FunctionResource Function
function get promotion_codes(map<string|string[]> headers, *GetPromotionCodesQueries queries) returns PromotionCodesResourcePromotionCodeList|errorReturns a list of your promotion codes.
Parameters
- queries *GetPromotionCodesQueries - Queries to be sent with the request
Return Type
- PromotionCodesResourcePromotionCodeList|error - Successful response.
get promotion_codes/[string promotion_code]
Isolated FunctionResource Function
function get promotion_codes/[string promotion_code](map<string|string[]> headers, *GetPromotionCodesPromotionCodeQueries queries) returns Promotion_code|errorRetrieves 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.
Parameters
- queries *GetPromotionCodesPromotionCodeQueries - Queries to be sent with the request
Return Type
- Promotion_code|error - Successful response.
get quotes
Isolated FunctionResource Function
function get quotes(map<string|string[]> headers, *GetQuotesQueries queries) returns QuotesResourceQuoteList|errorReturns a list of your quotes.
Parameters
- queries *GetQuotesQueries - Queries to be sent with the request
Return Type
- QuotesResourceQuoteList|error - Successful response.
get quotes/[string quote]
Isolated FunctionResource Function
function get quotes/[string quote](map<string|string[]> headers, *GetQuotesQuoteQueries queries) returns Quote|errorRetrieves the quote with the given ID.
Parameters
- queries *GetQuotesQuoteQueries - Queries to be sent with the request
get quotes/[string quote]/computed_upfront_line_items
Isolated FunctionResource Function
function get quotes/[string quote]/computed_upfront_line_items(map<string|string[]> headers, *GetQuotesQuoteComputedUpfrontLineItemsQueries queries) returns QuotesResourceListLineItems|errorWhen 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.
Parameters
- queries *GetQuotesQuoteComputedUpfrontLineItemsQueries - Queries to be sent with the request
Return Type
- QuotesResourceListLineItems|error - Successful response.
get quotes/[string quote]/line_items
Isolated FunctionResource Function
function get quotes/[string quote]/line_items(map<string|string[]> headers, *GetQuotesQuoteLineItemsQueries queries) returns QuotesResourceListLineItems|errorWhen 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.
Parameters
- queries *GetQuotesQuoteLineItemsQueries - Queries to be sent with the request
Return Type
- QuotesResourceListLineItems|error - Successful response.
get quotes/[string quote]/pdf
Isolated FunctionResource Function
function get quotes/[string quote]/pdf(map<string|string[]> headers, *GetQuotesQuotePdfQueries queries) returns Response|errorDownload the PDF for a finalized quote. Explanation for special handling can be found here
Parameters
- queries *GetQuotesQuotePdfQueries - Queries to be sent with the request
get radar/early_fraud_warnings
Isolated FunctionResource Function
function get radar/early_fraud_warnings(map<string|string[]> headers, *GetRadarEarlyFraudWarningsQueries queries) returns RadarEarlyFraudWarningList|errorReturns a list of early fraud warnings.
Parameters
- queries *GetRadarEarlyFraudWarningsQueries - Queries to be sent with the request
Return Type
- RadarEarlyFraudWarningList|error - Successful response.
get radar/early_fraud_warnings/[string early_fraud_warning]
Isolated FunctionResource Function
function get radar/early_fraud_warnings/[string early_fraud_warning](map<string|string[]> headers, *GetRadarEarlyFraudWarningsEarlyFraudWarningQueries queries) returns Radar\.early_fraud_warning|errorRetrieves the details of an early fraud warning that has previously been created.
Please refer to the early fraud warning object reference for more details.
Parameters
- queries *GetRadarEarlyFraudWarningsEarlyFraudWarningQueries - Queries to be sent with the request
Return Type
- Radar\.early_fraud_warning|error - Successful response.
get radar/value_list_items
Isolated FunctionResource Function
function get radar/value_list_items(map<string|string[]> headers, *GetRadarValueListItemsQueries queries) returns RadarListListItemList|errorReturns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Parameters
- queries *GetRadarValueListItemsQueries - Queries to be sent with the request
Return Type
- RadarListListItemList|error - Successful response.
get radar/value_list_items/[string item]
Isolated FunctionResource Function
function get radar/value_list_items/[string item](map<string|string[]> headers, *GetRadarValueListItemsItemQueries queries) returns Radar\.value_list_item|errorRetrieves a ValueListItem object.
Parameters
- queries *GetRadarValueListItemsItemQueries - Queries to be sent with the request
Return Type
- Radar\.value_list_item|error - Successful response.
get radar/value_lists
Isolated FunctionResource Function
function get radar/value_lists(map<string|string[]> headers, *GetRadarValueListsQueries queries) returns RadarListListList|errorReturns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Parameters
- queries *GetRadarValueListsQueries - Queries to be sent with the request
Return Type
- RadarListListList|error - Successful response.
get radar/value_lists/[string value_list]
Isolated FunctionResource Function
function get radar/value_lists/[string value_list](map<string|string[]> headers, *GetRadarValueListsValueListQueries queries) returns Radar\.value_list|errorRetrieves a ValueList object.
Parameters
- queries *GetRadarValueListsValueListQueries - Queries to be sent with the request
Return Type
- Radar\.value_list|error - Successful response.
get refunds
Isolated FunctionResource Function
function get refunds(map<string|string[]> headers, *GetRefundsQueries queries) returns APIMethodRefundList|errorReturns 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.
Parameters
- queries *GetRefundsQueries - Queries to be sent with the request
Return Type
- APIMethodRefundList|error - Successful response.
get refunds/[string refund]
Isolated FunctionResource Function
function get refunds/[string refund](map<string|string[]> headers, *GetRefundsRefundQueries queries) returns Refund|errorRetrieves the details of an existing refund.
Parameters
- queries *GetRefundsRefundQueries - Queries to be sent with the request
get reporting/report_runs
Isolated FunctionResource Function
function get reporting/report_runs(map<string|string[]> headers, *GetReportingReportRunsQueries queries) returns FinancialReportingFinanceReportRunList|errorReturns a list of Report Runs, with the most recent appearing first.
Parameters
- queries *GetReportingReportRunsQueries - Queries to be sent with the request
Return Type
- FinancialReportingFinanceReportRunList|error - Successful response.
get reporting/report_runs/[string report_run]
Isolated FunctionResource Function
function get reporting/report_runs/[string report_run](map<string|string[]> headers, *GetReportingReportRunsReportRunQueries queries) returns Reporting\.report_run|errorRetrieves the details of an existing Report Run.
Parameters
- queries *GetReportingReportRunsReportRunQueries - Queries to be sent with the request
Return Type
- Reporting\.report_run|error - Successful response.
get reporting/report_types
Isolated FunctionResource Function
function get reporting/report_types(map<string|string[]> headers, *GetReportingReportTypesQueries queries) returns FinancialReportingFinanceReportTypeList|errorReturns a full list of Report Types.
Parameters
- queries *GetReportingReportTypesQueries - Queries to be sent with the request
Return Type
- FinancialReportingFinanceReportTypeList|error - Successful response.
get reporting/report_types/[string report_type]
Isolated FunctionResource Function
function get reporting/report_types/[string report_type](map<string|string[]> headers, *GetReportingReportTypesReportTypeQueries queries) returns Reporting\.report_type|errorRetrieves the details of a Report Type. (Certain report types require a live-mode API key.)
Parameters
- queries *GetReportingReportTypesReportTypeQueries - Queries to be sent with the request
Return Type
- Reporting\.report_type|error - Successful response.
get reviews
Isolated FunctionResource Function
function get reviews(map<string|string[]> headers, *GetReviewsQueries queries) returns RadarReviewList|errorReturns 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.
Parameters
- queries *GetReviewsQueries - Queries to be sent with the request
Return Type
- RadarReviewList|error - Successful response.
get reviews/[string review]
Isolated FunctionResource Function
function get reviews/[string review](map<string|string[]> headers, *GetReviewsReviewQueries queries) returns Review|errorRetrieves a Review object.
Parameters
- queries *GetReviewsReviewQueries - Queries to be sent with the request
get setup_attempts
Isolated FunctionResource Function
function get setup_attempts(map<string|string[]> headers, *GetSetupAttemptsQueries queries) returns PaymentFlowsSetupIntentSetupAttemptList|errorReturns a list of SetupAttempts that associate with a provided SetupIntent.
Parameters
- queries *GetSetupAttemptsQueries - Queries to be sent with the request
Return Type
- PaymentFlowsSetupIntentSetupAttemptList|error - Successful response.
get setup_intents
Isolated FunctionResource Function
function get setup_intents(map<string|string[]> headers, *GetSetupIntentsQueries queries) returns PaymentFlowsSetupIntentList|errorReturns a list of SetupIntents.
Parameters
- queries *GetSetupIntentsQueries - Queries to be sent with the request
Return Type
- PaymentFlowsSetupIntentList|error - Successful response.
get setup_intents/[string intent]
Isolated FunctionResource Function
function get setup_intents/[string intent](map<string|string[]> headers, *GetSetupIntentsIntentQueries queries) returns Setup_intent|errorRetrieves the details of a SetupIntent that has previously been created.
Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string.
When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the SetupIntent object reference for more details.
Parameters
- queries *GetSetupIntentsIntentQueries - Queries to be sent with the request
Return Type
- Setup_intent|error - Successful response.
get shipping_rates
Isolated FunctionResource Function
function get shipping_rates(map<string|string[]> headers, *GetShippingRatesQueries queries) returns ShippingResourcesShippingRateList|errorReturns a list of your shipping rates.
Parameters
- queries *GetShippingRatesQueries - Queries to be sent with the request
Return Type
- ShippingResourcesShippingRateList|error - Successful response.
get shipping_rates/[string shipping_rate_token]
Isolated FunctionResource Function
function get shipping_rates/[string shipping_rate_token](map<string|string[]> headers, *GetShippingRatesShippingRateTokenQueries queries) returns Shipping_rate|errorReturns the shipping rate object with the given ID.
Parameters
- queries *GetShippingRatesShippingRateTokenQueries - Queries to be sent with the request
Return Type
- Shipping_rate|error - Successful response.
get sigma/scheduled_query_runs
Isolated FunctionResource Function
function get sigma/scheduled_query_runs(map<string|string[]> headers, *GetSigmaScheduledQueryRunsQueries queries) returns SigmaScheduledQueryRunList|errorReturns a list of scheduled query runs.
Parameters
- queries *GetSigmaScheduledQueryRunsQueries - Queries to be sent with the request
Return Type
- SigmaScheduledQueryRunList|error - Successful response.
get sigma/scheduled_query_runs/[string scheduled_query_run]
Isolated FunctionResource Function
function get sigma/scheduled_query_runs/[string scheduled_query_run](map<string|string[]> headers, *GetSigmaScheduledQueryRunsScheduledQueryRunQueries queries) returns Scheduled_query_run|errorRetrieves the details of an scheduled query run.
Parameters
- queries *GetSigmaScheduledQueryRunsScheduledQueryRunQueries - Queries to be sent with the request
Return Type
- Scheduled_query_run|error - Successful response.
get sources/[string 'source]
Isolated FunctionResource Function
function get sources/[string 'source](map<string|string[]> headers, *GetSourcesSourceQueries queries) returns Source|errorRetrieves 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.
Parameters
- queries *GetSourcesSourceQueries - Queries to be sent with the request
get sources/[string 'source]/mandate_notifications/[string mandate_notification]
Isolated FunctionResource Function
function get sources/[string 'source]/mandate_notifications/[string mandate_notification](map<string|string[]> headers, *GetSourcesSourceMandateNotificationsMandateNotificationQueries queries) returns Source_mandate_notification|errorRetrieves a new Source MandateNotification.
Parameters
- queries *GetSourcesSourceMandateNotificationsMandateNotificationQueries - Queries to be sent with the request
Return Type
- Source_mandate_notification|error - Successful response.
get sources/[string 'source]/source_transactions
Isolated FunctionResource Function
function get sources/[string 'source]/source_transactions(map<string|string[]> headers, *GetSourcesSourceSourceTransactionsQueries queries) returns ApmsSourcesSourceTransactionList|errorList source transactions for a given source.
Parameters
- queries *GetSourcesSourceSourceTransactionsQueries - Queries to be sent with the request
Return Type
- ApmsSourcesSourceTransactionList|error - Successful response.
get sources/[string 'source]/source_transactions/[string source_transaction]
Isolated FunctionResource Function
function get sources/[string 'source]/source_transactions/[string source_transaction](map<string|string[]> headers, *GetSourcesSourceSourceTransactionsSourceTransactionQueries queries) returns Source_transaction|errorRetrieve 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.
Parameters
- queries *GetSourcesSourceSourceTransactionsSourceTransactionQueries - Queries to be sent with the request
Return Type
- Source_transaction|error - Successful response.
get subscription_items
Isolated FunctionResource Function
function get subscription_items(map<string|string[]> headers, *GetSubscriptionItemsQueries queries) returns SubscriptionsItemsSubscriptionItemList|errorReturns a list of your subscription items for a given subscription.
Parameters
- queries *GetSubscriptionItemsQueries - Queries to be sent with the request
Return Type
- SubscriptionsItemsSubscriptionItemList|error - Successful response.
get subscription_items/[string item]
Isolated FunctionResource Function
function get subscription_items/[string item](map<string|string[]> headers, *GetSubscriptionItemsItemQueries queries) returns Subscription_item|errorRetrieves the subscription item with the given ID.
Parameters
- queries *GetSubscriptionItemsItemQueries - Queries to be sent with the request
Return Type
- Subscription_item|error - Successful response.
get subscription_items/[string subscription_item]/usage_record_summaries
Isolated FunctionResource Function
function get subscription_items/[string subscription_item]/usage_record_summaries(map<string|string[]> headers, *GetSubscriptionItemsSubscriptionItemUsageRecordSummariesQueries queries) returns UsageEventsResourceUsageRecordSummaryList|errorFor the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).
The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn’t ended yet. Since new usage records can still be added, the returned summary information for the subscription item’s ID should be seen as unstable until the subscription billing period ends.
Parameters
- queries *GetSubscriptionItemsSubscriptionItemUsageRecordSummariesQueries - Queries to be sent with the request
Return Type
- UsageEventsResourceUsageRecordSummaryList|error - Successful response.
get subscription_schedules
Isolated FunctionResource Function
function get subscription_schedules(map<string|string[]> headers, *GetSubscriptionSchedulesQueries queries) returns SubscriptionSchedulesResourceScheduleList|errorRetrieves the list of your subscription schedules.
Parameters
- queries *GetSubscriptionSchedulesQueries - Queries to be sent with the request
Return Type
- SubscriptionSchedulesResourceScheduleList|error - Successful response.
get subscription_schedules/[string schedule]
Isolated FunctionResource Function
function get subscription_schedules/[string schedule](map<string|string[]> headers, *GetSubscriptionSchedulesScheduleQueries queries) returns Subscription_schedule|errorRetrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.
Parameters
- queries *GetSubscriptionSchedulesScheduleQueries - Queries to be sent with the request
Return Type
- Subscription_schedule|error - Successful response.
get subscriptions
Isolated FunctionResource Function
function get subscriptions(map<string|string[]> headers, *GetSubscriptionsQueries queries) returns SubscriptionsSubscriptionList|errorBy default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.
Parameters
- queries *GetSubscriptionsQueries - Queries to be sent with the request
Return Type
- SubscriptionsSubscriptionList|error - Successful response.
get subscriptions/[string subscription_exposed_id]
Isolated FunctionResource Function
function get subscriptions/[string subscription_exposed_id](map<string|string[]> headers, *GetSubscriptionsSubscriptionExposedIdQueries queries) returns Subscription|errorRetrieves the subscription with the given ID.
Parameters
- queries *GetSubscriptionsSubscriptionExposedIdQueries - Queries to be sent with the request
Return Type
- Subscription|error - Successful response.
get subscriptions/search
Isolated FunctionResource Function
function get subscriptions/search(map<string|string[]> headers, *GetSubscriptionsSearchQueries queries) returns SearchResult_6|errorSearch for subscriptions you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.
Parameters
- queries *GetSubscriptionsSearchQueries - Queries to be sent with the request
Return Type
- SearchResult_6|error - Successful response.
get tax/calculations/[string calculation]/line_items
Isolated FunctionResource Function
function get tax/calculations/[string calculation]/line_items(map<string|string[]> headers, *GetTaxCalculationsCalculationLineItemsQueries queries) returns TaxProductResourceTaxCalculationLineItemList|errorRetrieves the line items of a tax calculation as a collection, if the calculation hasn’t expired.
Parameters
- queries *GetTaxCalculationsCalculationLineItemsQueries - Queries to be sent with the request
Return Type
- TaxProductResourceTaxCalculationLineItemList|error - Successful response.
get tax/registrations
Isolated FunctionResource Function
function get tax/registrations(map<string|string[]> headers, *GetTaxRegistrationsQueries queries) returns TaxProductRegistrationsResourceTaxRegistrationList|errorReturns a list of Tax Registration objects.
Parameters
- queries *GetTaxRegistrationsQueries - Queries to be sent with the request
Return Type
- TaxProductRegistrationsResourceTaxRegistrationList|error - Successful response.
get tax/registrations/[string id]
Isolated FunctionResource Function
function get tax/registrations/[string id](map<string|string[]> headers, *GetTaxRegistrationsIdQueries queries) returns Tax\.registration|errorReturns a Tax Registration object.
Parameters
- queries *GetTaxRegistrationsIdQueries - Queries to be sent with the request
Return Type
- Tax\.registration|error - Successful response.
get tax/settings
Isolated FunctionResource Function
function get tax/settings(map<string|string[]> headers, *GetTaxSettingsQueries queries) returns Tax\.settings|errorRetrieves Tax Settings for a merchant.
Parameters
- queries *GetTaxSettingsQueries - Queries to be sent with the request
Return Type
- Tax\.settings|error - Successful response.
get tax/transactions/[string 'transaction]
Isolated FunctionResource Function
function get tax/transactions/[string 'transaction](map<string|string[]> headers, *GetTaxTransactionsTransactionQueries queries) returns Tax\.transaction|errorRetrieves a Tax Transaction object.
Parameters
- queries *GetTaxTransactionsTransactionQueries - Queries to be sent with the request
Return Type
- Tax\.transaction|error - Successful response.
get tax/transactions/[string 'transaction]/line_items
Isolated FunctionResource Function
function get tax/transactions/[string 'transaction]/line_items(map<string|string[]> headers, *GetTaxTransactionsTransactionLineItemsQueries queries) returns TaxProductResourceTaxTransactionLineItemList|errorRetrieves the line items of a committed standalone transaction as a collection.
Parameters
- queries *GetTaxTransactionsTransactionLineItemsQueries - Queries to be sent with the request
Return Type
- TaxProductResourceTaxTransactionLineItemList|error - Successful response.
get tax_codes
Isolated FunctionResource Function
function get tax_codes(map<string|string[]> headers, *GetTaxCodesQueries queries) returns TaxProductResourceTaxCodeList|errorA list of all tax codes available to add to Products in order to allow specific tax calculations.
Parameters
- queries *GetTaxCodesQueries - Queries to be sent with the request
Return Type
- TaxProductResourceTaxCodeList|error - Successful response.
get tax_codes/[string id]
Isolated FunctionResource Function
function get tax_codes/[string id](map<string|string[]> headers, *GetTaxCodesIdQueries queries) returns Tax_code|errorRetrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.
Parameters
- queries *GetTaxCodesIdQueries - Queries to be sent with the request
get tax_ids
Isolated FunctionResource Function
function get tax_ids(map<string|string[]> headers, *GetTaxIdsQueries queries) returns TaxIDsList|errorReturns a list of tax IDs.
Parameters
- queries *GetTaxIdsQueries - Queries to be sent with the request
Return Type
- TaxIDsList|error - Successful response.
get tax_ids/[string id]
Isolated FunctionResource Function
function get tax_ids/[string id](map<string|string[]> headers, *GetTaxIdsIdQueries queries) returns Tax_id|errorRetrieves an account or customer tax_id object.
Parameters
- queries *GetTaxIdsIdQueries - Queries to be sent with the request
get tax_rates
Isolated FunctionResource Function
function get tax_rates(map<string|string[]> headers, *GetTaxRatesQueries queries) returns TaxRatesList|errorReturns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.
Parameters
- queries *GetTaxRatesQueries - Queries to be sent with the request
Return Type
- TaxRatesList|error - Successful response.
get tax_rates/[string tax_rate]
Isolated FunctionResource Function
function get tax_rates/[string tax_rate](map<string|string[]> headers, *GetTaxRatesTaxRateQueries queries) returns Tax_rate|errorRetrieves a tax rate with the given ID
Parameters
- queries *GetTaxRatesTaxRateQueries - Queries to be sent with the request
get terminal/configurations
Isolated FunctionResource Function
function get terminal/configurations(map<string|string[]> headers, *GetTerminalConfigurationsQueries queries) returns TerminalConfigurationConfigurationList|errorReturns a list of Configuration objects.
Parameters
- queries *GetTerminalConfigurationsQueries - Queries to be sent with the request
Return Type
- TerminalConfigurationConfigurationList|error - Successful response.
get terminal/configurations/[string configuration]
Isolated FunctionResource Function
function get terminal/configurations/[string configuration](map<string|string[]> headers, *GetTerminalConfigurationsConfigurationQueries queries) returns inline_response_200_3|errorRetrieves a Configuration object.
Parameters
- queries *GetTerminalConfigurationsConfigurationQueries - Queries to be sent with the request
Return Type
- inline_response_200_3|error - Successful response.
get terminal/locations
Isolated FunctionResource Function
function get terminal/locations(map<string|string[]> headers, *GetTerminalLocationsQueries queries) returns TerminalLocationLocationList|errorReturns a list of Location objects.
Parameters
- queries *GetTerminalLocationsQueries - Queries to be sent with the request
Return Type
- TerminalLocationLocationList|error - Successful response.
get terminal/locations/[string location]
Isolated FunctionResource Function
function get terminal/locations/[string location](map<string|string[]> headers, *GetTerminalLocationsLocationQueries queries) returns inline_response_200_4|errorRetrieves a Location object.
Parameters
- queries *GetTerminalLocationsLocationQueries - Queries to be sent with the request
Return Type
- inline_response_200_4|error - Successful response.
get terminal/readers
Isolated FunctionResource Function
function get terminal/readers(map<string|string[]> headers, *GetTerminalReadersQueries queries) returns TerminalReaderRetrieveReader|errorReturns a list of Reader objects.
Parameters
- queries *GetTerminalReadersQueries - Queries to be sent with the request
Return Type
- TerminalReaderRetrieveReader|error - Successful response.
get terminal/readers/[string reader]
Isolated FunctionResource Function
function get terminal/readers/[string reader](map<string|string[]> headers, *GetTerminalReadersReaderQueries queries) returns inline_response_200_5|errorRetrieves a Reader object.
Parameters
- queries *GetTerminalReadersReaderQueries - Queries to be sent with the request
Return Type
- inline_response_200_5|error - Successful response.
get test_helpers/test_clocks
Isolated FunctionResource Function
function get test_helpers/test_clocks(map<string|string[]> headers, *GetTestHelpersTestClocksQueries queries) returns BillingClocksResourceBillingClockList|errorReturns a list of your test clocks.
Parameters
- queries *GetTestHelpersTestClocksQueries - Queries to be sent with the request
Return Type
- BillingClocksResourceBillingClockList|error - Successful response.
get test_helpers/test_clocks/[string test_clock]
Isolated FunctionResource Function
function get test_helpers/test_clocks/[string test_clock](map<string|string[]> headers, *GetTestHelpersTestClocksTestClockQueries queries) returns Test_helpers\.test_clock|errorRetrieves a test clock.
Parameters
- queries *GetTestHelpersTestClocksTestClockQueries - Queries to be sent with the request
Return Type
- Test_helpers\.test_clock|error - Successful response.
get tokens/[string token]
Isolated FunctionResource Function
function get tokens/[string token](map<string|string[]> headers, *GetTokensTokenQueries queries) returns Token|errorRetrieves the token with the given ID.
Parameters
- queries *GetTokensTokenQueries - Queries to be sent with the request
get topups
Isolated FunctionResource Function
function get topups(map<string|string[]> headers, *GetTopupsQueries queries) returns TopupList|errorReturns a list of top-ups.
Parameters
- queries *GetTopupsQueries - Queries to be sent with the request
get topups/[string topup]
Isolated FunctionResource Function
function get topups/[string topup](map<string|string[]> headers, *GetTopupsTopupQueries queries) returns Topup|errorRetrieves 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.
Parameters
- queries *GetTopupsTopupQueries - Queries to be sent with the request
get transfers
Isolated FunctionResource Function
function get transfers(map<string|string[]> headers, *GetTransfersQueries queries) returns TransferList|errorReturns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.
Parameters
- queries *GetTransfersQueries - Queries to be sent with the request
Return Type
- TransferList|error - Successful response.
get transfers/[string id]/reversals
Isolated FunctionResource Function
function get transfers/[string id]/reversals(map<string|string[]> headers, *GetTransfersIdReversalsQueries queries) returns TransferReversalList|errorYou 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.
Parameters
- queries *GetTransfersIdReversalsQueries - Queries to be sent with the request
Return Type
- TransferReversalList|error - Successful response.
get transfers/[string transfer]
Isolated FunctionResource Function
function get transfers/[string transfer](map<string|string[]> headers, *GetTransfersTransferQueries queries) returns Transfer|errorRetrieves 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.
Parameters
- queries *GetTransfersTransferQueries - Queries to be sent with the request
get transfers/[string transfer]/reversals/[string id]
Isolated FunctionResource Function
function get transfers/[string transfer]/reversals/[string id](map<string|string[]> headers, *GetTransfersTransferReversalsIdQueries queries) returns Transfer_reversal|errorBy 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.
Parameters
- queries *GetTransfersTransferReversalsIdQueries - Queries to be sent with the request
Return Type
- Transfer_reversal|error - Successful response.
get treasury/credit_reversals
Isolated FunctionResource Function
function get treasury/credit_reversals(map<string|string[]> headers, *GetTreasuryCreditReversalsQueries queries) returns TreasuryReceivedCreditsResourceCreditReversalList|errorReturns a list of CreditReversals.
Parameters
- queries *GetTreasuryCreditReversalsQueries - Queries to be sent with the request
Return Type
- TreasuryReceivedCreditsResourceCreditReversalList|error - Successful response.
get treasury/credit_reversals/[string credit_reversal]
Isolated FunctionResource Function
function get treasury/credit_reversals/[string credit_reversal](map<string|string[]> headers, *GetTreasuryCreditReversalsCreditReversalQueries queries) returns Treasury\.credit_reversal|errorRetrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list
Parameters
- queries *GetTreasuryCreditReversalsCreditReversalQueries - Queries to be sent with the request
Return Type
- Treasury\.credit_reversal|error - Successful response.
get treasury/debit_reversals
Isolated FunctionResource Function
function get treasury/debit_reversals(map<string|string[]> headers, *GetTreasuryDebitReversalsQueries queries) returns TreasuryReceivedDebitsResourceDebitReversalList|errorReturns a list of DebitReversals.
Parameters
- queries *GetTreasuryDebitReversalsQueries - Queries to be sent with the request
Return Type
- TreasuryReceivedDebitsResourceDebitReversalList|error - Successful response.
get treasury/debit_reversals/[string debit_reversal]
Isolated FunctionResource Function
function get treasury/debit_reversals/[string debit_reversal](map<string|string[]> headers, *GetTreasuryDebitReversalsDebitReversalQueries queries) returns Treasury\.debit_reversal|errorRetrieves a DebitReversal object.
Parameters
- queries *GetTreasuryDebitReversalsDebitReversalQueries - Queries to be sent with the request
Return Type
- Treasury\.debit_reversal|error - Successful response.
get treasury/financial_accounts
Isolated FunctionResource Function
function get treasury/financial_accounts(map<string|string[]> headers, *GetTreasuryFinancialAccountsQueries queries) returns TreasuryFinancialAccountsResourceFinancialAccountList|errorReturns a list of FinancialAccounts.
Parameters
- queries *GetTreasuryFinancialAccountsQueries - Queries to be sent with the request
Return Type
- TreasuryFinancialAccountsResourceFinancialAccountList|error - Successful response.
get treasury/financial_accounts/[string financial_account]
Isolated FunctionResource Function
function get treasury/financial_accounts/[string financial_account](map<string|string[]> headers, *GetTreasuryFinancialAccountsFinancialAccountQueries queries) returns Treasury\.financial_account|errorRetrieves the details of a FinancialAccount.
Parameters
- queries *GetTreasuryFinancialAccountsFinancialAccountQueries - Queries to be sent with the request
Return Type
- Treasury\.financial_account|error - Successful response.
get treasury/financial_accounts/[string financial_account]/features
Isolated FunctionResource Function
function get treasury/financial_accounts/[string financial_account]/features(map<string|string[]> headers, *GetTreasuryFinancialAccountsFinancialAccountFeaturesQueries queries) returns Treasury\.financial_account_features|errorRetrieves Features information associated with the FinancialAccount.
Parameters
- queries *GetTreasuryFinancialAccountsFinancialAccountFeaturesQueries - Queries to be sent with the request
Return Type
- Treasury\.financial_account_features|error - Successful response.
get treasury/inbound_transfers
Isolated FunctionResource Function
function get treasury/inbound_transfers(map<string|string[]> headers, *GetTreasuryInboundTransfersQueries queries) returns TreasuryInboundTransfersResourceInboundTransferList|errorReturns a list of InboundTransfers sent from the specified FinancialAccount.
Parameters
- queries *GetTreasuryInboundTransfersQueries - Queries to be sent with the request
Return Type
- TreasuryInboundTransfersResourceInboundTransferList|error - Successful response.
get treasury/inbound_transfers/[string id]
Isolated FunctionResource Function
function get treasury/inbound_transfers/[string id](map<string|string[]> headers, *GetTreasuryInboundTransfersIdQueries queries) returns Treasury\.inbound_transfer|errorRetrieves the details of an existing InboundTransfer.
Parameters
- queries *GetTreasuryInboundTransfersIdQueries - Queries to be sent with the request
Return Type
- Treasury\.inbound_transfer|error - Successful response.
get treasury/outbound_payments
Isolated FunctionResource Function
function get treasury/outbound_payments(map<string|string[]> headers, *GetTreasuryOutboundPaymentsQueries queries) returns TreasuryOutboundPaymentsResourceOutboundPaymentList|errorReturns a list of OutboundPayments sent from the specified FinancialAccount.
Parameters
- queries *GetTreasuryOutboundPaymentsQueries - Queries to be sent with the request
Return Type
- TreasuryOutboundPaymentsResourceOutboundPaymentList|error - Successful response.
get treasury/outbound_payments/[string id]
Isolated FunctionResource Function
function get treasury/outbound_payments/[string id](map<string|string[]> headers, *GetTreasuryOutboundPaymentsIdQueries queries) returns Treasury\.outbound_payment|errorRetrieves the details of an existing OutboundPayment by passing the unique OutboundPayment ID from either the OutboundPayment creation request or OutboundPayment list.
Parameters
- queries *GetTreasuryOutboundPaymentsIdQueries - Queries to be sent with the request
Return Type
- Treasury\.outbound_payment|error - Successful response.
get treasury/outbound_transfers
Isolated FunctionResource Function
function get treasury/outbound_transfers(map<string|string[]> headers, *GetTreasuryOutboundTransfersQueries queries) returns TreasuryOutboundTransfersResourceOutboundTransferList|errorReturns a list of OutboundTransfers sent from the specified FinancialAccount.
Parameters
- queries *GetTreasuryOutboundTransfersQueries - Queries to be sent with the request
Return Type
- TreasuryOutboundTransfersResourceOutboundTransferList|error - Successful response.
get treasury/outbound_transfers/[string outbound_transfer]
Isolated FunctionResource Function
function get treasury/outbound_transfers/[string outbound_transfer](map<string|string[]> headers, *GetTreasuryOutboundTransfersOutboundTransferQueries queries) returns Treasury\.outbound_transfer|errorRetrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.
Parameters
- queries *GetTreasuryOutboundTransfersOutboundTransferQueries - Queries to be sent with the request
Return Type
- Treasury\.outbound_transfer|error - Successful response.
get treasury/received_credits
Isolated FunctionResource Function
function get treasury/received_credits(map<string|string[]> headers, *GetTreasuryReceivedCreditsQueries queries) returns TreasuryReceivedCreditsResourceReceivedCreditList|errorReturns a list of ReceivedCredits.
Parameters
- queries *GetTreasuryReceivedCreditsQueries - Queries to be sent with the request
Return Type
- TreasuryReceivedCreditsResourceReceivedCreditList|error - Successful response.
get treasury/received_credits/[string id]
Isolated FunctionResource Function
function get treasury/received_credits/[string id](map<string|string[]> headers, *GetTreasuryReceivedCreditsIdQueries queries) returns Treasury\.received_credit|errorRetrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.
Parameters
- queries *GetTreasuryReceivedCreditsIdQueries - Queries to be sent with the request
Return Type
- Treasury\.received_credit|error - Successful response.
get treasury/received_debits
Isolated FunctionResource Function
function get treasury/received_debits(map<string|string[]> headers, *GetTreasuryReceivedDebitsQueries queries) returns TreasuryReceivedDebitsResourceReceivedDebitList|errorReturns a list of ReceivedDebits.
Parameters
- queries *GetTreasuryReceivedDebitsQueries - Queries to be sent with the request
Return Type
- TreasuryReceivedDebitsResourceReceivedDebitList|error - Successful response.
get treasury/received_debits/[string id]
Isolated FunctionResource Function
function get treasury/received_debits/[string id](map<string|string[]> headers, *GetTreasuryReceivedDebitsIdQueries queries) returns Treasury\.received_debit|errorRetrieves the details of an existing ReceivedDebit by passing the unique ReceivedDebit ID from the ReceivedDebit list
Parameters
- queries *GetTreasuryReceivedDebitsIdQueries - Queries to be sent with the request
Return Type
- Treasury\.received_debit|error - Successful response.
get treasury/transaction_entries
Isolated FunctionResource Function
function get treasury/transaction_entries(map<string|string[]> headers, *GetTreasuryTransactionEntriesQueries queries) returns TreasuryTransactionsResourceTransactionEntryList|errorRetrieves a list of TransactionEntry objects.
Parameters
- queries *GetTreasuryTransactionEntriesQueries - Queries to be sent with the request
Return Type
- TreasuryTransactionsResourceTransactionEntryList|error - Successful response.
get treasury/transaction_entries/[string id]
Isolated FunctionResource Function
function get treasury/transaction_entries/[string id](map<string|string[]> headers, *GetTreasuryTransactionEntriesIdQueries queries) returns Treasury\.transaction_entry|errorRetrieves a TransactionEntry object.
Parameters
- queries *GetTreasuryTransactionEntriesIdQueries - Queries to be sent with the request
Return Type
- Treasury\.transaction_entry|error - Successful response.
get treasury/transactions
Isolated FunctionResource Function
function get treasury/transactions(map<string|string[]> headers, *GetTreasuryTransactionsQueries queries) returns TreasuryTransactionsResourceTransactionList|errorRetrieves a list of Transaction objects.
Parameters
- queries *GetTreasuryTransactionsQueries - Queries to be sent with the request
Return Type
- TreasuryTransactionsResourceTransactionList|error - Successful response.
get treasury/transactions/[string id]
Isolated FunctionResource Function
function get treasury/transactions/[string id](map<string|string[]> headers, *GetTreasuryTransactionsIdQueries queries) returns Treasury\.transaction|errorRetrieves the details of an existing Transaction.
Parameters
- queries *GetTreasuryTransactionsIdQueries - Queries to be sent with the request
Return Type
- Treasury\.transaction|error - Successful response.
get webhook_endpoints
Isolated FunctionResource Function
function get webhook_endpoints(map<string|string[]> headers, *GetWebhookEndpointsQueries queries) returns NotificationWebhookEndpointList|errorReturns a list of your webhook endpoints.
Parameters
- queries *GetWebhookEndpointsQueries - Queries to be sent with the request
Return Type
- NotificationWebhookEndpointList|error - Successful response.
get webhook_endpoints/[string webhook_endpoint]
Isolated FunctionResource Function
function get webhook_endpoints/[string webhook_endpoint](map<string|string[]> headers, *GetWebhookEndpointsWebhookEndpointQueries queries) returns Webhook_endpoint|errorRetrieves the webhook endpoint with the given ID.
Parameters
- queries *GetWebhookEndpointsWebhookEndpointQueries - Queries to be sent with the request
Return Type
- Webhook_endpoint|error - Successful response.
post account_links
Isolated FunctionResource Function
function post account_links(account_links_body payload, map<string|string[]> headers) returns Account_link|errorCreates 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.
Parameters
- payload account_links_body -
Return Type
- Account_link|error - Successful response.
post account_sessions
Isolated FunctionResource Function
function post account_sessions(account_sessions_body payload, map<string|string[]> headers) returns Account_session|errorCreates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.
Parameters
- payload account_sessions_body -
Return Type
- Account_session|error - Successful response.
post accounts
Isolated FunctionResource Function
With Connect, you can create Stripe accounts for your users. To do this, you’ll first need to register your platform.
If you’ve already collected information for your connected accounts, you can prefill that information when creating the account. Connect Onboarding won’t ask for the prefilled information during account onboarding. You can prefill any information on the account.
Parameters
- payload accounts_body -
post accounts/[string account]
Isolated FunctionResource Function
function post accounts/[string account](accounts_account_body payload, map<string|string[]> headers) returns Account|errorUpdates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged.
For accounts where controller.requirement_collection
is application, which includes Custom accounts, you can update any information on the account.
For accounts where controller.requirement_collection
is stripe, which includes Standard and Express accounts, you can update all information until you create
an Account Link or Account Session to start Connect onboarding,
after which some properties can no longer be updated.
To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.
Parameters
- payload accounts_account_body -
post accounts/[string account]/bank_accounts
Isolated FunctionResource Function
function post accounts/[string account]/bank_accounts(account_bank_accounts_body payload, map<string|string[]> headers) returns External_account|errorCreate an external account for a given account.
Parameters
- payload account_bank_accounts_body -
Return Type
- External_account|error - Successful response.
post accounts/[string account]/bank_accounts/[string id]
Isolated FunctionResource Function
function post accounts/[string account]/bank_accounts/[string id](bank_accounts_id_body payload, map<string|string[]> headers) returns External_account|errorUpdates the metadata, account holder name, account holder type of a bank account belonging to a connected account and optionally sets it as the default for its currency. Other bank account details are not editable by design.
You can only update bank accounts when account.controller.requirement_collection is application, which includes Custom accounts.
You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.
Parameters
- payload bank_accounts_id_body -
Return Type
- External_account|error - Successful response.
post accounts/[string account]/capabilities/[string capability]
Isolated FunctionResource Function
function post accounts/[string account]/capabilities/[string capability](capabilities_capability_body payload, map<string|string[]> headers) returns Capability|errorUpdates an existing Account Capability. Request or remove a capability by updating its requested parameter.
Parameters
- payload capabilities_capability_body -
Return Type
- Capability|error - Successful response.
post accounts/[string account]/external_accounts
Isolated FunctionResource Function
function post accounts/[string account]/external_accounts(account_external_accounts_body payload, map<string|string[]> headers) returns External_account|errorCreate an external account for a given account.
Parameters
- payload account_external_accounts_body -
Return Type
- External_account|error - Successful response.
post accounts/[string account]/external_accounts/[string id]
Isolated FunctionResource Function
function post accounts/[string account]/external_accounts/[string id](external_accounts_id_body payload, map<string|string[]> headers) returns External_account|errorUpdates the metadata, account holder name, account holder type of a bank account belonging to a connected account and optionally sets it as the default for its currency. Other bank account details are not editable by design.
You can only update bank accounts when account.controller.requirement_collection is application, which includes Custom accounts.
You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.
Parameters
- payload external_accounts_id_body -
Return Type
- External_account|error - Successful response.
post accounts/[string account]/login_links
Isolated FunctionResource Function
function post accounts/[string account]/login_links(account_login_links_body payload, map<string|string[]> headers) returns Login_link|errorCreates a single-use login link for a connected account to access the Express Dashboard.
You can only create login links for accounts that use the Express Dashboard and are connected to your platform.
Parameters
- payload account_login_links_body -
Return Type
- Login_link|error - Successful response.
post accounts/[string account]/people
Isolated FunctionResource Function
function post accounts/[string account]/people(account_people_body payload, map<string|string[]> headers) returns Person|errorCreates a new person.
Parameters
- payload account_people_body -
post accounts/[string account]/people/[string person]
Isolated FunctionResource Function
function post accounts/[string account]/people/[string person](people_person_body payload, map<string|string[]> headers) returns Person|errorUpdates an existing person.
Parameters
- payload people_person_body -
post accounts/[string account]/persons
Isolated FunctionResource Function
function post accounts/[string account]/persons(account_persons_body payload, map<string|string[]> headers) returns Person|errorCreates a new person.
Parameters
- payload account_persons_body -
post accounts/[string account]/persons/[string person]
Isolated FunctionResource Function
function post accounts/[string account]/persons/[string person](persons_person_body payload, map<string|string[]> headers) returns Person|errorUpdates an existing person.
Parameters
- payload persons_person_body -
post accounts/[string account]/reject
Isolated FunctionResource Function
function post accounts/[string account]/reject(account_reject_body payload, map<string|string[]> headers) returns Account|errorWith Connect, you can reject accounts that you have flagged as suspicious.
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.
Parameters
- payload account_reject_body -
post apple_pay/domains
Isolated FunctionResource Function
function post apple_pay/domains(apple_pay_domains_body payload, map<string|string[]> headers) returns Apple_pay_domain|errorCreate an apple pay domain.
Parameters
- payload apple_pay_domains_body -
Return Type
- Apple_pay_domain|error - Successful response.
post application_fees/[string fee]/refunds/[string id]
Isolated FunctionResource Function
function post application_fees/[string fee]/refunds/[string id](refunds_id_body payload, map<string|string[]> headers) returns Fee_refund|errorUpdates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
This request only accepts metadata as an argument.
Parameters
- payload refunds_id_body -
Return Type
- Fee_refund|error - Successful response.
post application_fees/[string id]/refund
Isolated FunctionResource Function
function post application_fees/[string id]/refund(id_refund_body payload, map<string|string[]> headers) returns Application_fee|errorParameters
- payload id_refund_body -
Return Type
- Application_fee|error - Successful response.
post application_fees/[string id]/refunds
Isolated FunctionResource Function
function post application_fees/[string id]/refunds(id_refunds_body payload, map<string|string[]> headers) returns Fee_refund|errorRefunds an application fee that has previously been collected but not yet refunded. Funds will be refunded to the Stripe account from which the fee was originally collected.
You can optionally refund only part of an application fee. You can do so multiple times, until the entire fee has been refunded.
Once entirely refunded, an application fee can’t be refunded again. This method will raise an error when called on an already-refunded application fee, or when trying to refund more money than is left on an application fee.
Parameters
- payload id_refunds_body -
Return Type
- Fee_refund|error - Successful response.
post apps/secrets
Isolated FunctionResource Function
function post apps/secrets(apps_secrets_body payload, map<string|string[]> headers) returns Apps\.secret|errorCreate or replace a secret in the secret store.
Parameters
- payload apps_secrets_body -
Return Type
- Apps\.secret|error - Successful response.
post apps/secrets/delete
Isolated FunctionResource Function
function post apps/secrets/delete(secrets_delete_body payload, map<string|string[]> headers) returns Apps\.secret|errorDeletes a secret from the secret store by name and scope.
Parameters
- payload secrets_delete_body -
Return Type
- Apps\.secret|error - Successful response.
post billing/meter_event_adjustments
Isolated FunctionResource Function
function post billing/meter_event_adjustments(billing_meter_event_adjustments_body payload, map<string|string[]> headers) returns Billing\.meter_event_adjustment|errorCreates a billing meter event adjustment
Parameters
- payload billing_meter_event_adjustments_body -
Return Type
- Billing\.meter_event_adjustment|error - Successful response.
post billing/meter_events
Isolated FunctionResource Function
function post billing/meter_events(billing_meter_events_body payload, map<string|string[]> headers) returns Billing\.meter_event|errorCreates a billing meter event
Parameters
- payload billing_meter_events_body -
Return Type
- Billing\.meter_event|error - Successful response.
post billing/meters
Isolated FunctionResource Function
function post billing/meters(billing_meters_body payload, map<string|string[]> headers) returns Billing\.meter|errorCreates a billing meter
Parameters
- payload billing_meters_body -
Return Type
- Billing\.meter|error - Successful response.
post billing/meters/[string id]
Isolated FunctionResource Function
function post billing/meters/[string id](meters_id_body payload, map<string|string[]> headers) returns Billing\.meter|errorUpdates a billing meter
Parameters
- payload meters_id_body -
Return Type
- Billing\.meter|error - Successful response.
post billing/meters/[string id]/deactivate
Isolated FunctionResource Function
function post billing/meters/[string id]/deactivate(id_deactivate_body payload, map<string|string[]> headers) returns Billing\.meter|errorDeactivates a billing meter
Parameters
- payload id_deactivate_body -
Return Type
- Billing\.meter|error - Successful response.
post billing/meters/[string id]/reactivate
Isolated FunctionResource Function
function post billing/meters/[string id]/reactivate(id_reactivate_body payload, map<string|string[]> headers) returns Billing\.meter|errorReactivates a billing meter
Parameters
- payload id_reactivate_body -
Return Type
- Billing\.meter|error - Successful response.
post billing_portal/configurations
Isolated FunctionResource Function
function post billing_portal/configurations(billing_portal_configurations_body payload, map<string|string[]> headers) returns Billing_portal\.configuration|errorCreates a configuration that describes the functionality and behavior of a PortalSession
Parameters
- payload billing_portal_configurations_body -
Return Type
- Billing_portal\.configuration|error - Successful response.
post billing_portal/configurations/[string configuration]
Isolated FunctionResource Function
function post billing_portal/configurations/[string configuration](configurations_configuration_body payload, map<string|string[]> headers) returns Billing_portal\.configuration|errorUpdates a configuration that describes the functionality of the customer portal.
Parameters
- payload configurations_configuration_body -
Return Type
- Billing_portal\.configuration|error - Successful response.
post billing_portal/sessions
Isolated FunctionResource Function
function post billing_portal/sessions(billing_portal_sessions_body payload, map<string|string[]> headers) returns Billing_portal\.session|errorCreates a session of the customer portal.
Parameters
- payload billing_portal_sessions_body -
Return Type
- Billing_portal\.session|error - Successful response.
post charges
Isolated FunctionResource Function
This method is no longer recommended—use the Payment Intents API
to initiate a new payment instead. Confirmation of the PaymentIntent creates the Charge
object used to request payment.
Parameters
- payload charges_body -
post charges/[string charge]
Isolated FunctionResource Function
function post charges/[string charge](charges_charge_body payload, map<string|string[]> headers) returns Charge|errorUpdates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Parameters
- payload charges_charge_body -
post charges/[string charge]/capture
Isolated FunctionResource Function
function post charges/[string charge]/capture(charge_capture_body payload, map<string|string[]> headers) returns Charge|errorCapture the payment of an existing, uncaptured charge that was created with the capture option set to false.
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.
Don’t use this method to capture a PaymentIntent-initiated charge. Use Capture a PaymentIntent.
Parameters
- payload charge_capture_body -
post charges/[string charge]/dispute
Isolated FunctionResource Function
function post charges/[string charge]/dispute(charge_dispute_body payload, map<string|string[]> headers) returns Dispute|errorParameters
- payload charge_dispute_body -
post charges/[string charge]/dispute/close
Isolated FunctionResource Function
function post charges/[string charge]/dispute/close(dispute_close_body payload, map<string|string[]> headers) returns Dispute|errorParameters
- payload dispute_close_body -
post charges/[string charge]/refund
Isolated FunctionResource Function
function post charges/[string charge]/refund(charge_refund_body payload, map<string|string[]> headers) returns Charge|errorWhen you create a new refund, you must specify either a Charge or a PaymentIntent object.
This action refunds a previously created charge that’s not refunded yet. Funds are refunded to the credit or debit card that’s originally charged.
You can optionally refund only part of a charge. You can repeat this until the entire charge is refunded.
After you entirely refund a charge, you can’t refund it again. This method raises an error when it’s called on an already-refunded charge, or when you attempt to refund more money than is left on a charge.
Parameters
- payload charge_refund_body -
post charges/[string charge]/refunds
Isolated FunctionResource Function
function post charges/[string charge]/refunds(charge_refunds_body payload, map<string|string[]> headers) returns Refund|errorWhen you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.
Creating a new refund will refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged.
You can optionally refund only part of a charge. You can do so multiple times, until the entire charge has been refunded.
Once entirely refunded, a charge can’t be refunded again. This method will raise an error when called on an already-refunded charge, or when trying to refund more money than is left on a charge.
Parameters
- payload charge_refunds_body -
post charges/[string charge]/refunds/[string refund]
Isolated FunctionResource Function
function post charges/[string charge]/refunds/[string refund](refunds_refund_body payload, map<string|string[]> headers) returns Refund|errorUpdate a specified refund.
Parameters
- payload refunds_refund_body -
post checkout/sessions
Isolated FunctionResource Function
function post checkout/sessions(checkout_sessions_body payload, map<string|string[]> headers) returns Checkout\.session|errorCreates a Session object.
Parameters
- payload checkout_sessions_body -
Return Type
- Checkout\.session|error - Successful response.
post checkout/sessions/[string session]/expire
Isolated FunctionResource Function
function post checkout/sessions/[string session]/expire(session_expire_body payload, map<string|string[]> headers) returns Checkout\.session|errorA Session can be expired when it is in one of these statuses: open
After it expires, a customer can’t complete a Session and customers loading the Session see a message saying the Session is expired.
Parameters
- payload session_expire_body -
Return Type
- Checkout\.session|error - Successful response.
post climate/orders
Isolated FunctionResource Function
function post climate/orders(climate_orders_body payload, map<string|string[]> headers) returns Climate\.order|errorCreates a Climate order object for a given Climate product. The order will be processed immediately after creation and payment will be deducted your Stripe balance.
Parameters
- payload climate_orders_body -
Return Type
- Climate\.order|error - Successful response.
post climate/orders/[string 'order]
Isolated FunctionResource Function
function post climate/orders/[string 'order](orders_order_body payload, map<string|string[]> headers) returns Climate\.order|errorUpdates the specified order by setting the values of the parameters passed.
Parameters
- payload orders_order_body -
Return Type
- Climate\.order|error - Successful response.
post climate/orders/[string 'order]/cancel
Isolated FunctionResource Function
function post climate/orders/[string 'order]/cancel(order_cancel_body payload, map<string|string[]> headers) returns Climate\.order|errorCancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the
reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier
might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe
provides 90 days advance notice and refunds the amount_total.
Parameters
- payload order_cancel_body -
Return Type
- Climate\.order|error - Successful response.
post coupons
Isolated FunctionResource Function
You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.
A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice’s subtotal. For example, an invoice with a subtotal of amount_off of amount_off of
Parameters
- payload coupons_body -
post coupons/[string coupon]
Isolated FunctionResource Function
function post coupons/[string coupon](coupons_coupon_body payload, map<string|string[]> headers) returns Coupon|errorUpdates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.
Parameters
- payload coupons_coupon_body -
post credit_notes
Isolated FunctionResource Function
function post credit_notes(credit_notes_body payload, map<string|string[]> headers) returns Credit_note|errorIssue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces
its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result
in any combination of the following:
- Refund: create a new refund (using
refund_amount) or link an existing refund (usingrefund). - Customer balance credit: credit the customer’s balance (using
credit_amount) which will be automatically applied to their next invoice when it’s finalized. - Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using
out_of_band_amount).
For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total.
You may issue multiple credit notes for an invoice. Each credit note will increment the invoice’s pre_payment_credit_notes_amount
or post_payment_credit_notes_amount depending on its status at the time of credit note creation.
Parameters
- payload credit_notes_body -
Return Type
- Credit_note|error - Successful response.
post credit_notes/[string id]
Isolated FunctionResource Function
function post credit_notes/[string id](credit_notes_id_body payload, map<string|string[]> headers) returns Credit_note|errorUpdates an existing credit note.
Parameters
- payload credit_notes_id_body -
Return Type
- Credit_note|error - Successful response.
post credit_notes/[string id]/void
Isolated FunctionResource Function
function post credit_notes/[string id]/void(id_void_body payload, map<string|string[]> headers) returns Credit_note|errorMarks a credit note as void. Learn more about voiding credit notes.
Parameters
- payload id_void_body -
Return Type
- Credit_note|error - Successful response.
post customer_sessions
Isolated FunctionResource Function
function post customer_sessions(customer_sessions_body payload, map<string|string[]> headers) returns Customer_session|errorCreates 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.
Parameters
- payload customer_sessions_body -
Return Type
- Customer_session|error - Successful response.
post customers
Isolated FunctionResource Function
function post customers(customers_body payload, map<string|string[]> headers) returns Customer|errorCreates a new customer object.
Parameters
- payload customers_body -
post customers/[string customer]
Isolated FunctionResource Function
function post customers/[string customer](customers_customer_body payload, map<string|string[]> headers) returns Customer|errorUpdates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.
This request accepts mostly the same arguments as the customer creation call.
Parameters
- payload customers_customer_body -
post customers/[string customer]/balance_transactions
Isolated FunctionResource Function
function post customers/[string customer]/balance_transactions(customer_balance_transactions_body payload, map<string|string[]> headers) returns Customer_balance_transaction|errorCreates an immutable transaction that updates the customer’s credit balance.
Parameters
- payload customer_balance_transactions_body -
Return Type
- Customer_balance_transaction|error - Successful response.
post customers/[string customer]/balance_transactions/[string 'transaction]
Isolated FunctionResource Function
function post customers/[string customer]/balance_transactions/[string 'transaction](balance_transactions_transaction_body payload, map<string|string[]> headers) returns Customer_balance_transaction|errorMost credit balance transaction fields are immutable, but you may update its description and metadata.
Parameters
- payload balance_transactions_transaction_body -
Return Type
- Customer_balance_transaction|error - Successful response.
post customers/[string customer]/bank_accounts
Isolated FunctionResource Function
function post customers/[string customer]/bank_accounts(customer_bank_accounts_body payload, map<string|string[]> headers) returns Payment_source|errorWhen you create a new credit card, you must specify a customer or recipient on which to create it.
If the card’s owner has no default card, then the new card will become the default.
However, if the owner already has a default, then it will not change.
To change the default, you should update the customer to have a new default_source.
Parameters
- payload customer_bank_accounts_body -
Return Type
- Payment_source|error - Successful response.
post customers/[string customer]/bank_accounts/[string id]
Isolated FunctionResource Function
function post customers/[string customer]/bank_accounts/[string id](bank_accounts_id_body_1 payload, map<string|string[]> headers) returns inline_response_200_1|errorUpdate a specified source for a given customer.
Parameters
- payload bank_accounts_id_body_1 -
Return Type
- inline_response_200_1|error - Successful response.
post customers/[string customer]/bank_accounts/[string id]/verify
Isolated FunctionResource Function
function post customers/[string customer]/bank_accounts/[string id]/verify(id_verify_body payload, map<string|string[]> headers) returns Bank_account|errorVerify a specified bank account for a given customer.
Parameters
- payload id_verify_body -
Return Type
- Bank_account|error - Successful response.
post customers/[string customer]/cards
Isolated FunctionResource Function
function post customers/[string customer]/cards(customer_cards_body payload, map<string|string[]> headers) returns Payment_source|errorWhen you create a new credit card, you must specify a customer or recipient on which to create it.
If the card’s owner has no default card, then the new card will become the default.
However, if the owner already has a default, then it will not change.
To change the default, you should update the customer to have a new default_source.
Parameters
- payload customer_cards_body -
Return Type
- Payment_source|error - Successful response.
post customers/[string customer]/cards/[string id]
Isolated FunctionResource Function
function post customers/[string customer]/cards/[string id](cards_id_body payload, map<string|string[]> headers) returns inline_response_200_1|errorUpdate a specified source for a given customer.
Parameters
- payload cards_id_body -
Return Type
- inline_response_200_1|error - Successful response.
post customers/[string customer]/cash_balance
Isolated FunctionResource Function
function post customers/[string customer]/cash_balance(customer_cash_balance_body payload, map<string|string[]> headers) returns Cash_balance|errorChanges the settings on a customer’s cash balance.
Parameters
- payload customer_cash_balance_body -
Return Type
- Cash_balance|error - Successful response.
post customers/[string customer]/funding_instructions
Isolated FunctionResource Function
function post customers/[string customer]/funding_instructions(customer_funding_instructions_body payload, map<string|string[]> headers) returns Funding_instructions|errorRetrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new funding instructions will be created. If funding instructions have already been created for a given customer, the same funding instructions will be retrieved. In other words, we will return the same funding instructions each time.
Parameters
- payload customer_funding_instructions_body -
Return Type
- Funding_instructions|error - Successful response.
post customers/[string customer]/sources
Isolated FunctionResource Function
function post customers/[string customer]/sources(customer_sources_body payload, map<string|string[]> headers) returns Payment_source|errorWhen you create a new credit card, you must specify a customer or recipient on which to create it.
If the card’s owner has no default card, then the new card will become the default.
However, if the owner already has a default, then it will not change.
To change the default, you should update the customer to have a new default_source.
Parameters
- payload customer_sources_body -
Return Type
- Payment_source|error - Successful response.
post customers/[string customer]/sources/[string id]
Isolated FunctionResource Function
function post customers/[string customer]/sources/[string id](sources_id_body payload, map<string|string[]> headers) returns inline_response_200_1|errorUpdate a specified source for a given customer.
Parameters
- payload sources_id_body -
Return Type
- inline_response_200_1|error - Successful response.
post customers/[string customer]/sources/[string id]/verify
Isolated FunctionResource Function
function post customers/[string customer]/sources/[string id]/verify(id_verify_body_1 payload, map<string|string[]> headers) returns Bank_account|errorVerify a specified bank account for a given customer.
Parameters
- payload id_verify_body_1 -
Return Type
- Bank_account|error - Successful response.
post customers/[string customer]/subscriptions
Isolated FunctionResource Function
function post customers/[string customer]/subscriptions(customer_subscriptions_body payload, map<string|string[]> headers) returns Subscription|errorCreates a new subscription on an existing customer.
Parameters
- payload customer_subscriptions_body -
Return Type
- Subscription|error - Successful response.
post customers/[string customer]/subscriptions/[string subscription_exposed_id]
Isolated FunctionResource Function
function post customers/[string customer]/subscriptions/[string subscription_exposed_id](subscriptions_subscription_exposed_id_body payload, map<string|string[]> headers) returns Subscription|errorUpdates 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.
Parameters
Return Type
- Subscription|error - Successful response.
post customers/[string customer]/tax_ids
Isolated FunctionResource Function
function post customers/[string customer]/tax_ids(customer_tax_ids_body payload, map<string|string[]> headers) returns Tax_id|errorCreates a new tax_id object for a customer.
Parameters
- payload customer_tax_ids_body -
post disputes/[string dispute]
Isolated FunctionResource Function
function post disputes/[string dispute](disputes_dispute_body payload, map<string|string[]> headers) returns Dispute|errorWhen you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.
Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our guide to dispute types.
Parameters
- payload disputes_dispute_body -
post disputes/[string dispute]/close
Isolated FunctionResource Function
function post disputes/[string dispute]/close(dispute_close_body_1 payload, map<string|string[]> headers) returns Dispute|errorClosing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.
The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.
Parameters
- payload dispute_close_body_1 -
post entitlements/features
Isolated FunctionResource Function
function post entitlements/features(entitlements_features_body payload, map<string|string[]> headers) returns Entitlements\.feature|errorCreates a feature
Parameters
- payload entitlements_features_body -
Return Type
- Entitlements\.feature|error - Successful response.
post entitlements/features/[string id]
Isolated FunctionResource Function
function post entitlements/features/[string id](features_id_body payload, map<string|string[]> headers) returns Entitlements\.feature|errorUpdate a feature’s metadata or permanently deactivate it.
Parameters
- payload features_id_body -
Return Type
- Entitlements\.feature|error - Successful response.
post ephemeral_keys
Isolated FunctionResource Function
function post ephemeral_keys(ephemeral_keys_body payload, map<string|string[]> headers) returns Ephemeral_key|errorCreates a short-lived API key for a given resource.
Parameters
- payload ephemeral_keys_body -
Return Type
- Ephemeral_key|error - Successful response.
post file_links
Isolated FunctionResource Function
function post file_links(file_links_body payload, map<string|string[]> headers) returns File_link|errorCreates a new file link object.
Parameters
- payload file_links_body -
post file_links/[string link]
Isolated FunctionResource Function
function post file_links/[string link](file_links_link_body payload, map<string|string[]> headers) returns File_link|errorUpdates an existing file link object. Expired links can no longer be updated.
Parameters
- payload file_links_link_body -
post files
Isolated FunctionResource Function
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.
All of Stripe’s officially supported Client libraries support sending multipart/form-data.
Parameters
- payload files_body -
post financial_connections/accounts/[string account]/disconnect
Isolated FunctionResource Function
function post financial_connections/accounts/[string account]/disconnect(account_disconnect_body payload, map<string|string[]> headers) returns Financial_connections\.account|errorDisables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).
Parameters
- payload account_disconnect_body -
Return Type
- Financial_connections\.account|error - Successful response.
post financial_connections/accounts/[string account]/refresh
Isolated FunctionResource Function
function post financial_connections/accounts/[string account]/refresh(account_refresh_body payload, map<string|string[]> headers) returns Financial_connections\.account|errorRefreshes the data associated with a Financial Connections Account.
Parameters
- payload account_refresh_body -
Return Type
- Financial_connections\.account|error - Successful response.
post financial_connections/accounts/[string account]/subscribe
Isolated FunctionResource Function
function post financial_connections/accounts/[string account]/subscribe(account_subscribe_body payload, map<string|string[]> headers) returns Financial_connections\.account|errorSubscribes to periodic refreshes of data associated with a Financial Connections Account.
Parameters
- payload account_subscribe_body -
Return Type
- Financial_connections\.account|error - Successful response.
post financial_connections/accounts/[string account]/unsubscribe
Isolated FunctionResource Function
function post financial_connections/accounts/[string account]/unsubscribe(account_unsubscribe_body payload, map<string|string[]> headers) returns Financial_connections\.account|errorUnsubscribes from periodic refreshes of data associated with a Financial Connections Account.
Parameters
- payload account_unsubscribe_body -
Return Type
- Financial_connections\.account|error - Successful response.
post financial_connections/sessions
Isolated FunctionResource Function
function post financial_connections/sessions(financial_connections_sessions_body payload, map<string|string[]> headers) returns Financial_connections\.session|errorTo launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.
Parameters
- payload financial_connections_sessions_body -
Return Type
- Financial_connections\.session|error - Successful response.
post forwarding/requests
Isolated FunctionResource Function
function post forwarding/requests(forwarding_requests_body payload, map<string|string[]> headers) returns Forwarding\.request|errorCreates a ForwardingRequest object.
Parameters
- payload forwarding_requests_body -
Return Type
- Forwarding\.request|error - Successful response.
post identity/verification_sessions
Isolated FunctionResource Function
function post identity/verification_sessions(identity_verification_sessions_body payload, map<string|string[]> headers) returns Identity\.verification_session|errorCreates a VerificationSession object.
After the VerificationSession is created, display a verification modal using the session client_secret or send your users to the session’s url.
If your API key is in test mode, verification checks won’t actually process, though everything else will occur as if in live mode.
Related guide: Verify your users’ identity documents
Parameters
- payload identity_verification_sessions_body -
Return Type
- Identity\.verification_session|error - Successful response.
post identity/verification_sessions/[string session]
Isolated FunctionResource Function
function post identity/verification_sessions/[string session](verification_sessions_session_body payload, map<string|string[]> headers) returns Identity\.verification_session|errorUpdates a VerificationSession object.
When the session status is requires_input, you can use this method to update the
verification check and options.
Parameters
- payload verification_sessions_session_body -
Return Type
- Identity\.verification_session|error - Successful response.
post identity/verification_sessions/[string session]/cancel
Isolated FunctionResource Function
function post identity/verification_sessions/[string session]/cancel(session_cancel_body payload, map<string|string[]> headers) returns Identity\.verification_session|errorA VerificationSession object can be canceled when it is in requires_input status.
Once canceled, future submission attempts are disabled. This cannot be undone. Learn more.
Parameters
- payload session_cancel_body -
Return Type
- Identity\.verification_session|error - Successful response.
post identity/verification_sessions/[string session]/redact
Isolated FunctionResource Function
function post identity/verification_sessions/[string session]/redact(session_redact_body payload, map<string|string[]> headers) returns Identity\.verification_session|errorRedact a VerificationSession to remove all collected information from Stripe. This will redact the VerificationSession and all objects related to it, including VerificationReports, Events, request logs, etc.
A VerificationSession object can be redacted when it is in requires_input or verified
status. Redacting a VerificationSession in requires_action
state will automatically cancel it.
The redaction process may take up to four days. When the redaction process is in progress, the
VerificationSession’s redaction.status field will be set to processing; when the process is
finished, it will change to redacted and an identity.verification_session.redacted event
will be emitted.
Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the
fields that contain personal data will be replaced by the string [redacted] or a similar
placeholder. The metadata field will also be erased. Redacted objects cannot be updated or
used for any purpose.
Parameters
- payload session_redact_body -
Return Type
- Identity\.verification_session|error - Successful response.
post invoiceitems
Isolated FunctionResource Function
function post invoiceitems(invoiceitems_body payload, map<string|string[]> headers) returns Invoiceitem|errorCreates 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.
Parameters
- payload invoiceitems_body -
Return Type
- Invoiceitem|error - Successful response.
post invoiceitems/[string invoiceitem]
Isolated FunctionResource Function
function post invoiceitems/[string invoiceitem](invoiceitems_invoiceitem_body payload, map<string|string[]> headers) returns Invoiceitem|errorUpdates 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.
Parameters
- payload invoiceitems_invoiceitem_body -
Return Type
- Invoiceitem|error - Successful response.
post invoices
Isolated FunctionResource Function
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.
Parameters
- payload invoices_body -
post invoices/[string invoice]
Isolated FunctionResource Function
function post invoices/[string invoice](invoices_invoice_body payload, map<string|string[]> headers) returns Invoice|errorDraft invoices are fully editable. Once an invoice is finalized,
monetary values, as well as collection_method, become uneditable.
If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on,
sending reminders for, or automatically reconciling invoices, pass
auto_advance=false.
Parameters
- payload invoices_invoice_body -
post invoices/[string invoice]/add_lines
Isolated FunctionResource Function
function post invoices/[string invoice]/add_lines(invoice_add_lines_body payload, map<string|string[]> headers) returns Invoice|errorAdds multiple line items to an invoice. This is only possible when an invoice is still a draft.
Parameters
- payload invoice_add_lines_body -
post invoices/[string invoice]/finalize
Isolated FunctionResource Function
function post invoices/[string invoice]/finalize(invoice_finalize_body payload, map<string|string[]> headers) returns Invoice|errorStripe 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.
Parameters
- payload invoice_finalize_body -
post invoices/[string invoice]/lines/[string line_item_id]
Isolated FunctionResource Function
function post invoices/[string invoice]/lines/[string line_item_id](lines_line_item_id_body payload, map<string|string[]> headers) returns Line_item|errorUpdates an invoice’s line item. Some fields, such as tax_amounts, only live on the invoice line item,
so they can only be updated through this endpoint. Other fields, such as amount, live on both the invoice
item and the invoice line item, so updates on this endpoint will propagate to the invoice item as well.
Updating an invoice’s line item is only possible before the invoice is finalized.
Parameters
- payload lines_line_item_id_body -
post invoices/[string invoice]/mark_uncollectible
Isolated FunctionResource Function
function post invoices/[string invoice]/mark_uncollectible(invoice_mark_uncollectible_body payload, map<string|string[]> headers) returns Invoice|errorMarking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.
Parameters
- payload invoice_mark_uncollectible_body -
post invoices/[string invoice]/pay
Isolated FunctionResource Function
function post invoices/[string invoice]/pay(invoice_pay_body payload, map<string|string[]> headers) returns Invoice|errorStripe 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.
Parameters
- payload invoice_pay_body -
post invoices/[string invoice]/remove_lines
Isolated FunctionResource Function
function post invoices/[string invoice]/remove_lines(invoice_remove_lines_body payload, map<string|string[]> headers) returns Invoice|errorRemoves multiple line items from an invoice. This is only possible when an invoice is still a draft.
Parameters
- payload invoice_remove_lines_body -
post invoices/[string invoice]/send
Isolated FunctionResource Function
function post invoices/[string invoice]/send(invoice_send_body payload, map<string|string[]> headers) returns Invoice|errorStripe will automatically send invoices to customers according to your subscriptions settings. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.
Requests made in test-mode result in no emails being sent, despite sending an invoice.sent event.
Parameters
- payload invoice_send_body -
post invoices/[string invoice]/update_lines
Isolated FunctionResource Function
function post invoices/[string invoice]/update_lines(invoice_update_lines_body payload, map<string|string[]> headers) returns Invoice|errorUpdates multiple line items on an invoice. This is only possible when an invoice is still a draft.
Parameters
- payload invoice_update_lines_body -
post invoices/[string invoice]/void
Isolated FunctionResource Function
function post invoices/[string invoice]/void(invoice_void_body payload, map<string|string[]> headers) returns Invoice|errorMark 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.
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.
Parameters
- payload invoice_void_body -
post invoices/create_preview
Isolated FunctionResource Function
function post invoices/create_preview(invoices_create_preview_body payload, map<string|string[]> headers) returns Invoice|errorAt any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.
Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.
You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass 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.
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
Parameters
- payload invoices_create_preview_body -
post issuing/authorizations/[string authorization]
Isolated FunctionResource Function
function post issuing/authorizations/[string authorization](authorizations_authorization_body payload, map<string|string[]> headers) returns Issuing\.authorization|errorUpdates the specified Issuing Authorization object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Parameters
- payload authorizations_authorization_body -
Return Type
- Issuing\.authorization|error - Successful response.
post issuing/authorizations/[string authorization]/approve
DeprecatedIsolated FunctionResource Function
function post issuing/authorizations/[string authorization]/approve(authorization_approve_body payload, map<string|string[]> headers) returns Issuing\.authorization|error[Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow.
This method is deprecated. Instead, respond directly to the webhook request to approve an authorization.
Parameters
- payload authorization_approve_body -
Return Type
- Issuing\.authorization|error - Successful response.
Deprecated
post issuing/authorizations/[string authorization]/decline
DeprecatedIsolated FunctionResource Function
function post issuing/authorizations/[string authorization]/decline(authorization_decline_body payload, map<string|string[]> headers) returns Issuing\.authorization|error[Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow.
This method is deprecated. Instead, respond directly to the webhook request to decline an authorization.
Parameters
- payload authorization_decline_body -
Return Type
- Issuing\.authorization|error - Successful response.
Deprecated
post issuing/cardholders
Isolated FunctionResource Function
function post issuing/cardholders(issuing_cardholders_body payload, map<string|string[]> headers) returns Issuing\.cardholder|errorCreates a new Issuing Cardholder object that can be issued cards.
Parameters
- payload issuing_cardholders_body -
Return Type
- Issuing\.cardholder|error - Successful response.
post issuing/cardholders/[string cardholder]
Isolated FunctionResource Function
function post issuing/cardholders/[string cardholder](cardholders_cardholder_body payload, map<string|string[]> headers) returns Issuing\.cardholder|errorUpdates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Parameters
- payload cardholders_cardholder_body -
Return Type
- Issuing\.cardholder|error - Successful response.
post issuing/cards
Isolated FunctionResource Function
function post issuing/cards(issuing_cards_body payload, map<string|string[]> headers) returns Issuing\.card|errorCreates an Issuing Card object.
Parameters
- payload issuing_cards_body -
Return Type
- Issuing\.card|error - Successful response.
post issuing/cards/[string card]
Isolated FunctionResource Function
function post issuing/cards/[string card](cards_card_body payload, map<string|string[]> headers) returns Issuing\.card|errorUpdates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Parameters
- payload cards_card_body -
Return Type
- Issuing\.card|error - Successful response.
post issuing/disputes
Isolated FunctionResource Function
function post issuing/disputes(issuing_disputes_body payload, map<string|string[]> headers) returns Issuing\.dispute|errorCreates 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.
Parameters
- payload issuing_disputes_body -
Return Type
- Issuing\.dispute|error - Successful response.
post issuing/disputes/[string dispute]
Isolated FunctionResource Function
function post issuing/disputes/[string dispute](disputes_dispute_body_1 payload, map<string|string[]> headers) returns Issuing\.dispute|errorUpdates 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.
Parameters
- payload disputes_dispute_body_1 -
Return Type
- Issuing\.dispute|error - Successful response.
post issuing/disputes/[string dispute]/submit
Isolated FunctionResource Function
function post issuing/disputes/[string dispute]/submit(dispute_submit_body payload, map<string|string[]> headers) returns Issuing\.dispute|errorSubmits 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.
Parameters
- payload dispute_submit_body -
Return Type
- Issuing\.dispute|error - Successful response.
post issuing/personalization_designs
Isolated FunctionResource Function
function post issuing/personalization_designs(issuing_personalization_designs_body payload, map<string|string[]> headers) returns Issuing\.personalization_design|errorCreates a personalization design object.
Parameters
- payload issuing_personalization_designs_body -
Return Type
- Issuing\.personalization_design|error - Successful response.
post issuing/personalization_designs/[string personalization_design]
Isolated FunctionResource Function
function post issuing/personalization_designs/[string personalization_design](personalization_designs_personalization_design_body payload, map<string|string[]> headers) returns Issuing\.personalization_design|errorUpdates a card personalization object.
Parameters
Return Type
- Issuing\.personalization_design|error - Successful response.
post issuing/settlements/[string settlement]
Isolated FunctionResource Function
function post issuing/settlements/[string settlement](settlements_settlement_body payload, map<string|string[]> headers) returns Issuing\.settlement|errorUpdates the specified Issuing Settlement object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Parameters
- payload settlements_settlement_body -
Return Type
- Issuing\.settlement|error - Successful response.
post issuing/tokens/[string token]
Isolated FunctionResource Function
function post issuing/tokens/[string token](tokens_token_body payload, map<string|string[]> headers) returns Issuing\.token|errorAttempts to update the specified Issuing Token object to the status specified.
Parameters
- payload tokens_token_body -
Return Type
- Issuing\.token|error - Successful response.
post issuing/transactions/[string 'transaction]
Isolated FunctionResource Function
function post issuing/transactions/[string 'transaction](transactions_transaction_body payload, map<string|string[]> headers) returns Issuing\.transaction|errorUpdates the specified Issuing Transaction object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Parameters
- payload transactions_transaction_body -
Return Type
- Issuing\.transaction|error - Successful response.
post link_account_sessions
Isolated FunctionResource Function
function post link_account_sessions(link_account_sessions_body payload, map<string|string[]> headers) returns Financial_connections\.session|errorTo launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.
Parameters
- payload link_account_sessions_body -
Return Type
- Financial_connections\.session|error - Successful response.
post linked_accounts/[string account]/disconnect
Isolated FunctionResource Function
function post linked_accounts/[string account]/disconnect(account_disconnect_body_1 payload, map<string|string[]> headers) returns Financial_connections\.account|errorDisables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).
Parameters
- payload account_disconnect_body_1 -
Return Type
- Financial_connections\.account|error - Successful response.
post linked_accounts/[string account]/refresh
Isolated FunctionResource Function
function post linked_accounts/[string account]/refresh(account_refresh_body_1 payload, map<string|string[]> headers) returns Financial_connections\.account|errorRefreshes the data associated with a Financial Connections Account.
Parameters
- payload account_refresh_body_1 -
Return Type
- Financial_connections\.account|error - Successful response.
post payment_intents
Isolated FunctionResource Function
function post payment_intents(payment_intents_body payload, map<string|string[]> headers) returns Payment_intent|errorCreates a PaymentIntent object.
After the PaymentIntent is created, attach a payment method and confirm to continue the payment. Learn more about the available payment flows with the Payment Intents API.
When you use confirm=true during creation, it’s equivalent to creating
and confirming the PaymentIntent in the same call. You can use any parameters
available in the confirm API when you supply
confirm=true.
Parameters
- payload payment_intents_body -
Return Type
- Payment_intent|error - Successful response.
post payment_intents/[string intent]
Isolated FunctionResource Function
function post payment_intents/[string intent](payment_intents_intent_body payload, map<string|string[]> headers) returns Payment_intent|errorUpdates properties on a PaymentIntent object without confirming.
Depending on which properties you update, you might need to confirm the
PaymentIntent again. For example, updating the payment_method
always requires you to confirm the PaymentIntent again. If you prefer to
update and confirm at the same time, we recommend updating properties through
the confirm API instead.
Parameters
- payload payment_intents_intent_body -
Return Type
- Payment_intent|error - Successful response.
post payment_intents/[string intent]/apply_customer_balance
Isolated FunctionResource Function
function post payment_intents/[string intent]/apply_customer_balance(intent_apply_customer_balance_body payload, map<string|string[]> headers) returns Payment_intent|errorManually reconcile the remaining amount for a customer_balance PaymentIntent.
Parameters
- payload intent_apply_customer_balance_body -
Return Type
- Payment_intent|error - Successful response.
post payment_intents/[string intent]/cancel
Isolated FunctionResource Function
function post payment_intents/[string intent]/cancel(intent_cancel_body payload, map<string|string[]> headers) returns Payment_intent|errorYou 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.
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.
You can’t cancel the PaymentIntent for a Checkout Session. Expire the Checkout Session instead.
Parameters
- payload intent_cancel_body -
Return Type
- Payment_intent|error - Successful response.
post payment_intents/[string intent]/capture
Isolated FunctionResource Function
function post payment_intents/[string intent]/capture(intent_capture_body payload, map<string|string[]> headers) returns Payment_intent|errorCapture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.
Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.
Learn more about separate authorization and capture.
Parameters
- payload intent_capture_body -
Return Type
- Payment_intent|error - Successful response.
post payment_intents/[string intent]/confirm
Isolated FunctionResource Function
function post payment_intents/[string intent]/confirm(intent_confirm_body payload, map<string|string[]> headers) returns Payment_intent|errorConfirm that your customer intends to pay with current or provided
payment method. Upon confirmation, the PaymentIntent will attempt to initiate
a payment.
If the selected payment method requires additional authentication steps, the
PaymentIntent will transition to the requires_action status and
suggest additional actions via next_action. If payment fails,
the PaymentIntent transitions to the requires_payment_method status or the
canceled status if the confirmation limit is reached. If
payment succeeds, the PaymentIntent will transition to the succeeded
status (or requires_capture, if capture_method is set to manual).
If the confirmation_method is automatic, payment may be attempted
using our client SDKs
and the PaymentIntent’s client_secret.
After next_actions are handled by the client, no additional
confirmation is required to complete the payment.
If the confirmation_method is manual, all payment attempts must be
initiated using a secret key.
If any actions are required for the payment, the PaymentIntent will
return to the requires_confirmation state
after those actions are completed. Your server needs to then
explicitly re-confirm the PaymentIntent to initiate the next payment
attempt.
Parameters
- payload intent_confirm_body -
Return Type
- Payment_intent|error - Successful response.
post payment_intents/[string intent]/increment_authorization
Isolated FunctionResource Function
function post payment_intents/[string intent]/increment_authorization(intent_increment_authorization_body payload, map<string|string[]> headers) returns Payment_intent|errorPerform an incremental authorization on an eligible
PaymentIntent. To be eligible, the
PaymentIntent’s status must be requires_capture and
incremental_authorization_supported
must be true.
Incremental authorizations attempt to increase the authorized amount on
your customer’s card to the new, higher amount provided. Similar to the
initial authorization, incremental authorizations can be declined. A
single PaymentIntent can call this endpoint multiple times to further
increase the authorized amount.
If the incremental authorization succeeds, the PaymentIntent object returns with the updated amount. If the incremental authorization fails, a card_declined error returns, and no other fields on the PaymentIntent or Charge update. The PaymentIntent object remains capturable for the previously authorized amount.
Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines. After it’s captured, a PaymentIntent can no longer be incremented.
Learn more about incremental authorizations.
Parameters
- payload intent_increment_authorization_body -
Return Type
- Payment_intent|error - Successful response.
post payment_intents/[string intent]/verify_microdeposits
Isolated FunctionResource Function
function post payment_intents/[string intent]/verify_microdeposits(intent_verify_microdeposits_body payload, map<string|string[]> headers) returns Payment_intent|errorVerifies microdeposits on a PaymentIntent object.
Parameters
- payload intent_verify_microdeposits_body -
Return Type
- Payment_intent|error - Successful response.
post payment_links
Isolated FunctionResource Function
function post payment_links(payment_links_body payload, map<string|string[]> headers) returns Payment_link|errorCreates a payment link.
Parameters
- payload payment_links_body -
Return Type
- Payment_link|error - Successful response.
post payment_links/[string payment_link]
Isolated FunctionResource Function
function post payment_links/[string payment_link](payment_links_payment_link_body payload, map<string|string[]> headers) returns Payment_link|errorUpdates a payment link.
Parameters
- payload payment_links_payment_link_body -
Return Type
- Payment_link|error - Successful response.
post payment_method_configurations
Isolated FunctionResource Function
function post payment_method_configurations(payment_method_configurations_body payload, map<string|string[]> headers) returns Payment_method_configuration|errorCreates a payment method configuration
Parameters
- payload payment_method_configurations_body -
Return Type
- Payment_method_configuration|error - Successful response.
post payment_method_configurations/[string configuration]
Isolated FunctionResource Function
function post payment_method_configurations/[string configuration](payment_method_configurations_configuration_body payload, map<string|string[]> headers) returns Payment_method_configuration|errorUpdate payment method configuration
Parameters
Return Type
- Payment_method_configuration|error - Successful response.
post payment_method_domains
Isolated FunctionResource Function
function post payment_method_domains(payment_method_domains_body payload, map<string|string[]> headers) returns Payment_method_domain|errorCreates a payment method domain.
Parameters
- payload payment_method_domains_body -
Return Type
- Payment_method_domain|error - Successful response.
post payment_method_domains/[string payment_method_domain]
Isolated FunctionResource Function
function post payment_method_domains/[string payment_method_domain](payment_method_domains_payment_method_domain_body payload, map<string|string[]> headers) returns Payment_method_domain|errorUpdates an existing payment method domain.
Parameters
Return Type
- Payment_method_domain|error - Successful response.
post payment_method_domains/[string payment_method_domain]/validate
Isolated FunctionResource Function
function post payment_method_domains/[string payment_method_domain]/validate(payment_method_domain_validate_body payload, map<string|string[]> headers) returns Payment_method_domain|errorSome 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. The payment method doesn’t appear in Elements for this domain until it is active.
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.
Related guides: Payment method domains.
Parameters
- payload payment_method_domain_validate_body -
Return Type
- Payment_method_domain|error - Successful response.
post payment_methods
Isolated FunctionResource Function
function post payment_methods(payment_methods_body payload, map<string|string[]> headers) returns Payment_method|errorCreates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.
Instead of creating a PaymentMethod directly, we recommend using the PaymentIntents API to accept a payment immediately or the SetupIntent API to collect payment method details ahead of a future payment.
Parameters
- payload payment_methods_body -
Return Type
- Payment_method|error - Successful response.
post payment_methods/[string payment_method]
Isolated FunctionResource Function
function post payment_methods/[string payment_method](payment_methods_payment_method_body payload, map<string|string[]> headers) returns Payment_method|errorUpdates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated.
Parameters
- payload payment_methods_payment_method_body -
Return Type
- Payment_method|error - Successful response.
post payment_methods/[string payment_method]/attach
Isolated FunctionResource Function
function post payment_methods/[string payment_method]/attach(payment_method_attach_body payload, map<string|string[]> headers) returns Payment_method|errorAttaches a PaymentMethod object to a Customer.
To attach a new PaymentMethod to a customer for future payments, we recommend you use a SetupIntent
or a PaymentIntent with setup_future_usage.
These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach
endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for
future use, which makes later declines and payment friction more likely.
See Optimizing cards for future payments for more information about setting up
future payments.
To use this PaymentMethod as the default for invoice or subscription payments,
set invoice_settings.default_payment_method,
on the Customer to the PaymentMethod’s ID.
Parameters
- payload payment_method_attach_body -
Return Type
- Payment_method|error - Successful response.
post payment_methods/[string payment_method]/detach
Isolated FunctionResource Function
function post payment_methods/[string payment_method]/detach(payment_method_detach_body payload, map<string|string[]> headers) returns Payment_method|errorDetaches 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.
Parameters
- payload payment_method_detach_body -
Return Type
- Payment_method|error - Successful response.
post payouts
Isolated FunctionResource Function
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.
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.
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.
Parameters
- payload payouts_body -
post payouts/[string payout]
Isolated FunctionResource Function
function post payouts/[string payout](payouts_payout_body payload, map<string|string[]> headers) returns Payout|errorUpdates 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.
Parameters
- payload payouts_payout_body -
post payouts/[string payout]/cancel
Isolated FunctionResource Function
function post payouts/[string payout]/cancel(payout_cancel_body payload, map<string|string[]> headers) returns Payout|errorYou 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.
Parameters
- payload payout_cancel_body -
post payouts/[string payout]/reverse
Isolated FunctionResource Function
function post payouts/[string payout]/reverse(payout_reverse_body payload, map<string|string[]> headers) returns Payout|errorReverses 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.
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.
Parameters
- payload payout_reverse_body -
post plans
Isolated FunctionResource Function
You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.
Parameters
- payload plans_body -
post plans/[string plan]
Isolated FunctionResource Function
function post plans/[string plan](plans_plan_body payload, map<string|string[]> headers) returns Plan|errorUpdates 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.
Parameters
- payload plans_plan_body -
post prices
Isolated FunctionResource Function
Creates a new price for an existing product. The price can be recurring or one-time.
Parameters
- payload prices_body -
post prices/[string price]
Isolated FunctionResource Function
function post prices/[string price](prices_price_body payload, map<string|string[]> headers) returns Price|errorUpdates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.
Parameters
- payload prices_price_body -
post products
Isolated FunctionResource Function
Creates a new product object.
Parameters
- payload products_body -
post products/[string id]
Isolated FunctionResource Function
function post products/[string id](products_id_body payload, map<string|string[]> headers) returns Product|errorUpdates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Parameters
- payload products_id_body -
post products/[string product]/features
Isolated FunctionResource Function
function post products/[string product]/features(product_features_body payload, map<string|string[]> headers) returns Product_feature|errorCreates a product_feature, which represents a feature attachment to a product
Parameters
- payload product_features_body -
Return Type
- Product_feature|error - Successful response.
post promotion_codes
Isolated FunctionResource Function
function post promotion_codes(promotion_codes_body payload, map<string|string[]> headers) returns Promotion_code|errorA promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.
Parameters
- payload promotion_codes_body -
Return Type
- Promotion_code|error - Successful response.
post promotion_codes/[string promotion_code]
Isolated FunctionResource Function
function post promotion_codes/[string promotion_code](promotion_codes_promotion_code_body payload, map<string|string[]> headers) returns Promotion_code|errorUpdates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.
Parameters
- payload promotion_codes_promotion_code_body -
Return Type
- Promotion_code|error - Successful response.
post quotes
Isolated FunctionResource Function
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.
Parameters
- payload quotes_body -
post quotes/[string quote]
Isolated FunctionResource Function
function post quotes/[string quote](quotes_quote_body payload, map<string|string[]> headers) returns Quote|errorA quote models prices and services for a customer.
Parameters
- payload quotes_quote_body -
post quotes/[string quote]/accept
Isolated FunctionResource Function
function post quotes/[string quote]/accept(quote_accept_body payload, map<string|string[]> headers) returns Quote|errorAccepts the specified quote.
Parameters
- payload quote_accept_body -
post quotes/[string quote]/cancel
Isolated FunctionResource Function
function post quotes/[string quote]/cancel(quote_cancel_body payload, map<string|string[]> headers) returns Quote|errorCancels the quote.
Parameters
- payload quote_cancel_body -
post quotes/[string quote]/finalize
Isolated FunctionResource Function
function post quotes/[string quote]/finalize(quote_finalize_body payload, map<string|string[]> headers) returns Quote|errorFinalizes the quote.
Parameters
- payload quote_finalize_body -
post radar/value_list_items
Isolated FunctionResource Function
function post radar/value_list_items(radar_value_list_items_body payload, map<string|string[]> headers) returns Radar\.value_list_item|errorCreates a new ValueListItem object, which is added to the specified parent value list.
Parameters
- payload radar_value_list_items_body -
Return Type
- Radar\.value_list_item|error - Successful response.
post radar/value_lists
Isolated FunctionResource Function
function post radar/value_lists(radar_value_lists_body payload, map<string|string[]> headers) returns Radar\.value_list|errorCreates a new ValueList object, which can then be referenced in rules.
Parameters
- payload radar_value_lists_body -
Return Type
- Radar\.value_list|error - Successful response.
post radar/value_lists/[string value_list]
Isolated FunctionResource Function
function post radar/value_lists/[string value_list](value_lists_value_list_body payload, map<string|string[]> headers) returns Radar\.value_list|errorUpdates 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.
Parameters
- payload value_lists_value_list_body -
Return Type
- Radar\.value_list|error - Successful response.
post refunds
Isolated FunctionResource Function
When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.
Creating a new refund will refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged.
You can optionally refund only part of a charge. You can do so multiple times, until the entire charge has been refunded.
Once entirely refunded, a charge can’t be refunded again. This method will raise an error when called on an already-refunded charge, or when trying to refund more money than is left on a charge.
Parameters
- payload refunds_body -
post refunds/[string refund]
Isolated FunctionResource Function
function post refunds/[string refund](refunds_refund_body_1 payload, map<string|string[]> headers) returns Refund|errorUpdates the refund that you specify by setting the values of the passed parameters. Any parameters that you don’t provide remain unchanged.
This request only accepts metadata as an argument.
Parameters
- payload refunds_refund_body_1 -
post refunds/[string refund]/cancel
Isolated FunctionResource Function
function post refunds/[string refund]/cancel(refund_cancel_body payload, map<string|string[]> headers) returns Refund|errorCancels a refund with a status of requires_action.
You can’t cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.
Parameters
- payload refund_cancel_body -
post reporting/report_runs
Isolated FunctionResource Function
function post reporting/report_runs(reporting_report_runs_body payload, map<string|string[]> headers) returns Reporting\.report_run|errorCreates a new object and begin running the report. (Certain report types require a live-mode API key.)
Parameters
- payload reporting_report_runs_body -
Return Type
- Reporting\.report_run|error - Successful response.
post reviews/[string review]/approve
Isolated FunctionResource Function
function post reviews/[string review]/approve(review_approve_body payload, map<string|string[]> headers) returns Review|errorApproves a Review object, closing it and removing it from the list of reviews.
Parameters
- payload review_approve_body -
post setup_intents
Isolated FunctionResource Function
function post setup_intents(setup_intents_body payload, map<string|string[]> headers) returns Setup_intent|errorCreates a SetupIntent object.
After you create the SetupIntent, attach a payment method and confirm it to collect any required permissions to charge the payment method later.
Parameters
- payload setup_intents_body -
Return Type
- Setup_intent|error - Successful response.
post setup_intents/[string intent]
Isolated FunctionResource Function
function post setup_intents/[string intent](setup_intents_intent_body payload, map<string|string[]> headers) returns Setup_intent|errorUpdates a SetupIntent object.
Parameters
- payload setup_intents_intent_body -
Return Type
- Setup_intent|error - Successful response.
post setup_intents/[string intent]/cancel
Isolated FunctionResource Function
function post setup_intents/[string intent]/cancel(intent_cancel_body_1 payload, map<string|string[]> headers) returns Setup_intent|errorYou can cancel a SetupIntent object when it’s in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.
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.
Parameters
- payload intent_cancel_body_1 -
Return Type
- Setup_intent|error - Successful response.
post setup_intents/[string intent]/confirm
Isolated FunctionResource Function
function post setup_intents/[string intent]/confirm(intent_confirm_body_1 payload, map<string|string[]> headers) returns Setup_intent|errorConfirm that your customer intends to set up the current or provided payment method. For example, you would confirm a SetupIntent when a customer hits the “Save” button on a payment method management page on your website.
If the selected payment method does not require any additional
steps from the customer, the SetupIntent will transition to the
succeeded status.
Otherwise, it will transition to the requires_action status and
suggest additional actions via next_action. If setup fails,
the SetupIntent will transition to the
requires_payment_method status or the canceled status if the
confirmation limit is reached.
Parameters
- payload intent_confirm_body_1 -
Return Type
- Setup_intent|error - Successful response.
post setup_intents/[string intent]/verify_microdeposits
Isolated FunctionResource Function
function post setup_intents/[string intent]/verify_microdeposits(intent_verify_microdeposits_body_1 payload, map<string|string[]> headers) returns Setup_intent|errorVerifies microdeposits on a SetupIntent object.
Parameters
- payload intent_verify_microdeposits_body_1 -
Return Type
- Setup_intent|error - Successful response.
post shipping_rates
Isolated FunctionResource Function
function post shipping_rates(shipping_rates_body payload, map<string|string[]> headers) returns Shipping_rate|errorCreates a new shipping rate object.
Parameters
- payload shipping_rates_body -
Return Type
- Shipping_rate|error - Successful response.
post shipping_rates/[string shipping_rate_token]
Isolated FunctionResource Function
function post shipping_rates/[string shipping_rate_token](shipping_rates_shipping_rate_token_body payload, map<string|string[]> headers) returns Shipping_rate|errorUpdates an existing shipping rate object.
Parameters
- payload shipping_rates_shipping_rate_token_body -
Return Type
- Shipping_rate|error - Successful response.
post sources
Isolated FunctionResource Function
Creates a new source object.
Parameters
- payload sources_body -
post sources/[string 'source]
Isolated FunctionResource Function
function post sources/[string 'source](sources_source_body payload, map<string|string[]> headers) returns Source|errorUpdates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our payment method guides for more detail.
Parameters
- payload sources_source_body -
post sources/[string 'source]/verify
Isolated FunctionResource Function
function post sources/[string 'source]/verify(source_verify_body payload, map<string|string[]> headers) returns Source|errorVerify a given source.
Parameters
- payload source_verify_body -
post subscription_items
Isolated FunctionResource Function
function post subscription_items(subscription_items_body payload, map<string|string[]> headers) returns Subscription_item|errorAdds a new item to an existing subscription. No existing items will be changed or replaced.
Parameters
- payload subscription_items_body -
Return Type
- Subscription_item|error - Successful response.
post subscription_items/[string item]
Isolated FunctionResource Function
function post subscription_items/[string item](subscription_items_item_body payload, map<string|string[]> headers) returns Subscription_item|errorUpdates the plan or quantity of an item on a current subscription.
Parameters
- payload subscription_items_item_body -
Return Type
- Subscription_item|error - Successful response.
post subscription_items/[string subscription_item]/usage_records
Isolated FunctionResource Function
function post subscription_items/[string subscription_item]/usage_records(subscription_item_usage_records_body payload, map<string|string[]> headers) returns Usage_record|errorCreates a usage record for a specified subscription item and date, and fills it with a quantity.
Usage records provide quantity information that Stripe uses to track how much a customer is using your service. With usage information and the pricing model set up by the metered billing plan, Stripe helps you send accurate invoices to your customers.
The default calculation for usage is to add up all the quantity values of the usage records within a billing period. You can change this default behavior with the billing plan’s aggregate_usage parameter. When there is more than one usage record with the same timestamp, Stripe adds the quantity values together. In most cases, this is the desired resolution, however, you can change this behavior with the action parameter.
The default pricing model for metered billing is per-unit pricing. For finer granularity, you can configure metered billing to have a tiered pricing model.
Parameters
- payload subscription_item_usage_records_body -
Return Type
- Usage_record|error - Successful response.
post subscription_schedules
Isolated FunctionResource Function
function post subscription_schedules(subscription_schedules_body payload, map<string|string[]> headers) returns Subscription_schedule|errorCreates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.
Parameters
- payload subscription_schedules_body -
Return Type
- Subscription_schedule|error - Successful response.
post subscription_schedules/[string schedule]
Isolated FunctionResource Function
function post subscription_schedules/[string schedule](subscription_schedules_schedule_body payload, map<string|string[]> headers) returns Subscription_schedule|errorUpdates an existing subscription schedule.
Parameters
- payload subscription_schedules_schedule_body -
Return Type
- Subscription_schedule|error - Successful response.
post subscription_schedules/[string schedule]/cancel
Isolated FunctionResource Function
function post subscription_schedules/[string schedule]/cancel(schedule_cancel_body payload, map<string|string[]> headers) returns Subscription_schedule|errorCancels 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.
Parameters
- payload schedule_cancel_body -
Return Type
- Subscription_schedule|error - Successful response.
post subscription_schedules/[string schedule]/release
Isolated FunctionResource Function
function post subscription_schedules/[string schedule]/release(schedule_release_body payload, map<string|string[]> headers) returns Subscription_schedule|errorReleases 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.
Parameters
- payload schedule_release_body -
Return Type
- Subscription_schedule|error - Successful response.
post subscriptions
Isolated FunctionResource Function
function post subscriptions(subscriptions_body payload, map<string|string[]> headers) returns Subscription|errorCreates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.
When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request.
The payment_behavior parameter determines the exact behavior of the initial payment.
To start subscriptions where the first invoice always begins in a draft status, use subscription schedules instead.
Schedules provide the flexibility to model more complex billing configurations that change over time.
Parameters
- payload subscriptions_body -
Return Type
- Subscription|error - Successful response.
post subscriptions/[string subscription]/resume
Isolated FunctionResource Function
function post subscriptions/[string subscription]/resume(subscription_resume_body payload, map<string|string[]> headers) returns Subscription|errorInitiates 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.
Parameters
- payload subscription_resume_body -
Return Type
- Subscription|error - Successful response.
post subscriptions/[string subscription_exposed_id]
Isolated FunctionResource Function
function post subscriptions/[string subscription_exposed_id](subscriptions_subscription_exposed_id_body_2 payload, map<string|string[]> headers) returns Subscription|errorUpdates an existing subscription to match the specified parameters. When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes. To preview how the proration is calculated, use the create preview endpoint.
By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a
Switching prices does not normally change the billing date or generate an immediate charge unless:
- The billing interval is changed (for example, from monthly to yearly).
- The subscription moves from free to paid.
- A trial starts or ends.
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. Learn about how Stripe immediately attempts payment for subscription changes.
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.
If you don’t want to prorate, set the proration_behavior option to none. With this option, the customer is billed 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.
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.
Parameters
Return Type
- Subscription|error - Successful response.
post tax/calculations
Isolated FunctionResource Function
function post tax/calculations(tax_calculations_body payload, map<string|string[]> headers) returns Tax\.calculation|errorCalculates tax based on the input and returns a Tax Calculation object.
Parameters
- payload tax_calculations_body -
Return Type
- Tax\.calculation|error - Successful response.
post tax/registrations
Isolated FunctionResource Function
function post tax/registrations(tax_registrations_body payload, map<string|string[]> headers) returns Tax\.registration|errorCreates a new Tax Registration object.
Parameters
- payload tax_registrations_body -
Return Type
- Tax\.registration|error - Successful response.
post tax/registrations/[string id]
Isolated FunctionResource Function
function post tax/registrations/[string id](registrations_id_body payload, map<string|string[]> headers) returns Tax\.registration|errorUpdates an existing Tax Registration object.
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.
Parameters
- payload registrations_id_body -
Return Type
- Tax\.registration|error - Successful response.
post tax/settings
Isolated FunctionResource Function
function post tax/settings(tax_settings_body payload, map<string|string[]> headers) returns Tax\.settings|errorUpdates Tax Settings parameters used in tax calculations. All parameters are editable but none can be removed once set.
Parameters
- payload tax_settings_body -
Return Type
- Tax\.settings|error - Successful response.
post tax/transactions/create_from_calculation
Isolated FunctionResource Function
function post tax/transactions/create_from_calculation(transactions_create_from_calculation_body payload, map<string|string[]> headers) returns Tax\.transaction|errorCreates a Tax Transaction from a calculation, if that calculation hasn’t expired. Calculations expire after 90 days.
Parameters
Return Type
- Tax\.transaction|error - Successful response.
post tax/transactions/create_reversal
Isolated FunctionResource Function
function post tax/transactions/create_reversal(transactions_create_reversal_body payload, map<string|string[]> headers) returns Tax\.transaction|errorPartially or fully reverses a previously created Transaction.
Parameters
- payload transactions_create_reversal_body -
Return Type
- Tax\.transaction|error - Successful response.
post tax_ids
Isolated FunctionResource Function
Creates a new account or customer tax_id object.
Parameters
- payload tax_ids_body -
post tax_rates
Isolated FunctionResource Function
function post tax_rates(tax_rates_body payload, map<string|string[]> headers) returns Tax_rate|errorCreates a new tax rate.
Parameters
- payload tax_rates_body -
post tax_rates/[string tax_rate]
Isolated FunctionResource Function
function post tax_rates/[string tax_rate](tax_rates_tax_rate_body payload, map<string|string[]> headers) returns Tax_rate|errorUpdates an existing tax rate.
Parameters
- payload tax_rates_tax_rate_body -
post terminal/configurations
Isolated FunctionResource Function
function post terminal/configurations(terminal_configurations_body payload, map<string|string[]> headers) returns Terminal\.configuration|errorCreates a new Configuration object.
Parameters
- payload terminal_configurations_body -
Return Type
- Terminal\.configuration|error - Successful response.
post terminal/configurations/[string configuration]
Isolated FunctionResource Function
function post terminal/configurations/[string configuration](configurations_configuration_body_1 payload, map<string|string[]> headers) returns inline_response_200_3|errorUpdates a new Configuration object.
Parameters
- payload configurations_configuration_body_1 -
Return Type
- inline_response_200_3|error - Successful response.
post terminal/connection_tokens
Isolated FunctionResource Function
function post terminal/connection_tokens(terminal_connection_tokens_body payload, map<string|string[]> headers) returns Terminal\.connection_token|errorTo 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.
Parameters
- payload terminal_connection_tokens_body -
Return Type
- Terminal\.connection_token|error - Successful response.
post terminal/locations
Isolated FunctionResource Function
function post terminal/locations(terminal_locations_body payload, map<string|string[]> headers) returns Terminal\.location|errorCreates a new Location object.
For further details, including which address fields are required in each country, see the Manage locations guide.
Parameters
- payload terminal_locations_body -
Return Type
- Terminal\.location|error - Successful response.
post terminal/locations/[string location]
Isolated FunctionResource Function
function post terminal/locations/[string location](locations_location_body payload, map<string|string[]> headers) returns inline_response_200_4|errorUpdates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Parameters
- payload locations_location_body -
Return Type
- inline_response_200_4|error - Successful response.
post terminal/readers
Isolated FunctionResource Function
function post terminal/readers(terminal_readers_body payload, map<string|string[]> headers) returns Terminal\.reader|errorCreates a new Reader object.
Parameters
- payload terminal_readers_body -
Return Type
- Terminal\.reader|error - Successful response.
post terminal/readers/[string reader]
Isolated FunctionResource Function
function post terminal/readers/[string reader](readers_reader_body payload, map<string|string[]> headers) returns inline_response_200_5|errorUpdates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Parameters
- payload readers_reader_body -
Return Type
- inline_response_200_5|error - Successful response.
post terminal/readers/[string reader]/cancel_action
Isolated FunctionResource Function
function post terminal/readers/[string reader]/cancel_action(reader_cancel_action_body payload, map<string|string[]> headers) returns Terminal\.reader|errorCancels the current reader action.
Parameters
- payload reader_cancel_action_body -
Return Type
- Terminal\.reader|error - Successful response.
post terminal/readers/[string reader]/process_payment_intent
Isolated FunctionResource Function
function post terminal/readers/[string reader]/process_payment_intent(reader_process_payment_intent_body payload, map<string|string[]> headers) returns Terminal\.reader|errorInitiates a payment flow on a Reader.
Parameters
- payload reader_process_payment_intent_body -
Return Type
- Terminal\.reader|error - Successful response.
post terminal/readers/[string reader]/process_setup_intent
Isolated FunctionResource Function
function post terminal/readers/[string reader]/process_setup_intent(reader_process_setup_intent_body payload, map<string|string[]> headers) returns Terminal\.reader|errorInitiates a setup intent flow on a Reader.
Parameters
- payload reader_process_setup_intent_body -
Return Type
- Terminal\.reader|error - Successful response.
post terminal/readers/[string reader]/refund_payment
Isolated FunctionResource Function
function post terminal/readers/[string reader]/refund_payment(reader_refund_payment_body payload, map<string|string[]> headers) returns Terminal\.reader|errorInitiates a refund on a Reader
Parameters
- payload reader_refund_payment_body -
Return Type
- Terminal\.reader|error - Successful response.
post terminal/readers/[string reader]/set_reader_display
Isolated FunctionResource Function
function post terminal/readers/[string reader]/set_reader_display(reader_set_reader_display_body payload, map<string|string[]> headers) returns Terminal\.reader|errorSets reader display to show cart details.
Parameters
- payload reader_set_reader_display_body -
Return Type
- Terminal\.reader|error - Successful response.
post test_helpers/confirmation_tokens
Isolated FunctionResource Function
function post test_helpers/confirmation_tokens(test_helpers_confirmation_tokens_body payload, map<string|string[]> headers) returns Confirmation_token|errorCreates a test mode Confirmation Token server side for your integration tests.
Parameters
- payload test_helpers_confirmation_tokens_body -
Return Type
- Confirmation_token|error - Successful response.
post test_helpers/customers/[string customer]/fund_cash_balance
Isolated FunctionResource Function
function post test_helpers/customers/[string customer]/fund_cash_balance(customer_fund_cash_balance_body payload, map<string|string[]> headers) returns Customer_cash_balance_transaction|errorCreate an incoming testmode bank transfer
Parameters
- payload customer_fund_cash_balance_body -
Return Type
- Customer_cash_balance_transaction|error - Successful response.
post test_helpers/issuing/authorizations
Isolated FunctionResource Function
function post test_helpers/issuing/authorizations(issuing_authorizations_body payload, map<string|string[]> headers) returns Issuing\.authorization|errorCreate a test-mode authorization.
Parameters
- payload issuing_authorizations_body -
Return Type
- Issuing\.authorization|error - Successful response.
post test_helpers/issuing/authorizations/[string authorization]/capture
Isolated FunctionResource Function
function post test_helpers/issuing/authorizations/[string authorization]/capture(authorization_capture_body payload, map<string|string[]> headers) returns Issuing\.authorization|errorCapture a test-mode authorization.
Parameters
- payload authorization_capture_body -
Return Type
- Issuing\.authorization|error - Successful response.
post test_helpers/issuing/authorizations/[string authorization]/expire
Isolated FunctionResource Function
function post test_helpers/issuing/authorizations/[string authorization]/expire(authorization_expire_body payload, map<string|string[]> headers) returns Issuing\.authorization|errorExpire a test-mode Authorization.
Parameters
- payload authorization_expire_body -
Return Type
- Issuing\.authorization|error - Successful response.
post test_helpers/issuing/authorizations/[string authorization]/finalize_amount
Isolated FunctionResource Function
function post test_helpers/issuing/authorizations/[string authorization]/finalize_amount(authorization_finalize_amount_body payload, map<string|string[]> headers) returns Issuing\.authorization|errorFinalize the amount on an Authorization prior to capture, when the initial authorization was for an estimated amount.
Parameters
- payload authorization_finalize_amount_body -
Return Type
- Issuing\.authorization|error - Successful response.
post test_helpers/issuing/authorizations/[string authorization]/increment
Isolated FunctionResource Function
function post test_helpers/issuing/authorizations/[string authorization]/increment(authorization_increment_body payload, map<string|string[]> headers) returns Issuing\.authorization|errorIncrement a test-mode Authorization.
Parameters
- payload authorization_increment_body -
Return Type
- Issuing\.authorization|error - Successful response.
post test_helpers/issuing/authorizations/[string authorization]/reverse
Isolated FunctionResource Function
function post test_helpers/issuing/authorizations/[string authorization]/reverse(authorization_reverse_body payload, map<string|string[]> headers) returns Issuing\.authorization|errorReverse a test-mode Authorization.
Parameters
- payload authorization_reverse_body -
Return Type
- Issuing\.authorization|error - Successful response.
post test_helpers/issuing/cards/[string card]/shipping/'fail
Isolated FunctionResource Function
function post test_helpers/issuing/cards/[string card]/shipping/'fail(shipping_fail_body payload, map<string|string[]> headers) returns Issuing\.card|errorpost test_helpers/issuing/cards/[string card]/shipping/'return
Isolated FunctionResource Function
function post test_helpers/issuing/cards/[string card]/shipping/'return(shipping_return_body payload, map<string|string[]> headers) returns Issuing\.card|errorpost test_helpers/issuing/cards/[string card]/shipping/deliver
Isolated FunctionResource Function
function post test_helpers/issuing/cards/[string card]/shipping/deliver(shipping_deliver_body payload, map<string|string[]> headers) returns Issuing\.card|errorUpdates the shipping status of the specified Issuing Card object to delivered.
Parameters
- payload shipping_deliver_body -
Return Type
- Issuing\.card|error - Successful response.
post test_helpers/issuing/cards/[string card]/shipping/ship
Isolated FunctionResource Function
function post test_helpers/issuing/cards/[string card]/shipping/ship(shipping_ship_body payload, map<string|string[]> headers) returns Issuing\.card|errorUpdates the shipping status of the specified Issuing Card object to shipped.
Parameters
- payload shipping_ship_body -
Return Type
- Issuing\.card|error - Successful response.
post test_helpers/issuing/personalization_designs/[string personalization_design]/activate
Isolated FunctionResource Function
function post test_helpers/issuing/personalization_designs/[string personalization_design]/activate(personalization_design_activate_body payload, map<string|string[]> headers) returns Issuing\.personalization_design|errorUpdates the status of the specified testmode personalization design object to active.
Parameters
- payload personalization_design_activate_body -
Return Type
- Issuing\.personalization_design|error - Successful response.
post test_helpers/issuing/personalization_designs/[string personalization_design]/deactivate
Isolated FunctionResource Function
function post test_helpers/issuing/personalization_designs/[string personalization_design]/deactivate(personalization_design_deactivate_body payload, map<string|string[]> headers) returns Issuing\.personalization_design|errorUpdates the status of the specified testmode personalization design object to inactive.
Parameters
- payload personalization_design_deactivate_body -
Return Type
- Issuing\.personalization_design|error - Successful response.
post test_helpers/issuing/personalization_designs/[string personalization_design]/reject
Isolated FunctionResource Function
function post test_helpers/issuing/personalization_designs/[string personalization_design]/reject(personalization_design_reject_body payload, map<string|string[]> headers) returns Issuing\.personalization_design|errorUpdates the status of the specified testmode personalization design object to rejected.
Parameters
- payload personalization_design_reject_body -
Return Type
- Issuing\.personalization_design|error - Successful response.
post test_helpers/issuing/transactions/[string 'transaction]/refund
Isolated FunctionResource Function
function post test_helpers/issuing/transactions/[string 'transaction]/refund(transaction_refund_body payload, map<string|string[]> headers) returns Issuing\.transaction|errorRefund a test-mode Transaction.
Parameters
- payload transaction_refund_body -
Return Type
- Issuing\.transaction|error - Successful response.
post test_helpers/issuing/transactions/create_force_capture
Isolated FunctionResource Function
function post test_helpers/issuing/transactions/create_force_capture(transactions_create_force_capture_body payload, map<string|string[]> headers) returns Issuing\.transaction|errorAllows the user to capture an arbitrary amount, also known as a forced capture.
Parameters
- payload transactions_create_force_capture_body -
Return Type
- Issuing\.transaction|error - Successful response.
post test_helpers/issuing/transactions/create_unlinked_refund
Isolated FunctionResource Function
function post test_helpers/issuing/transactions/create_unlinked_refund(transactions_create_unlinked_refund_body payload, map<string|string[]> headers) returns Issuing\.transaction|errorAllows the user to refund an arbitrary amount, also known as a unlinked refund.
Parameters
- payload transactions_create_unlinked_refund_body -
Return Type
- Issuing\.transaction|error - Successful response.
post test_helpers/refunds/[string refund]/expire
Isolated FunctionResource Function
function post test_helpers/refunds/[string refund]/expire(refund_expire_body payload, map<string|string[]> headers) returns Refund|errorExpire a refund with a status of requires_action.
Parameters
- payload refund_expire_body -
post test_helpers/terminal/readers/[string reader]/present_payment_method
Isolated FunctionResource Function
function post test_helpers/terminal/readers/[string reader]/present_payment_method(reader_present_payment_method_body payload, map<string|string[]> headers) returns Terminal\.reader|errorPresents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction.
Parameters
- payload reader_present_payment_method_body -
Return Type
- Terminal\.reader|error - Successful response.
post test_helpers/test_clocks
Isolated FunctionResource Function
function post test_helpers/test_clocks(test_helpers_test_clocks_body payload, map<string|string[]> headers) returns Test_helpers\.test_clock|errorCreates a new test clock that can be attached to new customers and quotes.
Parameters
- payload test_helpers_test_clocks_body -
Return Type
- Test_helpers\.test_clock|error - Successful response.
post test_helpers/test_clocks/[string test_clock]/advance
Isolated FunctionResource Function
function post test_helpers/test_clocks/[string test_clock]/advance(test_clock_advance_body payload, map<string|string[]> headers) returns Test_helpers\.test_clock|errorStarts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.
Parameters
- payload test_clock_advance_body -
Return Type
- Test_helpers\.test_clock|error - Successful response.
post test_helpers/treasury/inbound_transfers/[string id]/'fail
Isolated FunctionResource Function
function post test_helpers/treasury/inbound_transfers/[string id]/'fail(id_fail_body payload, map<string|string[]> headers) returns Treasury\.inbound_transfer|errorpost test_helpers/treasury/inbound_transfers/[string id]/'return
Isolated FunctionResource Function
function post test_helpers/treasury/inbound_transfers/[string id]/'return(id_return_body payload, map<string|string[]> headers) returns Treasury\.inbound_transfer|errorpost test_helpers/treasury/inbound_transfers/[string id]/succeed
Isolated FunctionResource Function
function post test_helpers/treasury/inbound_transfers/[string id]/succeed(id_succeed_body payload, map<string|string[]> headers) returns Treasury\.inbound_transfer|errorTransitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.
Parameters
- payload id_succeed_body -
Return Type
- Treasury\.inbound_transfer|error - Successful response.
post test_helpers/treasury/outbound_payments/[string id]
Isolated FunctionResource Function
function post test_helpers/treasury/outbound_payments/[string id](outbound_payments_id_body payload, map<string|string[]> headers) returns Treasury\.outbound_payment|errorUpdates a test mode created OutboundPayment with tracking details. The OutboundPayment must not be cancelable, and cannot be in the canceled or failed states.
Parameters
- payload outbound_payments_id_body -
Return Type
- Treasury\.outbound_payment|error - Successful response.
post test_helpers/treasury/outbound_payments/[string id]/'fail
Isolated FunctionResource Function
function post test_helpers/treasury/outbound_payments/[string id]/'fail(id_fail_body_1 payload, map<string|string[]> headers) returns Treasury\.outbound_payment|errorpost test_helpers/treasury/outbound_payments/[string id]/'return
Isolated FunctionResource Function
function post test_helpers/treasury/outbound_payments/[string id]/'return(id_return_body_1 payload, map<string|string[]> headers) returns Treasury\.outbound_payment|errorpost test_helpers/treasury/outbound_payments/[string id]/post
Isolated FunctionResource Function
function post test_helpers/treasury/outbound_payments/[string id]/post(id_post_body payload, map<string|string[]> headers) returns Treasury\.outbound_payment|errorTransitions a test mode created OutboundPayment to the posted status. The OutboundPayment must already be in the processing state.
Parameters
- payload id_post_body -
Return Type
- Treasury\.outbound_payment|error - Successful response.
post test_helpers/treasury/outbound_transfers/[string outbound_transfer]
Isolated FunctionResource Function
function post test_helpers/treasury/outbound_transfers/[string outbound_transfer](outbound_transfers_outbound_transfer_body payload, map<string|string[]> headers) returns Treasury\.outbound_transfer|errorUpdates a test mode created OutboundTransfer with tracking details. The OutboundTransfer must not be cancelable, and cannot be in the canceled or failed states.
Parameters
Return Type
- Treasury\.outbound_transfer|error - Successful response.
post test_helpers/treasury/outbound_transfers/[string outbound_transfer]/'fail
Isolated FunctionResource Function
function post test_helpers/treasury/outbound_transfers/[string outbound_transfer]/'fail(outbound_transfer_fail_body payload, map<string|string[]> headers) returns Treasury\.outbound_transfer|errorpost test_helpers/treasury/outbound_transfers/[string outbound_transfer]/'return
Isolated FunctionResource Function
function post test_helpers/treasury/outbound_transfers/[string outbound_transfer]/'return(outbound_transfer_return_body payload, map<string|string[]> headers) returns Treasury\.outbound_transfer|errorpost test_helpers/treasury/outbound_transfers/[string outbound_transfer]/post
Isolated FunctionResource Function
function post test_helpers/treasury/outbound_transfers/[string outbound_transfer]/post(outbound_transfer_post_body payload, map<string|string[]> headers) returns Treasury\.outbound_transfer|errorTransitions a test mode created OutboundTransfer to the posted status. The OutboundTransfer must already be in the processing state.
Parameters
- payload outbound_transfer_post_body -
Return Type
- Treasury\.outbound_transfer|error - Successful response.
post test_helpers/treasury/received_credits
Isolated FunctionResource Function
function post test_helpers/treasury/received_credits(treasury_received_credits_body payload, map<string|string[]> headers) returns Treasury\.received_credit|errorUse 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.
Parameters
- payload treasury_received_credits_body -
Return Type
- Treasury\.received_credit|error - Successful response.
post test_helpers/treasury/received_debits
Isolated FunctionResource Function
function post test_helpers/treasury/received_debits(treasury_received_debits_body payload, map<string|string[]> headers) returns Treasury\.received_debit|errorUse 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.
Parameters
- payload treasury_received_debits_body -
Return Type
- Treasury\.received_debit|error - Successful response.
post tokens
Isolated FunctionResource Function
Creates a single-use token that represents a bank account’s details.
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.
Parameters
- payload tokens_body -
post topups
Isolated FunctionResource Function
Top up the balance of an account
Parameters
- payload topups_body -
post topups/[string topup]
Isolated FunctionResource Function
function post topups/[string topup](topups_topup_body payload, map<string|string[]> headers) returns Topup|errorUpdates the metadata of a top-up. Other top-up details are not editable by design.
Parameters
- payload topups_topup_body -
post topups/[string topup]/cancel
Isolated FunctionResource Function
function post topups/[string topup]/cancel(topup_cancel_body payload, map<string|string[]> headers) returns Topup|errorCancels a top-up. Only pending top-ups can be canceled.
Parameters
- payload topup_cancel_body -
post transfers
Isolated FunctionResource Function
function post transfers(transfers_body payload, map<string|string[]> headers) returns Transfer|errorTo 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.
Parameters
- payload transfers_body -
post transfers/[string id]/reversals
Isolated FunctionResource Function
function post transfers/[string id]/reversals(id_reversals_body payload, map<string|string[]> headers) returns Transfer_reversal|errorWhen you create a new reversal, you must specify a transfer to create it on.
When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until the entire transfer has been reversed.
Once entirely reversed, a transfer can’t be reversed again. This method will return an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer.
Parameters
- payload id_reversals_body -
Return Type
- Transfer_reversal|error - Successful response.
post transfers/[string transfer]
Isolated FunctionResource Function
function post transfers/[string transfer](transfers_transfer_body payload, map<string|string[]> headers) returns Transfer|errorUpdates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
This request accepts only metadata as an argument.
Parameters
- payload transfers_transfer_body -
post transfers/[string transfer]/reversals/[string id]
Isolated FunctionResource Function
function post transfers/[string transfer]/reversals/[string id](reversals_id_body payload, map<string|string[]> headers) returns Transfer_reversal|errorUpdates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
This request only accepts metadata and description as arguments.
Parameters
- payload reversals_id_body -
Return Type
- Transfer_reversal|error - Successful response.
post treasury/credit_reversals
Isolated FunctionResource Function
function post treasury/credit_reversals(treasury_credit_reversals_body payload, map<string|string[]> headers) returns Treasury\.credit_reversal|errorReverses a ReceivedCredit and creates a CreditReversal object.
Parameters
- payload treasury_credit_reversals_body -
Return Type
- Treasury\.credit_reversal|error - Successful response.
post treasury/debit_reversals
Isolated FunctionResource Function
function post treasury/debit_reversals(treasury_debit_reversals_body payload, map<string|string[]> headers) returns Treasury\.debit_reversal|errorReverses a ReceivedDebit and creates a DebitReversal object.
Parameters
- payload treasury_debit_reversals_body -
Return Type
- Treasury\.debit_reversal|error - Successful response.
post treasury/financial_accounts
Isolated FunctionResource Function
function post treasury/financial_accounts(treasury_financial_accounts_body payload, map<string|string[]> headers) returns Treasury\.financial_account|errorCreates a new FinancialAccount. For now, each connected account can only have one FinancialAccount.
Parameters
- payload treasury_financial_accounts_body -
Return Type
- Treasury\.financial_account|error - Successful response.
post treasury/financial_accounts/[string financial_account]
Isolated FunctionResource Function
function post treasury/financial_accounts/[string financial_account](financial_accounts_financial_account_body payload, map<string|string[]> headers) returns Treasury\.financial_account|errorUpdates the details of a FinancialAccount.
Parameters
Return Type
- Treasury\.financial_account|error - Successful response.
post treasury/financial_accounts/[string financial_account]/features
Isolated FunctionResource Function
function post treasury/financial_accounts/[string financial_account]/features(financial_account_features_body payload, map<string|string[]> headers) returns Treasury\.financial_account_features|errorUpdates the Features associated with a FinancialAccount.
Parameters
- payload financial_account_features_body -
Return Type
- Treasury\.financial_account_features|error - Successful response.
post treasury/inbound_transfers
Isolated FunctionResource Function
function post treasury/inbound_transfers(treasury_inbound_transfers_body payload, map<string|string[]> headers) returns Treasury\.inbound_transfer|errorCreates an InboundTransfer.
Parameters
- payload treasury_inbound_transfers_body -
Return Type
- Treasury\.inbound_transfer|error - Successful response.
post treasury/inbound_transfers/[string inbound_transfer]/cancel
Isolated FunctionResource Function
function post treasury/inbound_transfers/[string inbound_transfer]/cancel(inbound_transfer_cancel_body payload, map<string|string[]> headers) returns Treasury\.inbound_transfer|errorCancels an InboundTransfer.
Parameters
- payload inbound_transfer_cancel_body -
Return Type
- Treasury\.inbound_transfer|error - Successful response.
post treasury/outbound_payments
Isolated FunctionResource Function
function post treasury/outbound_payments(treasury_outbound_payments_body payload, map<string|string[]> headers) returns Treasury\.outbound_payment|errorCreates an OutboundPayment.
Parameters
- payload treasury_outbound_payments_body -
Return Type
- Treasury\.outbound_payment|error - Successful response.
post treasury/outbound_payments/[string id]/cancel
Isolated FunctionResource Function
function post treasury/outbound_payments/[string id]/cancel(id_cancel_body payload, map<string|string[]> headers) returns Treasury\.outbound_payment|errorCancel an OutboundPayment.
Parameters
- payload id_cancel_body -
Return Type
- Treasury\.outbound_payment|error - Successful response.
post treasury/outbound_transfers
Isolated FunctionResource Function
function post treasury/outbound_transfers(treasury_outbound_transfers_body payload, map<string|string[]> headers) returns Treasury\.outbound_transfer|errorCreates an OutboundTransfer.
Parameters
- payload treasury_outbound_transfers_body -
Return Type
- Treasury\.outbound_transfer|error - Successful response.
post treasury/outbound_transfers/[string outbound_transfer]/cancel
Isolated FunctionResource Function
function post treasury/outbound_transfers/[string outbound_transfer]/cancel(outbound_transfer_cancel_body payload, map<string|string[]> headers) returns Treasury\.outbound_transfer|errorAn OutboundTransfer can be canceled if the funds have not yet been paid out.
Parameters
- payload outbound_transfer_cancel_body -
Return Type
- Treasury\.outbound_transfer|error - Successful response.
post webhook_endpoints
Isolated FunctionResource Function
function post webhook_endpoints(webhook_endpoints_body payload, map<string|string[]> headers) returns Webhook_endpoint|errorA 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.
Parameters
- payload webhook_endpoints_body -
Return Type
- Webhook_endpoint|error - Successful response.
post webhook_endpoints/[string webhook_endpoint]
Isolated FunctionResource Function
function post webhook_endpoints/[string webhook_endpoint](webhook_endpoints_webhook_endpoint_body payload, map<string|string[]> headers) returns Webhook_endpoint|errorUpdates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.
Parameters
- payload webhook_endpoints_webhook_endpoint_body -
Return Type
- Webhook_endpoint|error - Successful response.
Records
stripe: aba_access
Fields
- requested boolean -
stripe: access
Fields
- requested boolean -
stripe: access_1
Encodes the FinancialAccount's ability to be used with the Issuing product, including attaching cards to and drawing funds from the FinancialAccount.
Fields
- requested boolean -
stripe: access_2
Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.
Fields
- requested boolean -
stripe: access_3
Represents the ability for the FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).
Fields
- requested boolean -
stripe: access_with_ach_details
Fields
- requested boolean -
stripe: Account
This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts.
For accounts where controller.requirement_collection
is application, which includes Custom accounts, the properties below are always
returned.
For accounts where controller.requirement_collection
is stripe, which includes Standard and Express accounts, some properties are only returned
until you create an Account Link or Account Session
to start Connect Onboarding. Learn about the differences between accounts.
Fields
- business_profile? Account_business_profile? - Business information about the account.
- business_type? "company"|"government_entity"|"individual"|"non_profit"? - The business type. After you create an Account Link or Account Session, this property is only returned for accounts where controller.requirement_collection is
application, which includes Custom accounts.
- capabilities? Account_capabilities -
- charges_enabled? boolean - Whether the account can create live charges.
- company? Legal_entity_company -
- controller? Account_unification_account_controller -
- country? string - The account's country.
- created? int - Time at which the account was connected. Measured in seconds since the Unix epoch.
- default_currency? string - Three-letter ISO currency code representing the default currency for the account. This must be a currency that Stripe supports in the account's country.
- details_submitted? boolean - Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to an onboarding flow to finish submitting account details.
- email? string? - An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform.
- external_accounts? ExternalAccountList_1 -
- future_requirements? Account_future_requirements -
- id string - Unique identifier for the object.
- individual? Person -
- metadata? record { string... } - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- 'object "account" - String representing the object's type. Objects of the same type share the same value.
- payouts_enabled? boolean - Whether Stripe can send payouts to this account.
- requirements? Account_requirements -
- settings? Account_settings? - Options for customizing how the account functions within Stripe.
- tos_acceptance? Account_tos_acceptance -
- 'type? "custom"|"express"|"none"|"standard" - The Stripe account type. Can be
standard,express,custom, ornone.
stripe: Account_annual_revenue
Fields
- amount? int? - A non-negative integer representing the amount in the smallest currency unit.
- currency? string? - Three-letter ISO currency code, in lowercase. Must be a supported currency.
- fiscal_year_end? string? - The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023.
stripe: Account_bacs_debit_payments_settings
Fields
- display_name? string? - The Bacs Direct Debit display name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. The fee appears 5 business days after requesting Bacs. If you don't set the display name before requesting Bacs capability, it's automatically set as "Stripe" and the account is onboarded to Stripe branding, which is free.
- service_user_number? string? - The Bacs Direct Debit Service user number for this account. For payments made with Bacs Direct Debit, this number is a unique identifier of the account with our banking partners.
stripe: account_bank_accounts_body
Closed record
Fields
- bank_account? record { account_holder_name string, account_holder_type "company"|"individual" , account_number string, account_type "checking"|"futsu"|"savings"|"toza" , country string, currency string, documents record { bank_account_ownership_verification record { files bank_account_ownership_verificationFilesItemsString[] } }, 'object "bank_account" , routing_number string }|string - Either a token, like the ones returned by Stripe.js, or a dictionary containing a user's bank account details.
- default_for_currency? boolean - When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.
- expand? account_bank_accounts_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- external_account? string - Please refer to full documentation instead.
- metadata? record { string... } - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
stripe: Account_branding_settings
Fields
- icon? string|File? - (ID of a file upload) An icon for the account. Must be square and at least 128px x 128px.
- logo? string|File? - (ID of a file upload) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px.
- primary_color? string? - A CSS hex color value representing the primary branding color for this account
- secondary_color? string? - A CSS hex color value representing the secondary branding color for this account
stripe: Account_business_profile
Fields
- annual_revenue? Account_annual_revenue? - The applicant's gross annual revenue for its preceding fiscal year.
- estimated_worker_count? int? - An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.
- mcc? string? - The merchant category code for the account. MCCs are used to classify businesses based on the goods or services they provide.
- monthly_estimated_revenue? Account_monthly_estimated_revenue -
- name? string? - The customer-facing business name.
- product_description? string? - Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes.
- support_address? Address? - A publicly available mailing address for sending support issues to.
- support_email? string? - A publicly available email address for sending support issues to.
- support_phone? string? - A publicly available phone number to call with support issues.
- support_url? string? - A publicly available website for handling support issues.
- url? string? - The business's publicly available website.
stripe: Account_capabilities
Fields
- acss_debit_payments? "active"|"inactive"|"pending" - The status of the Canadian pre-authorized debits payments capability of the account, or whether the account can directly process Canadian pre-authorized debits charges.
- affirm_payments? "active"|"inactive"|"pending" - The status of the Affirm capability of the account, or whether the account can directly process Affirm charges.
- afterpay_clearpay_payments? "active"|"inactive"|"pending" - The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges.
- amazon_pay_payments? "active"|"inactive"|"pending" - The status of the AmazonPay capability of the account, or whether the account can directly process AmazonPay payments.
- au_becs_debit_payments? "active"|"inactive"|"pending" - The status of the BECS Direct Debit (AU) payments capability of the account, or whether the account can directly process BECS Direct Debit (AU) charges.
- bacs_debit_payments? "active"|"inactive"|"pending" - The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges.
- bancontact_payments? "active"|"inactive"|"pending" - The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges.
- bank_transfer_payments? "active"|"inactive"|"pending" - The status of the customer_balance payments capability of the account, or whether the account can directly process customer_balance charges.
- blik_payments? "active"|"inactive"|"pending" - The status of the blik payments capability of the account, or whether the account can directly process blik charges.
- boleto_payments? "active"|"inactive"|"pending" - The status of the boleto payments capability of the account, or whether the account can directly process boleto charges.
- card_issuing? "active"|"inactive"|"pending" - The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards
- card_payments? "active"|"inactive"|"pending" - The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges.
- cartes_bancaires_payments? "active"|"inactive"|"pending" - The status of the Cartes Bancaires payments capability of the account, or whether the account can directly process Cartes Bancaires card charges in EUR currency.
- cashapp_payments? "active"|"inactive"|"pending" - The status of the Cash App Pay capability of the account, or whether the account can directly process Cash App Pay payments.
- eps_payments? "active"|"inactive"|"pending" - The status of the EPS payments capability of the account, or whether the account can directly process EPS charges.
- fpx_payments? "active"|"inactive"|"pending" - The status of the FPX payments capability of the account, or whether the account can directly process FPX charges.
- gb_bank_transfer_payments? "active"|"inactive"|"pending" - The status of the GB customer_balance payments (GBP currency) capability of the account, or whether the account can directly process GB customer_balance charges.
- giropay_payments? "active"|"inactive"|"pending" - The status of the giropay payments capability of the account, or whether the account can directly process giropay charges.
- grabpay_payments? "active"|"inactive"|"pending" - The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges.
- ideal_payments? "active"|"inactive"|"pending" - The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges.
- india_international_payments? "active"|"inactive"|"pending" - The status of the india_international_payments capability of the account, or whether the account can process international charges (non INR) in India.
- jcb_payments? "active"|"inactive"|"pending" - The status of the JCB payments capability of the account, or whether the account (Japan only) can directly process JCB credit card charges in JPY currency.
- jp_bank_transfer_payments? "active"|"inactive"|"pending" - The status of the Japanese customer_balance payments (JPY currency) capability of the account, or whether the account can directly process Japanese customer_balance charges.
- klarna_payments? "active"|"inactive"|"pending" - The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges.
- konbini_payments? "active"|"inactive"|"pending" - The status of the konbini payments capability of the account, or whether the account can directly process konbini charges.
- legacy_payments? "active"|"inactive"|"pending" - The status of the legacy payments capability of the account.
- link_payments? "active"|"inactive"|"pending" - The status of the link_payments capability of the account, or whether the account can directly process Link charges.
- mobilepay_payments? "active"|"inactive"|"pending" - The status of the MobilePay capability of the account, or whether the account can directly process MobilePay charges.
- multibanco_payments? "active"|"inactive"|"pending" - The status of the Multibanco payments capability of the account, or whether the account can directly process Multibanco charges.
- mx_bank_transfer_payments? "active"|"inactive"|"pending" - The status of the Mexican customer_balance payments (MXN currency) capability of the account, or whether the account can directly process Mexican customer_balance charges.
- oxxo_payments? "active"|"inactive"|"pending" - The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges.
- p24_payments? "active"|"inactive"|"pending" - The status of the P24 payments capability of the account, or whether the account can directly process P24 charges.
- paynow_payments? "active"|"inactive"|"pending" - The status of the paynow payments capability of the account, or whether the account can directly process paynow charges.
- promptpay_payments? "active"|"inactive"|"pending" - The status of the promptpay payments capability of the account, or whether the account can directly process promptpay charges.
- revolut_pay_payments? "active"|"inactive"|"pending" - The status of the RevolutPay capability of the account, or whether the account can directly process RevolutPay payments.
- sepa_bank_transfer_payments? "active"|"inactive"|"pending" - The status of the SEPA customer_balance payments (EUR currency) capability of the account, or whether the account can directly process SEPA customer_balance charges.
- sepa_debit_payments? "active"|"inactive"|"pending" - The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges.
- sofort_payments? "active"|"inactive"|"pending" - The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges.
- swish_payments? "active"|"inactive"|"pending" - The status of the Swish capability of the account, or whether the account can directly process Swish payments.
- tax_reporting_us_1099_k? "active"|"inactive"|"pending" - The status of the tax reporting 1099-K (US) capability of the account.
- tax_reporting_us_1099_misc? "active"|"inactive"|"pending" - The status of the tax reporting 1099-MISC (US) capability of the account.
- transfers? "active"|"inactive"|"pending" - The status of the transfers capability of the account, or whether your platform can transfer funds to the account.
- treasury? "active"|"inactive"|"pending" - The status of the banking capability, or whether the account can have bank accounts.
- twint_payments? "active"|"inactive"|"pending" - The status of the TWINT capability of the account, or whether the account can directly process TWINT charges.
- us_bank_account_ach_payments? "active"|"inactive"|"pending" - The status of the US bank account ACH payments capability of the account, or whether the account can directly process US bank account charges.
- us_bank_transfer_payments? "active"|"inactive"|"pending" - The status of the US customer_balance payments (USD currency) capability of the account, or whether the account can directly process US customer_balance charges.
- zip_payments? "active"|"inactive"|"pending" - The status of the Zip capability of the account, or whether the account can directly process Zip charges.
stripe: Account_capability_future_requirements
Fields
- alternatives? Account_requirements_alternative[]? - Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
- current_deadline? int? - Date on which
future_requirementsmerges with the mainrequirementshash andfuture_requirementsbecomes empty. After the transition,currently_duerequirements may immediately becomepast_due, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning.
- currently_due Account_capability_future_requirementsCurrentlydueItemsString[] - Fields that need to be collected to keep the capability enabled. If not collected by
future_requirements[current_deadline], these fields will transition to the mainrequirementshash.
- disabled_reason? "other"|"paused.inactivity"|"pending.onboarding"|"pending.review"|"platform_disabled"|"platform_paused"|"rejected.inactivity"|"rejected.other"|"rejected.unsupported_business"|"requirements.fields_needed"? - This is typed as an enum for consistency with
requirements.disabled_reason, but it safe to assumefuture_requirements.disabled_reasonis null because fields infuture_requirementswill never disable the account.
- errors Account_requirements_error[] - Fields that are
currently_dueand need to be collected again because validation or verification failed.
- eventually_due Account_capability_future_requirementsEventuallydueItemsString[] - Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in
currently_dueas well.
- past_due Account_capability_future_requirementsPastdueItemsString[] - Fields that weren't collected by
requirements.current_deadline. These fields need to be collected to enable the capability on the account. New fields will never appear here;future_requirements.past_duewill always be a subset ofrequirements.past_due.
- pending_verification Account_capability_future_requirementsPendingverificationItemsString[] - Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to
eventually_dueorcurrently_due. Fields might appear ineventually_dueorcurrently_dueand inpending_verificationif verification fails but another verification is still pending.
stripe: Account_capability_requirements
Fields
- alternatives? Account_requirements_alternative[]? - Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
- current_deadline? int? - Date by which the fields in
currently_duemust be collected to keep the capability enabled for the account. These fields may disable the capability sooner if the next threshold is reached before they are collected.
- currently_due Account_capability_requirementsCurrentlydueItemsString[] - Fields that need to be collected to keep the capability enabled. If not collected by
current_deadline, these fields appear inpast_dueas well, and the capability is disabled.
- disabled_reason? "other"|"paused.inactivity"|"pending.onboarding"|"pending.review"|"platform_disabled"|"platform_paused"|"rejected.inactivity"|"rejected.other"|"rejected.unsupported_business"|"requirements.fields_needed"? - Description of why the capability is disabled. Learn more about handling verification issues.
- errors Account_requirements_error[] - Fields that are
currently_dueand need to be collected again because validation or verification failed.
- eventually_due Account_capability_requirementsEventuallydueItemsString[] - Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in
currently_dueas well, andcurrent_deadlinebecomes set.
- past_due Account_capability_requirementsPastdueItemsString[] - Fields that weren't collected by
current_deadline. These fields need to be collected to enable the capability on the account.
- pending_verification Account_capability_requirementsPendingverificationItemsString[] - Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to
eventually_due,currently_due, orpast_due. Fields might appear ineventually_due,currently_due, orpast_dueand inpending_verificationif verification fails but another verification is still pending.
stripe: Account_card_issuing_settings
Fields
- tos_acceptance? Card_issuing_account_terms_of_service -
stripe: Account_card_payments_settings
Fields
- decline_on? Account_decline_charge_on -
- statement_descriptor_prefix? string? - The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic
statement_descriptorspecified on the charge.statement_descriptor_prefixis useful for maximizing descriptor space for the dynamic portion.
- statement_descriptor_prefix_kana? string? - The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic
statement_descriptor_suffix_kanaspecified on the charge.statement_descriptor_prefix_kanais useful for maximizing descriptor space for the dynamic portion.
- statement_descriptor_prefix_kanji? string? - The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic
statement_descriptor_suffix_kanjispecified on the charge.statement_descriptor_prefix_kanjiis useful for maximizing descriptor space for the dynamic portion.
stripe: account_config_param
Fields
- enabled boolean -
- features? account_features_param -
stripe: Account_dashboard_settings
Fields
- display_name? string? - The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts.
- timezone? string? - The timezone used in the Stripe Dashboard for this account. A list of possible time zone values is maintained at the IANA Time Zone Database.
stripe: Account_decline_charge_on
Fields
- avs_failure boolean - Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification.
- cvc_failure boolean - Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification.
stripe: account_disconnect_body
Closed record
Fields
- expand? account_disconnect_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: account_disconnect_body_1
Closed record
Fields
- expand? account_disconnect_body_1ExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: account_external_accounts_body
Closed record
Fields
- bank_account? record { account_holder_name string, account_holder_type "company"|"individual" , account_number string, account_type "checking"|"futsu"|"savings"|"toza" , country string, currency string, documents record { bank_account_ownership_verification record { files bank_account_ownership_verificationFilesItemsString[] } }, 'object "bank_account" , routing_number string }|string - Either a token, like the ones returned by Stripe.js, or a dictionary containing a user's bank account details.
- default_for_currency? boolean - When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.
- expand? account_external_accounts_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- external_account? string - Please refer to full documentation instead.
- metadata? record { string... } - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
stripe: account_features_param
Fields
- external_account_collection? boolean -
stripe: Account_future_requirements
Fields
- alternatives? Account_requirements_alternative[]? - Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
- current_deadline? int? - Date on which
future_requirementsmerges with the mainrequirementshash andfuture_requirementsbecomes empty. After the transition,currently_duerequirements may immediately becomepast_due, but the account may also be given a grace period depending on its enablement state prior to transitioning.
- currently_due? Account_future_requirementsCurrentlydueItemsString[]? - Fields that need to be collected to keep the account enabled. If not collected by
future_requirements[current_deadline], these fields will transition to the mainrequirementshash.
- disabled_reason? string? - This is typed as a string for consistency with
requirements.disabled_reason.
- errors? Account_requirements_error[]? - Fields that are
currently_dueand need to be collected again because validation or verification failed.
- eventually_due? Account_future_requirementsEventuallydueItemsString[]? - Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in
currently_dueas well.
- past_due? Account_future_requirementsPastdueItemsString[]? - Fields that weren't collected by
requirements.current_deadline. These fields need to be collected to enable the capability on the account. New fields will never appear here;future_requirements.past_duewill always be a subset ofrequirements.past_due.
- pending_verification? Account_future_requirementsPendingverificationItemsString[]? - Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to
eventually_dueorcurrently_due. Fields might appear ineventually_dueorcurrently_dueand inpending_verificationif verification fails but another verification is still pending.
stripe: Account_invoices_settings
Fields
stripe: Account_link
Account Links are the means by which a Connect platform grants a connected account permission to access Stripe-hosted applications, such as Connect Onboarding.
Related guide: Connect Onboarding
Fields
- created int - Time at which the object was created. Measured in seconds since the Unix epoch.
- expires_at int - The timestamp at which this account link will expire.
- 'object "account_link" - String representing the object's type. Objects of the same type share the same value.
- url string - The URL for the account link.
stripe: account_links_body
Closed record
Fields
- account string - The identifier of the account to create an account link for.
- collect? "currently_due"|"eventually_due" - The collect parameter is deprecated. Use
collection_optionsinstead.
- collection_options? collection_options_params -
- expand? account_links_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- refresh_url? string - The URL the user will be redirected to if the account link is expired, has been previously-visited, or is otherwise invalid. The URL you specify should attempt to generate a new account link with the same parameters used to create the original account link, then redirect the user to the new account link's URL so they can continue with Connect Onboarding. If a new account link cannot be generated or the redirect fails you should display a useful error to the user.
- return_url? string - The URL that the user will be redirected to upon leaving or completing the linked flow.
- 'type "account_onboarding"|"account_update" - The type of account link the user is requesting. Possible values are
account_onboardingoraccount_update.
stripe: account_login_links_body
Closed record
Fields
- expand? account_login_links_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: Account_monthly_estimated_revenue
Fields
- amount int - A non-negative integer representing how much to charge in the smallest currency unit.
- currency string - Three-letter ISO currency code, in lowercase. Must be a supported currency.
stripe: Account_payments_settings
Fields
- statement_descriptor? string? - The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic
statement_descriptorspecified on the charge.
- statement_descriptor_kana? string? - The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only)
- statement_descriptor_kanji? string? - The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only)
- statement_descriptor_prefix_kana? string? - The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic
statement_descriptor_suffix_kanaspecified on the charge.statement_descriptor_prefix_kanais useful for maximizing descriptor space for the dynamic portion.
- statement_descriptor_prefix_kanji? string? - The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic
statement_descriptor_suffix_kanjispecified on the charge.statement_descriptor_prefix_kanjiis useful for maximizing descriptor space for the dynamic portion.
stripe: Account_payout_settings
Fields
- debit_negative_balances boolean - A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See Understanding Connect account balances for details. The default value is
falsewhen controller.requirement_collection isapplication, which includes Custom accounts, otherwisetrue.
- schedule Transfer_schedule -
- statement_descriptor? string? - The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.
stripe: account_people_body
Closed record
Fields
- additional_tos_acceptances? person_additional_tos_acceptances_specs -
- address? legal_entity_and_kyc_address_specs_1 -
- address_kana? japan_address_kana_specs_1 -
- address_kanji? japan_address_kanji_specs_1 -
- documents? person_documents_specs -
- email? string - The person's email address.
- expand? account_people_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- first_name? string - The person's first name.
- first_name_kana? string - The Kana variation of the person's first name (Japan only).
- first_name_kanji? string - The Kanji variation of the person's first name (Japan only).
- full_name_aliases? FullnamealiasesItemsString[]|"" - A list of alternate names or aliases that the person is known by.
- gender? string - The person's gender (International regulations require either "male" or "female").
- id_number? string - The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js.
- id_number_secondary? string - The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a PII token provided by Stripe.js.
- last_name? string - The person's last name.
- last_name_kana? string - The Kana variation of the person's last name (Japan only).
- last_name_kanji? string - The Kanji variation of the person's last name (Japan only).
- maiden_name? string - The person's maiden name.
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- nationality? string - The country where the person is a national. Two-letter country code (ISO 3166-1 alpha-2), or "XX" if unavailable.
- person_token? string - A person token, used to securely provide details to the person.
- phone? string - The person's phone number.
- political_exposure? string - Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
- registered_address? address_specs_1 -
- relationship? relationship_specs -
- ssn_last_4? string - The last four digits of the person's Social Security number (U.S. only).
- verification? person_verification_specs_1 -
stripe: account_persons_body
Closed record
Fields
- additional_tos_acceptances? person_additional_tos_acceptances_specs -
- address? legal_entity_and_kyc_address_specs_1 -
- address_kana? japan_address_kana_specs_1 -
- address_kanji? japan_address_kanji_specs_1 -
- documents? person_documents_specs -
- email? string - The person's email address.
- expand? account_persons_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- first_name? string - The person's first name.
- first_name_kana? string - The Kana variation of the person's first name (Japan only).
- first_name_kanji? string - The Kanji variation of the person's first name (Japan only).
- full_name_aliases? FullnamealiasesItemsString[]|"" - A list of alternate names or aliases that the person is known by.
- gender? string - The person's gender (International regulations require either "male" or "female").
- id_number? string - The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js.
- id_number_secondary? string - The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a PII token provided by Stripe.js.
- last_name? string - The person's last name.
- last_name_kana? string - The Kana variation of the person's last name (Japan only).
- last_name_kanji? string - The Kanji variation of the person's last name (Japan only).
- maiden_name? string - The person's maiden name.
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- nationality? string - The country where the person is a national. Two-letter country code (ISO 3166-1 alpha-2), or "XX" if unavailable.
- person_token? string - A person token, used to securely provide details to the person.
- phone? string - The person's phone number.
- political_exposure? string - Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
- registered_address? address_specs_1 -
- relationship? relationship_specs -
- ssn_last_4? string - The last four digits of the person's Social Security number (U.S. only).
- verification? person_verification_specs_1 -
stripe: account_refresh_body
Closed record
Fields
- expand? account_refresh_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- features ("balance"|"ownership"|"transactions")[] - The list of account features that you would like to refresh.
stripe: account_refresh_body_1
Closed record
Fields
- expand? account_refresh_body_1ExpandItemsString[] - Specifies which fields in the response should be expanded.
- features ("balance"|"ownership"|"transactions")[] - The list of account features that you would like to refresh.
stripe: account_reject_body
Closed record
Fields
- expand? account_reject_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- reason string - The reason for rejecting the account. Can be
fraud,terms_of_service, orother.
stripe: Account_requirements
Fields
- alternatives? Account_requirements_alternative[]? - Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
- current_deadline? int? - Date by which the fields in
currently_duemust be collected to keep the account enabled. These fields may disable the account sooner if the next threshold is reached before they are collected.
- currently_due? Account_requirementsCurrentlydueItemsString[]? - Fields that need to be collected to keep the account enabled. If not collected by
current_deadline, these fields appear inpast_dueas well, and the account is disabled.
- disabled_reason? string? - If the account is disabled, this string describes why. Learn more about handling verification issues. Can be
action_required.requested_capabilities,requirements.past_due,requirements.pending_verification,listed,platform_paused,rejected.fraud,rejected.incomplete_verification,rejected.listed,rejected.other,rejected.terms_of_service,under_review, orother.
- errors? Account_requirements_error[]? - Fields that are
currently_dueand need to be collected again because validation or verification failed.
- eventually_due? Account_requirementsEventuallydueItemsString[]? - Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in
currently_dueas well, andcurrent_deadlinebecomes set.
- past_due? Account_requirementsPastdueItemsString[]? - Fields that weren't collected by
current_deadline. These fields need to be collected to enable the account.
- pending_verification? Account_requirementsPendingverificationItemsString[]? - Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to
eventually_due,currently_due, orpast_due. Fields might appear ineventually_due,currently_due, orpast_dueand inpending_verificationif verification fails but another verification is still pending.
stripe: Account_requirements_alternative
Fields
- alternative_fields_due Account_requirements_alternativeAlternativefieldsdueItemsString[] - Fields that can be provided to satisfy all fields in
original_fields_due.
- original_fields_due Account_requirements_alternativeOriginalfieldsdueItemsString[] - Fields that are due and can be satisfied by providing all fields in
alternative_fields_due.
stripe: Account_requirements_error
Fields
- code "invalid_address_city_state_postal_code"|"invalid_address_highway_contract_box"|"invalid_address_private_mailbox"|"invalid_business_profile_name"|"invalid_business_profile_name_denylisted"|"invalid_company_name_denylisted"|"invalid_dob_age_over_maximum"|"invalid_dob_age_under_18"|"invalid_dob_age_under_minimum"|"invalid_product_description_length"|"invalid_product_description_url_match"|"invalid_representative_country"|"invalid_statement_descriptor_business_mismatch"|"invalid_statement_descriptor_denylisted"|"invalid_statement_descriptor_length"|"invalid_statement_descriptor_prefix_denylisted"|"invalid_statement_descriptor_prefix_mismatch"|"invalid_street_address"|"invalid_tax_id"|"invalid_tax_id_format"|"invalid_tos_acceptance"|"invalid_url_denylisted"|"invalid_url_format"|"invalid_url_web_presence_detected"|"invalid_url_website_business_information_mismatch"|"invalid_url_website_empty"|"invalid_url_website_inaccessible"|"invalid_url_website_inaccessible_geoblocked"|"invalid_url_website_inaccessible_password_protected"|"invalid_url_website_incomplete"|"invalid_url_website_incomplete_cancellation_policy"|"invalid_url_website_incomplete_customer_service_details"|"invalid_url_website_incomplete_legal_restrictions"|"invalid_url_website_incomplete_refund_policy"|"invalid_url_website_incomplete_return_policy"|"invalid_url_website_incomplete_terms_and_conditions"|"invalid_url_website_incomplete_under_construction"|"invalid_url_website_other"|"invalid_value_other"|"verification_directors_mismatch"|"verification_document_address_mismatch"|"verification_document_address_missing"|"verification_document_corrupt"|"verification_document_country_not_supported"|"verification_document_directors_mismatch"|"verification_document_dob_mismatch"|"verification_document_duplicate_type"|"verification_document_expired"|"verification_document_failed_copy"|"verification_document_failed_greyscale"|"verification_document_failed_other"|"verification_document_failed_test_mode"|"verification_document_fraudulent"|"verification_document_id_number_mismatch"|"verification_document_id_number_missing"|"verification_document_incomplete"|"verification_document_invalid"|"verification_document_issue_or_expiry_date_missing"|"verification_document_manipulated"|"verification_document_missing_back"|"verification_document_missing_front"|"verification_document_name_mismatch"|"verification_document_name_missing"|"verification_document_nationality_mismatch"|"verification_document_not_readable"|"verification_document_not_signed"|"verification_document_not_uploaded"|"verification_document_photo_mismatch"|"verification_document_too_large"|"verification_document_type_not_supported"|"verification_extraneous_directors"|"verification_failed_address_match"|"verification_failed_business_iec_number"|"verification_failed_document_match"|"verification_failed_id_number_match"|"verification_failed_keyed_identity"|"verification_failed_keyed_match"|"verification_failed_name_match"|"verification_failed_other"|"verification_failed_representative_authority"|"verification_failed_residential_address"|"verification_failed_tax_id_match"|"verification_failed_tax_id_not_issued"|"verification_missing_directors"|"verification_missing_executives"|"verification_missing_owners"|"verification_requires_additional_memorandum_of_associations"|"verification_requires_additional_proof_of_registration" - The code for the type of error.
- reason string - An informative message that indicates the error type and provides additional details about the error.
- requirement string - The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
stripe: Account_sepa_debit_payments_settings
Fields
- creditor_id? string - SEPA creditor identifier that identifies the company making the payment.
stripe: Account_session
An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded components.
We recommend that you create an AccountSession each time you need to display an embedded component to your user. Do not save AccountSessions to your database as they expire relatively quickly, and cannot be used more than once.
Related guide: Connect embedded components
Fields
- account string - The ID of the account the AccountSession was created for
- client_secret string - The client secret of this AccountSession. Used on the client to set up secure access to the given
account. The client secret can be used to provide access toaccountfrom your frontend. It should not be stored, logged, or exposed to anyone other than the connected account. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs to setup Connect embedded components and learn about howclient_secretshould be handled.
- components Connect_embedded_account_session_create_components -
- expires_at int - The timestamp at which this AccountSession will expire.
- livemode boolean - Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode.
- 'object "account_session" - String representing the object's type. Objects of the same type share the same value.
stripe: account_session_create_components_param
Each key of the dictionary represents an embedded component, and each embedded component maps to its configuration (e.g. whether it has been enabled or not).
Fields
- account_management? account_config_param -
- account_onboarding? account_config_param -
- balances? payouts_config_param -
- documents? base_config_param -
- payment_details? payments_config_param -
- payments? payments_config_param -
- payouts? payouts_config_param -
- payouts_list? base_config_param -
stripe: account_sessions_body
Closed record
Fields
- account string - The identifier of the account to create an Account Session for.
- components account_session_create_components_param -
- expand? account_sessions_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: Account_settings
Fields
- bacs_debit_payments? Account_bacs_debit_payments_settings -
- branding Account_branding_settings -
- card_issuing? Account_card_issuing_settings -
- card_payments Account_card_payments_settings -
- dashboard Account_dashboard_settings -
- invoices? Account_invoices_settings -
- payments Account_payments_settings -
- payouts? Account_payout_settings -
- sepa_debit_payments? Account_sepa_debit_payments_settings -
- treasury? Account_treasury_settings -
stripe: account_subscribe_body
Closed record
Fields
- expand? account_subscribe_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- features ("transactions")[] - The list of account features to which you would like to subscribe.
stripe: Account_terms_of_service
Fields
- date? int? - The Unix timestamp marking when the account representative accepted the service agreement.
- ip? string? - The IP address from which the account representative accepted the service agreement.
- user_agent? string - The user agent of the browser from which the account representative accepted the service agreement.
stripe: Account_tos_acceptance
Fields
- date? int? - The Unix timestamp marking when the account representative accepted their service agreement
- ip? string? - The IP address from which the account representative accepted their service agreement
- service_agreement? string - The user's service agreement type
- user_agent? string? - The user agent of the browser from which the account representative accepted their service agreement
stripe: Account_treasury_settings
Fields
- tos_acceptance? Account_terms_of_service -
stripe: Account_unification_account_controller
Fields
- is_controller? boolean -
trueif the Connect application retrieving the resource controls the account and can therefore exercise platform controls. Otherwise, this field is null.
- requirement_collection? "application"|"stripe" - A value indicating responsibility for collecting requirements on this account. Only returned when the Connect application retrieving the resource controls the account.
- stripe_dashboard? Account_unification_account_controller_stripe_dashboard -
- 'type "account"|"application" - The controller type. Can be
application, if a Connect application controls the account, oraccount, if the account controls itself.
stripe: Account_unification_account_controller_fees
Fields
- payer "account"|"application"|"application_custom"|"application_express" - A value indicating the responsible payer of a bundle of Stripe fees for pricing-control eligible products on this account. Learn more about fee behavior on connected accounts.
stripe: Account_unification_account_controller_losses
Fields
- payments "application"|"stripe" - A value indicating who is liable when this account can't pay back negative balances from payments.
stripe: Account_unification_account_controller_stripe_dashboard
Fields
- 'type "express"|"full"|"none" - A value indicating the Stripe dashboard this account has access to independent of the Connect application.
stripe: account_unsubscribe_body
Closed record
Fields
- expand? account_unsubscribe_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- features ("transactions")[] - The list of account features from which you would like to unsubscribe.
stripe: accountholder_params
Fields
- account? string -
- customer? string -
stripe: accountholder_params_1
The account holder to link accounts for.
Fields
- account? string -
- customer? string -
- 'type "account"|"customer" -
stripe: accountholder_params_2
Fields
- account? string -
- customer? string -
stripe: AccountList
Fields
- data Account[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: accounts_account_body
Closed record
Fields
- account_token? string - An account token, used to securely provide details to the account.
- business_profile? business_profile_specs -
- business_type? "company"|"government_entity"|"individual"|"non_profit" - The business type. Once you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is
application, which includes Custom accounts.
- capabilities? capabilities_param -
- company? company_specs -
- default_currency? string - Three-letter ISO currency code representing the default currency for the account. This must be a currency that Stripe supports in the account's country.
- documents? documents_specs -
- email? string - The email address of the account holder. This is only to make the account easier to identify to you. If controller.requirement_collection is
application, which includes Custom accounts, Stripe doesn't email the account without your consent.
- expand? accounts_account_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- external_account? string - A card or bank account to attach to the account for receiving payouts (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by Stripe.js, or a dictionary, as documented in the
external_accountparameter for bank account creation. <br><br>By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation APIs. After you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection isapplication, which includes Custom accounts.
- individual? individual_specs -
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- settings? settings_specs_update -
- tos_acceptance? tos_acceptance_specs -
stripe: accounts_body
Closed record
Fields
- account_token? string - An account token, used to securely provide details to the account.
- bank_account? record { account_holder_name string, account_holder_type "company"|"individual" , account_number string, account_type "checking"|"futsu"|"savings"|"toza" , country string, currency string, documents record { bank_account_ownership_verification record { files bank_account_ownership_verificationFilesItemsString[] } }, 'object "bank_account" , routing_number string }|string - Either a token, like the ones returned by Stripe.js, or a dictionary containing a user's bank account details.
- business_profile? business_profile_specs -
- business_type? "company"|"government_entity"|"individual"|"non_profit" - The business type. Once you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is
application, which includes Custom accounts.
- capabilities? capabilities_param -
- company? company_specs -
- controller? controller_specs -
- country? string - The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use
CAas the country for the account being created. Available countries include Stripe's global markets as well as countries where cross-border payouts are supported.
- default_currency? string - Three-letter ISO currency code representing the default currency for the account. This must be a currency that Stripe supports in the account's country.
- documents? documents_specs -
- email? string - The email address of the account holder. This is only to make the account easier to identify to you. If controller.requirement_collection is
application, which includes Custom accounts, Stripe doesn't email the account without your consent.
- expand? accounts_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- external_account? string - A card or bank account to attach to the account for receiving payouts (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by Stripe.js, or a dictionary, as documented in the
external_accountparameter for bank account creation. <br><br>By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation APIs. After you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection isapplication, which includes Custom accounts.
- individual? individual_specs -
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- settings? settings_specs -
- tos_acceptance? tos_acceptance_specs -
- 'type? "custom"|"express"|"standard" - The type of Stripe account to create. May be one of
custom,expressorstandard.
stripe: ach_tracking_details_params
Fields
- trace_id string -
stripe: add_invoice_item_entry
Fields
- discounts? discounts_data_param[] -
- price? string -
- price_data? one_time_price_data_with_negative_amounts -
- quantity? int -
- tax_rates? TaxratesItemsString[]|"" -
stripe: Address
Fields
- city? string? - City, district, suburb, town, or village.
- country? string? - Two-letter country code (ISO 3166-1 alpha-2).
- line1? string? - Address line 1 (e.g., street, PO Box, or company name).
- line2? string? - Address line 2 (e.g., apartment, suite, unit, or building).
- postal_code? string? - ZIP or postal code.
- state? string? - State, county, province, or region.
stripe: address
Fields
- city? string -
- country? string -
- line1 string -
- line2? string -
- postal_code? string -
- state? string -
stripe: address_specs
Fields
- city? string -
- country? string -
- line1? string -
- line2? string -
- postal_code? string -
- state? string -
stripe: address_specs_1
The person's registered address.
Fields
- city? string -
- country? string -
- line1? string -
- line2? string -
- postal_code? string -
- state? string -
stripe: address_validation_param
Fields
- mode "disabled"|"normalization_only"|"validation_and_normalization" -
stripe: adjustable_quantity_params
Fields
- enabled boolean -
- maximum? int -
- minimum? int -
stripe: after_completion_confirmation_page_params
Fields
- custom_message? string -
stripe: after_completion_hosted_confirmation_param
Fields
- custom_message? string -
stripe: after_completion_params
Behavior after the purchase is complete.
Fields
- hosted_confirmation? after_completion_confirmation_page_params -
- redirect? after_completion_redirect_params -
- 'type "hosted_confirmation"|"redirect" -
stripe: after_completion_redirect_param
Fields
- return_url string -
stripe: after_completion_redirect_params
Fields
- url string -
stripe: after_expiration_params
Configure actions after a Checkout Session has expired.
Fields
- recovery? recovery_params -
stripe: aggregation_settings_param
The default settings to aggregate a meter's events with.
Fields
- formula "count"|"sum" -
stripe: all_people_relationship_specs
Fields
- director? boolean -
- executive? boolean -
- legal_guardian? boolean -
- owner? boolean -
- representative? boolean -
stripe: all_people_relationship_specs_1
Fields
- director? boolean -
- executive? boolean -
- legal_guardian? boolean -
- owner? boolean -
- representative? boolean -
stripe: all_prices_recurring_params
Fields
- interval? "day"|"month"|"week"|"year" -
- meter? string -
- usage_type? "licensed"|"metered" -
stripe: amount_details_specs
Detailed breakdown of amount components. These amounts are denominated in currency and in the smallest currency unit.
Fields
- atm_fee? int -
- cashback_amount? int -
stripe: annual_revenue_specs
Fields
- amount int -
- currency string -
- fiscal_year_end string -
stripe: Api_errors
Fields
- charge? string - For card errors, the ID of the failed charge.
- code? string - For some errors that could be handled programmatically, a short string indicating the error code reported.
- decline_code? string - For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.
- doc_url? string - A URL to more information about the error code reported.
- message? string - A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
- param? string - If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
- payment_intent? Payment_intent -
- payment_method? Payment_method -
- payment_method_type? string - If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
- request_log_url? string - A URL to the request log entry in your dashboard.
- setup_intent? Setup_intent -
- 'source? Bank_account|Card|Source - The source object for errors returned on a request involving a source.
- 'type "api_error"|"card_error"|"idempotency_error"|"invalid_request_error" - The type of error returned. One of
api_error,card_error,idempotency_error, orinvalid_request_error
stripe: APIMethodRefundList
Fields
- data Refund[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: ApmsSourcesSourceList
Fields
- data (Bank_account|Card|Source)[] - Details about each object.
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: ApmsSourcesSourceList_1
The customer's payment sources, if any.
Fields
- data (Bank_account|Card|Source)[] - Details about each object.
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: ApmsSourcesSourceTransactionList
Fields
- data Source_transaction[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: Apple_pay_domain
Fields
- created int - Time at which the object was created. Measured in seconds since the Unix epoch.
- domain_name string -
- id string - Unique identifier for the object.
- livemode boolean - Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode.
- 'object "apple_pay_domain" - String representing the object's type. Objects of the same type share the same value.
stripe: apple_pay_domains_body
Closed record
Fields
- domain_name string -
- expand? apple_pay_domains_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: ApplePayDomainList
Fields
- data Apple_pay_domain[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: Application
Fields
- id string - Unique identifier for the object.
- name? string? - The name of the application.
- 'object "application" - String representing the object's type. Objects of the same type share the same value.
stripe: Application_fee
Fields
- amount int - Amount earned, in cents (or local equivalent).
- amount_refunded int - Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the fee if a partial refund was issued)
- application string|Application - ID of the Connect application that earned the fee.
- balance_transaction? string|Balance_transaction? - Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds).
- created int - Time at which the object was created. Measured in seconds since the Unix epoch.
- currency string - Three-letter ISO currency code, in lowercase. Must be a supported currency.
- fee_source? Platform_earning_fee_source? - Polymorphic source of the application fee. Includes the ID of the object the application fee was created from.
- id string - Unique identifier for the object.
- livemode boolean - Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode.
- 'object "application_fee" - String representing the object's type. Objects of the same type share the same value.
- refunded boolean - Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false.
- refunds FeeRefundList_1 -
stripe: applies_to_params
A hash containing directions for what this Coupon will apply discounts to.
Fields
- products? applies_to_paramsProductsItemsString[] -
stripe: Apps\.secret
Fields
- created int -
- deleted? boolean -
- expires_at? int? -
- id string -
- livemode boolean -
- name string -
- 'object "apps.secret" -
- payload? string? -
- scope Secret_service_resource_scope -
stripe: apps_secrets_body
Closed record
Fields
- expand? apps_secrets_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- expires_at? int - The Unix timestamp for the expiry time of the secret, after which the secret deletes.
- name string - A name for the secret that's unique within the scope.
- payload string - The plaintext secret value to be stored.
- scope scope_param_1 -
stripe: authentication_exemption_specs
Fields
- claimed_by "acquirer"|"issuer" -
- 'type "low_value_transaction"|"transaction_risk_analysis"|"unknown" -
stripe: authorization_approve_body
Closed record
Fields
- expand? authorization_approve_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
stripe: authorization_capture_body
Closed record
Fields
- capture_amount? int - The amount to capture from the authorization. If not provided, the full amount of the authorization will be captured. This amount is in the authorization currency and in the smallest currency unit.
- expand? authorization_capture_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- purchase_details? purchase_details_specs -
stripe: authorization_controls_param
Rules that control spending for this card. Refer to our documentation for more details.
Fields
- allowed_categories? (authorization_controls_paramAllowedcategoriesItemsString)[] -
- allowed_merchant_countries? authorization_controls_paramAllowedmerchantcountriesItemsString[] -
- blocked_categories? (authorization_controls_paramBlockedcategoriesItemsString)[] -
- blocked_merchant_countries? authorization_controls_paramBlockedmerchantcountriesItemsString[] -
- spending_limits? spending_limits_param[] -
stripe: authorization_controls_param_v2
Rules that control spending across this cardholder's cards. Refer to our documentation for more details.
Fields
- allowed_categories? (authorization_controls_param_v2AllowedcategoriesItemsString)[] -
- allowed_merchant_countries? authorization_controls_param_v2AllowedmerchantcountriesItemsString[] -
- blocked_categories? (authorization_controls_param_v2BlockedcategoriesItemsString)[] -
- blocked_merchant_countries? authorization_controls_param_v2BlockedmerchantcountriesItemsString[] -
- spending_limits? spending_limits_param[] -
- spending_limits_currency? string -
stripe: authorization_decline_body
Closed record
Fields
- expand? authorization_decline_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
stripe: authorization_expire_body
Closed record
Fields
- expand? authorization_expire_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: authorization_finalize_amount_body
Closed record
Fields
- expand? authorization_finalize_amount_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- final_amount int - The final authorization amount that will be captured by the merchant. This amount is in the authorization currency and in the smallest currency unit.
- fleet? fleet_specs -
- fuel? fuel_specs -
stripe: authorization_increment_body
Closed record
Fields
- expand? authorization_increment_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- increment_amount int - The amount to increment the authorization by. This amount is in the authorization currency and in the smallest currency unit.
stripe: authorization_reverse_body
Closed record
Fields
- expand? authorization_reverse_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- reverse_amount? int - The amount to reverse from the authorization. If not provided, the full amount of the authorization will be reversed. This amount is in the authorization currency and in the smallest currency unit.
stripe: authorizations_authorization_body
Closed record
Fields
- expand? authorizations_authorization_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
stripe: automatic_payment_methods_param
When you enable this parameter, this PaymentIntent accepts payment methods that you enable in the Dashboard and that are compatible with this PaymentIntent's other parameters.
Fields
- allow_redirects? "always"|"never" -
- enabled boolean -
stripe: automatic_payment_methods_param_1
When you enable this parameter, this SetupIntent accepts payment methods that you enable in the Dashboard and that are compatible with its other parameters.
Fields
- allow_redirects? "always"|"never" -
- enabled boolean -
stripe: Automatic_tax
Fields
- liability? Connect_account_reference? - The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
- status? "complete"|"failed"|"requires_location_inputs"? - The status of the most recent automated tax calculation for this invoice.
stripe: automatic_tax_config
Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
Fields
- enabled boolean -
- liability? param -
stripe: automatic_tax_config_1
Fields
- enabled boolean -
- liability? param -
stripe: automatic_tax_config_2
Fields
- enabled boolean -
- liability? param_2 -
stripe: automatic_tax_config_3
Fields
- enabled boolean -
- liability? param_3 -
stripe: automatic_tax_config_4
Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
Fields
- enabled boolean -
- liability? param_3 -
stripe: automatic_tax_filter_params
Fields
- enabled boolean -
stripe: automatic_tax_param
Settings for automatic tax lookup for this invoice.
Fields
- enabled boolean -
- liability? param -
stripe: automatic_tax_param_1
Settings for automatic tax lookup for this invoice preview.
Fields
- enabled boolean -
- liability? param -
stripe: automatic_tax_param_2
Fields
- enabled boolean -
- liability? param -
stripe: automatic_tax_param_3
Fields
- enabled boolean -
- liability? param_2 -
stripe: automatic_tax_param_4
Settings for automatic tax lookup for this invoice.
Fields
- enabled boolean -
- liability? param_3 -
stripe: automatic_tax_param_5
Settings for automatic tax lookup for this quote and resulting invoices and subscriptions.
Fields
- enabled boolean -
- liability? param_3 -
stripe: automatic_tax_params
Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
Fields
- enabled boolean -
- liability? param -
stripe: automatic_tax_params_1
Configuration for automatic tax collection.
Fields
- enabled boolean -
- liability? param_3 -
stripe: bacs_debit_payments_specs
Fields
- display_name? string -
stripe: Balance
This is an object representing your Stripe balance. You can retrieve it to see the balance currently on your Stripe account.
You can also retrieve the balance history, which contains a list of transactions that contributed to the balance (charges, payouts, and so forth).
The available and pending amounts for each currency are broken down further by payment source types.
Related guide: Understanding Connect account balances
Fields
- available Balance_amount[] - Available funds that you can transfer or pay out automatically by Stripe or explicitly through the Transfers API or Payouts API. You can find the available balance for each currency and payment type in the
source_typesproperty.
- connect_reserved? Balance_amount[] - Funds held due to negative balances on connected accounts where account.controller.requirement_collection is
application, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in thesource_typesproperty.
- instant_available? Balance_amount_net[] - Funds that you can pay out using Instant Payouts.
- issuing? Balance_detail -
- livemode boolean - Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode.
- 'object "balance" - String representing the object's type. Objects of the same type share the same value.
- pending Balance_amount[] - Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the
source_typesproperty.
stripe: Balance_amount
Fields
- amount int - Balance amount.
- currency string - Three-letter ISO currency code, in lowercase. Must be a supported currency.
- source_types? Balance_amount_by_source_type -
stripe: Balance_amount_by_source_type
Fields
- bank_account? int - Amount for bank account.
- card? int - Amount for card.
- fpx? int - Amount for FPX.
stripe: Balance_amount_net
Fields
- amount int - Balance amount.
- currency string - Three-letter ISO currency code, in lowercase. Must be a supported currency.
- net_available? Balance_net_available[] - Breakdown of balance by destination.
- source_types? Balance_amount_by_source_type -
stripe: Balance_detail
Fields
- available Balance_amount[] - Funds that are available for use.
stripe: Balance_net_available
Fields
- amount int - Net balance amount, subtracting fees from platform-set pricing.
- destination string - ID of the external account for this net balance (not expandable).
- source_types? Balance_amount_by_source_type -
stripe: balance_settings_param
Fields
- reconciliation_mode? "automatic"|"manual"|"merchant_default" -
stripe: balance_settings_param_1
A hash of settings for this cash balance.
Fields
- reconciliation_mode? "automatic"|"manual"|"merchant_default" -
stripe: Balance_transaction
Balance transactions represent funds moving through your Stripe account. Stripe creates them for every type of transaction that enters or leaves your Stripe account balance.
Related guide: Balance transaction types
Fields
- amount int - Gross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party.
- available_on int - The date that the transaction's net funds become available in the Stripe balance.
- created int - Time at which the object was created. Measured in seconds since the Unix epoch.
- currency string - Three-letter ISO currency code, in lowercase. Must be a supported currency.
- description? string? - An arbitrary string attached to the object. Often useful for displaying to users.
- exchange_rate? decimal? - If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the
amountin currency A, multipled by theexchange_rate, equals theamountin currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent'samountis1000andcurrencyiseur. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction'samountis1234, itscurrencyisusd, and theexchange_rateis1.234.
- fee int - Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed.
- fee_details Fee[] - Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction.
- id string - Unique identifier for the object.
- net int - Net impact to a Stripe balance (in cents (or local equivalent)). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by
amount-fee
- 'object "balance_transaction" - String representing the object's type. Objects of the same type share the same value.
- reporting_category string - Learn more about how reporting categories can help you understand balance transactions from an accounting perspective.
- 'source? string|Application_fee|Charge|Connect_collection_transfer|Customer_cash_balance_transaction|Dispute|Fee_refund|Issuing\.authorization|Issuing\.dispute|Issuing\.transaction|Payout|Refund|Reserve_transaction|Tax_deducted_at_source|Topup|Transfer|Transfer_reversal? - This transaction relates to the Stripe object.
- status string - The transaction's net funds status in the Stripe balance, which are either
availableorpending.
- 'type "adjustment"|"advance"|"advance_funding"|"anticipation_repayment"|"application_fee"|"application_fee_refund"|"charge"|"climate_order_purchase"|"climate_order_refund"|"connect_collection_transfer"|"contribution"|"issuing_authorization_hold"|"issuing_authorization_release"|"issuing_dispute"|"issuing_transaction"|"obligation_outbound"|"obligation_reversal_inbound"|"payment"|"payment_failure_refund"|"payment_network_reserve_hold"|"payment_network_reserve_release"|"payment_refund"|"payment_reversal"|"payment_unreconciled"|"payout"|"payout_cancel"|"payout_failure"|"refund"|"refund_failure"|"reserve_transaction"|"reserved_funds"|"stripe_fee"|"stripe_fx_fee"|"tax_fee"|"topup"|"topup_reversal"|"transfer"|"transfer_cancel"|"transfer_failure"|"transfer_refund" - Transaction type:
adjustment,advance,advance_funding,anticipation_repayment,application_fee,application_fee_refund,charge,climate_order_purchase,climate_order_refund,connect_collection_transfer,contribution,issuing_authorization_hold,issuing_authorization_release,issuing_dispute,issuing_transaction,obligation_outbound,obligation_reversal_inbound,payment,payment_failure_refund,payment_network_reserve_hold,payment_network_reserve_release,payment_refund,payment_reversal,payment_unreconciled,payout,payout_cancel,payout_failure,refund,refund_failure,reserve_transaction,reserved_funds,stripe_fee,stripe_fx_fee,tax_fee,topup,topup_reversal,transfer,transfer_cancel,transfer_failure, ortransfer_refund. Learn more about balance transaction types and what they represent. To classify transactions for accounting purposes, considerreporting_categoryinstead.
stripe: balance_transactions_transaction_body
Closed record
Fields
- description? string - An arbitrary string attached to the object. Often useful for displaying to users.
- expand? balance_transactions_transaction_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
stripe: BalanceTransactionsList
Fields
- data Balance_transaction[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: Bank_account
These bank accounts are payment methods on Customer objects.
On the other hand External Accounts are transfer
destinations on Account objects for connected accounts.
They can be bank accounts or debit cards as well, and are documented in the links above.
Related guide: Bank debits and transfers
Fields
- account_holder_name? string? - The name of the person or business that owns the bank account.
- account_holder_type? string? - The type of entity that holds the account. This can be either
individualorcompany.
- account_type? string? - The bank account type. This can only be
checkingorsavingsin most countries. In Japan, this can only befutsuortoza.
- available_payout_methods? ("instant"|"standard")[]? - A set of available payout methods for this bank account. Only values from this set should be passed as the
methodwhen creating a payout.
- bank_name? string? - Name of the bank associated with the routing number (e.g.,
WELLS FARGO).
- country string - Two-letter ISO code representing the country the bank account is located in.
- currency string - Three-letter ISO code for the currency paid out to the bank account.
- customer? string|Customer|Deleted_customer? - The ID of the customer that the bank account is associated with.
- default_for_currency? boolean? - Whether this bank account is the default external account for its currency.
- fingerprint? string? - Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
- future_requirements? External_account_requirements? - Information about the upcoming new requirements for the bank account, including what information needs to be collected, and by when.
- id string - Unique identifier for the object.
- last4 string - The last four digits of the bank account number.
- metadata? record { string... }? - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- 'object "bank_account" - String representing the object's type. Objects of the same type share the same value.
- requirements? External_account_requirements? - Information about the requirements for the bank account, including what information needs to be collected.
- routing_number? string? - The routing transit number for the bank account.
- status string - For bank accounts, possible values are
new,validated,verified,verification_failed, orerrored. A bank account that hasn't had any activity or validation performed isnew. If Stripe can determine that the bank account exists, its status will bevalidated. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will beverified. If the verification failed for any reason, such as microdeposit failure, the status will beverification_failed. If a payout sent to this bank account fails, we'll set the status toerroredand will not continue to send scheduled payouts until the bank details are updated. For external accounts, possible values arenew,erroredandverification_failed. If a payout fails, the status is set toerroredand scheduled payouts are stopped until account details are updated. In the US and India, if we can't verify the owner of the bank account, we'll set the status toverification_failed. Other validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply.
stripe: bank_accounts_id_body
Closed record
Fields
- account_holder_name? string - The name of the person or business that owns the bank account.
- account_holder_type? ""|"company"|"individual" - The type of entity that holds the account. This can be either
individualorcompany.
- account_type? "checking"|"futsu"|"savings"|"toza" - The bank account type. This can only be
checkingorsavingsin most countries. In Japan, this can only befutsuortoza.
- address_city? string - City/District/Suburb/Town/Village.
- address_country? string - Billing address country, if provided when creating card.
- address_line1? string - Address line 1 (Street address/PO Box/Company name).
- address_line2? string - Address line 2 (Apartment/Suite/Unit/Building).
- address_state? string - State/County/Province/Region.
- address_zip? string - ZIP or postal code.
- default_for_currency? boolean - When set to true, this becomes the default external account for its currency.
- documents? external_account_documents_param -
- exp_month? string - Two digit number representing the card’s expiration month.
- exp_year? string - Four digit number representing the card’s expiration year.
- expand? bank_accounts_id_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- name? string - Cardholder name.
stripe: bank_accounts_id_body_1
Closed record
Fields
- account_holder_name? string - The name of the person or business that owns the bank account.
- account_holder_type? "company"|"individual" - The type of entity that holds the account. This can be either
individualorcompany.
- address_city? string - City/District/Suburb/Town/Village.
- address_country? string - Billing address country, if provided when creating card.
- address_line1? string - Address line 1 (Street address/PO Box/Company name).
- address_line2? string - Address line 2 (Apartment/Suite/Unit/Building).
- address_state? string - State/County/Province/Region.
- address_zip? string - ZIP or postal code.
- exp_month? string - Two digit number representing the card’s expiration month.
- exp_year? string - Four digit number representing the card’s expiration year.
- expand? bank_accounts_id_body_1ExpandItemsString[] - Specifies which fields in the response should be expanded.
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- name? string - Cardholder name.
- owner? owner -
stripe: bank_accounts_id_body_2
Closed record
Fields
- expand? bank_accounts_id_body_2ExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: Bank_connections_resource_accountholder
Fields
- 'type "account"|"customer" - Type of account holder that this account belongs to.
stripe: Bank_connections_resource_balance
Fields
- as_of int - The time that the external institution calculated this balance. Measured in seconds since the Unix epoch.
- current record { int... } - The balances owed to (or by) the account holder. Each key is a three-letter ISO currency code, in lowercase. Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.
- 'type "cash"|"credit" - The
typeof the balance. An additional hash is included on the balance with a name matching this value.
stripe: Bank_connections_resource_balance_api_resource_cash_balance
Fields
- available? record { int... }? - The funds available to the account holder. Typically this is the current balance less any holds. Each key is a three-letter ISO currency code, in lowercase. Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.
stripe: Bank_connections_resource_balance_api_resource_credit_balance
Fields
- used? record { int... }? - The credit that has been used by the account holder. Each key is a three-letter ISO currency code, in lowercase. Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.
stripe: Bank_connections_resource_balance_refresh
Fields
- last_attempted_at int - The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.
- next_refresh_available_at? int? - Time at which the next balance refresh can be initiated. This value will be
nullwhenstatusispending. Measured in seconds since the Unix epoch.
- status "failed"|"pending"|"succeeded" - The status of the last refresh attempt.
stripe: Bank_connections_resource_link_account_session_filters
Fields
- account_subcategories? ("checking"|"credit_card"|"line_of_credit"|"mortgage"|"savings")[]? - Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are:
checking,savings,mortgage,line_of_credit,credit_card.
- countries? Bank_connections_resource_link_account_session_filtersCountriesItemsString[]? - List of countries from which to filter accounts.
stripe: Bank_connections_resource_ownership_refresh
Fields
- last_attempted_at int - The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.
- next_refresh_available_at? int? - Time at which the next ownership refresh can be initiated. This value will be
nullwhenstatusispending. Measured in seconds since the Unix epoch.
- status "failed"|"pending"|"succeeded" - The status of the last refresh attempt.
stripe: Bank_connections_resource_transaction_refresh
Fields
- id string - Unique identifier for the object.
- last_attempted_at int - The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.
- next_refresh_available_at? int? - Time at which the next transaction refresh can be initiated. This value will be
nullwhenstatusispending. Measured in seconds since the Unix epoch.
- status "failed"|"pending"|"succeeded" - The status of the last refresh attempt.
stripe: Bank_connections_resource_transaction_resource_status_transitions
Fields
- posted_at? int? - Time at which this transaction posted. Measured in seconds since the Unix epoch.
- void_at? int? - Time at which this transaction was voided. Measured in seconds since the Unix epoch.
stripe: bank_transfer_param
Fields
- eu_bank_transfer? eu_bank_transfer_params -
- requested_address_types? ("aba"|"iban"|"sepa"|"sort_code"|"spei"|"swift"|"zengin")[] -
- 'type "eu_bank_transfer"|"gb_bank_transfer"|"jp_bank_transfer"|"mx_bank_transfer"|"us_bank_transfer" -
stripe: bank_transfer_params
Additional parameters for bank_transfer funding types
Fields
- eu_bank_transfer? eu_bank_account_params -
- requested_address_types? ("iban"|"sort_code"|"spei"|"zengin")[] -
- 'type "eu_bank_transfer"|"gb_bank_transfer"|"jp_bank_transfer"|"mx_bank_transfer"|"us_bank_transfer" -
stripe: BankAccountList
Fields
- data Bank_account[] - Details about each object.
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: BankConnectionsResourceLinkedAccountList
Fields
- data Financial_connections\.account[] - Details about each object.
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: BankConnectionsResourceLinkedAccountList_1
The accounts that were collected as part of this Session.
Fields
- data Financial_connections\.account[] - Details about each object.
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: BankConnectionsResourceOwnerList
Fields
- data Financial_connections\.account_owner[] - Details about each object.
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: BankConnectionsResourceOwnerList_1
A paginated list of owners for this account.
Fields
- data Financial_connections\.account_owner[] - Details about each object.
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: BankConnectionsResourceTransactionList
Fields
- data Financial_connections\.transaction[] - Details about each object.
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: base_config_param
Fields
- enabled boolean -
- features? record {} -
stripe: bbpos_wise_pose
An object containing device type specific settings for BBPOS WisePOS E readers
Fields
- splashscreen? string|"" -
stripe: beneficiary_params
Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set.
Fields
- public_name string -
stripe: Billing\.meter
Fields
- created int -
- customer_mapping Billing_meter_resource_customer_mapping_settings -
- default_aggregation Billing_meter_resource_aggregation_settings -
- display_name string -
- event_name string -
- event_time_window? "day"|"hour"? -
- id string -
- livemode boolean -
- 'object "billing.meter" -
- status "active"|"inactive" -
- status_transitions Billing_meter_resource_billing_meter_status_transitions -
- updated int -
- value_settings Billing_meter_resource_billing_meter_value -
stripe: Billing\.meter_event
Fields
- created int -
- event_name string -
- identifier string -
- livemode boolean -
- 'object "billing.meter_event" -
- payload record { string... } -
- timestamp int -
stripe: Billing\.meter_event_adjustment
Fields
- event_name string -
- livemode boolean -
- 'object "billing.meter_event_adjustment" -
- status "complete"|"pending" -
- 'type "cancel" -
stripe: Billing\.meter_event_summary
Fields
- aggregated_value decimal -
- end_time int -
- id string -
- livemode boolean -
- meter string -
- 'object "billing.meter_event_summary" -
- start_time int -
stripe: billing_cycle_anchor_config_param
Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals. When provided, the billing_cycle_anchor is set to the next occurence of the day_of_month at the hour, minute, and second UTC.
Fields
- day_of_month int -
- hour? int -
- minute? int -
- month? int -
- second? int -
stripe: Billing_details
Fields
- address? Address? - Billing address.
- email? string? - Email address.
- name? string? - Full name.
- phone? string? - Billing phone number (including extension).
stripe: billing_details_inner_params
Fields
- email? string|"" -
- name? string|"" -
- phone? string|"" -
stripe: billing_details_inner_params_1
Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
Fields
- email? string|"" -
- name? string|"" -
- phone? string|"" -
stripe: billing_meter_event_adjustments_body
Closed record
Fields
- cancel? event_adjustment_cancel_settings_param -
- event_name string - The name of the meter event. Corresponds with the
event_namefield on a meter.
- expand? billing_meter_event_adjustments_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'type "cancel" - Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.
stripe: billing_meter_events_body
Closed record
Fields
- event_name string - The name of the meter event. Corresponds with the
event_namefield on a meter.
- expand? billing_meter_events_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- identifier? string - A unique identifier for the event. If not provided, one will be generated. We recommend using a globally unique identifier for this. We'll enforce uniqueness within a rolling 24 hour period.
- timestamp? int - The time of the event. Measured in seconds since the Unix epoch. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to current timestamp if not specified.
stripe: Billing_meter_resource_aggregation_settings
Fields
- formula "count"|"sum" - Specifies how events are aggregated.
stripe: Billing_meter_resource_billing_meter_event_adjustment_cancel
Fields
- identifier? string? - Unique identifier for the event.
stripe: Billing_meter_resource_billing_meter_status_transitions
Fields
- deactivated_at? int? - The time the meter was deactivated, if any. Measured in seconds since Unix epoch.
stripe: Billing_meter_resource_billing_meter_value
Fields
- event_payload_key string - The key in the meter event payload to use as the value for this meter.
stripe: Billing_meter_resource_customer_mapping_settings
Fields
- event_payload_key string - The key in the meter event payload to use for mapping the event to a customer.
- 'type "by_id" - The method for mapping a meter event to a customer.
stripe: billing_meters_body
Closed record
Fields
- customer_mapping? customer_mapping_param -
- default_aggregation aggregation_settings_param -
- display_name string - The meter's name.
- event_name string - The name of the meter event to record usage for. Corresponds with the
event_namefield on meter events.
- event_time_window? "day"|"hour" - The time window to pre-aggregate meter events for, if any.
- expand? billing_meters_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- value_settings? meter_value_settings_param -
stripe: Billing_portal\.configuration
Fields
- active boolean -
- application? string|Application|Deleted_application? -
- business_profile Portal_business_profile -
- created int -
- default_return_url? string? -
- features Portal_features -
- id string -
- is_default boolean -
- livemode boolean -
- login_page Portal_login_page -
- metadata? record { string... }? -
- 'object "billing_portal.configuration" -
- updated int -
stripe: Billing_portal\.session
Fields
- configuration string|Billing_portal\.configuration -
- created int -
- customer string -
- flow? Portal_flows_flow? -
- id string -
- livemode boolean -
- locale? "auto"|"bg"|"cs"|"da"|"de"|"el"|"en"|"en-AU"|"en-CA"|"en-GB"|"en-IE"|"en-IN"|"en-NZ"|"en-SG"|"es"|"es-419"|"et"|"fi"|"fil"|"fr"|"fr-CA"|"hr"|"hu"|"id"|"it"|"ja"|"ko"|"lt"|"lv"|"ms"|"mt"|"nb"|"nl"|"pl"|"pt"|"pt-BR"|"ro"|"ru"|"sk"|"sl"|"sv"|"th"|"tr"|"vi"|"zh"|"zh-HK"|"zh-TW"? -
- 'object "billing_portal.session" -
- on_behalf_of? string? -
- return_url? string? -
- url string -
stripe: billing_portal_configurations_body
Closed record
Fields
- business_profile business_profile_create_param -
- expand? billing_portal_configurations_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- features features_creation_param -
- login_page? login_page_create_param -
- metadata? record { string... } - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
stripe: billing_portal_sessions_body
Closed record
Fields
- configuration? string - The ID of an existing configuration to use for this session, describing its functionality and features. If not specified, the session uses the default configuration.
- customer string - The ID of an existing customer.
- expand? billing_portal_sessions_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- flow_data? flow_data_param -
- locale? "auto"|"bg"|"cs"|"da"|"de"|"el"|"en"|"en-AU"|"en-CA"|"en-GB"|"en-IE"|"en-IN"|"en-NZ"|"en-SG"|"es"|"es-419"|"et"|"fi"|"fil"|"fr"|"fr-CA"|"hr"|"hu"|"id"|"it"|"ja"|"ko"|"lt"|"lv"|"ms"|"mt"|"nb"|"nl"|"pl"|"pt"|"pt-BR"|"ro"|"ru"|"sk"|"sl"|"sv"|"th"|"tr"|"vi"|"zh"|"zh-HK"|"zh-TW" - The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer’s
preferred_localesor browser’s locale is used.
- on_behalf_of? string - The
on_behalf_ofaccount to use for this session. When specified, only subscriptions and invoices with thison_behalf_ofaccount appear in the portal. For more information, see the docs. Use the Accounts API to modify theon_behalf_ofaccount's branding settings, which the portal displays.
- return_url? string - The default URL to redirect customers to when they click on the portal's link to return to your website.
stripe: billing_specs
The cardholder's billing address.
Fields
- address required_address -
stripe: BillingClocksResourceBillingClockList
Fields
- data Test_helpers\.test_clock[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: BillingMeterResourceBillingMeterEventSummaryList
Fields
- data Billing\.meter_event_summary[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: BillingMeterResourceBillingMeterList
Fields
- data Billing\.meter[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: branding_settings_specs
Fields
- icon? string -
- logo? string -
- primary_color? string -
- secondary_color? string -
stripe: business_profile_create_param
The business information shown to customers in the portal.
Fields
- headline? string|"" -
- privacy_policy_url? string -
- terms_of_service_url? string -
stripe: business_profile_specs
Business information about the account.
Fields
- annual_revenue? annual_revenue_specs -
- estimated_worker_count? int -
- mcc? string -
- monthly_estimated_revenue? monthly_estimated_revenue_specs -
- name? string -
- product_description? string -
- support_address? address_specs -
- support_email? string -
- support_phone? string -
- support_url? string|"" -
- url? string -
stripe: business_profile_update_param
The business information shown to customers in the portal.
Fields
- headline? string|"" -
- privacy_policy_url? string|"" -
- terms_of_service_url? string|"" -
stripe: buy_button_param
Fields
- enabled boolean -
stripe: calculation_line_item
Fields
- amount int -
- product? string -
- quantity? int -
- reference? string -
- tax_behavior? "exclusive"|"inclusive" -
- tax_code? string -
stripe: canada
Fields
- province_standard? province_standard -
- 'type "province_standard"|"simplified"|"standard" -
stripe: Cancellation_details
Fields
- comment? string? - Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
- feedback? "customer_service"|"low_quality"|"missing_features"|"other"|"switched_service"|"too_complex"|"too_expensive"|"unused"? - The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
- reason? "cancellation_requested"|"payment_disputed"|"payment_failed"? - Why this subscription was canceled.
stripe: cancellation_details_param
Details about why this subscription was cancelled
Fields
- comment? string|"" -
- feedback? ""|"customer_service"|"low_quality"|"missing_features"|"other"|"switched_service"|"too_complex"|"too_expensive"|"unused" -
stripe: capabilities_capability_body
Closed record
Fields
- expand? capabilities_capability_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- requested? boolean - To request a new capability for an account, pass true. There can be a delay before the requested capability becomes active. If the capability has any activation requirements, the response includes them in the
requirementsarrays. If a capability isn't permanent, you can remove it from the account by passing false. Some capabilities are permanent after they've been requested. Attempting to remove a permanent capability returns an error.
stripe: capabilities_param
Each key of the dictionary represents a capability, and each capability maps to its settings (for example, whether it has been requested or not). Each capability is inactive until you have provided its specific requirements and Stripe has verified them. An account might have some of its requested capabilities be active and some be inactive.
Required when account.controller.stripe_dashboard.type
is none, which includes Custom accounts.
Fields
- acss_debit_payments? capability_param -
- affirm_payments? capability_param -
- afterpay_clearpay_payments? capability_param -
- amazon_pay_payments? capability_param -
- au_becs_debit_payments? capability_param -
- bacs_debit_payments? capability_param -
- bancontact_payments? capability_param -
- bank_transfer_payments? capability_param -
- blik_payments? capability_param -
- boleto_payments? capability_param -
- card_issuing? capability_param -
- card_payments? capability_param -
- cartes_bancaires_payments? capability_param -
- cashapp_payments? capability_param -
- eps_payments? capability_param -
- fpx_payments? capability_param -
- gb_bank_transfer_payments? capability_param -
- giropay_payments? capability_param -
- grabpay_payments? capability_param -
- ideal_payments? capability_param -
- india_international_payments? capability_param -
- jcb_payments? capability_param -
- jp_bank_transfer_payments? capability_param -
- klarna_payments? capability_param -
- konbini_payments? capability_param -
- legacy_payments? capability_param -
- link_payments? capability_param -
- mobilepay_payments? capability_param -
- multibanco_payments? capability_param -
- mx_bank_transfer_payments? capability_param -
- oxxo_payments? capability_param -
- p24_payments? capability_param -
- paynow_payments? capability_param -
- promptpay_payments? capability_param -
- revolut_pay_payments? capability_param -
- sepa_bank_transfer_payments? capability_param -
- sepa_debit_payments? capability_param -
- sofort_payments? capability_param -
- swish_payments? capability_param -
- tax_reporting_us_1099_k? capability_param -
- tax_reporting_us_1099_misc? capability_param -
- transfers? capability_param -
- treasury? capability_param -
- twint_payments? capability_param -
- us_bank_account_ach_payments? capability_param -
- us_bank_transfer_payments? capability_param -
- zip_payments? capability_param -
stripe: Capability
This is an object representing a capability for a Stripe account.
Related guide: Account capabilities
Fields
- future_requirements? Account_capability_future_requirements -
- id string - The identifier for the capability.
- 'object "capability" - String representing the object's type. Objects of the same type share the same value.
- requested boolean - Whether the capability has been requested.
- requested_at? int? - Time at which the capability was requested. Measured in seconds since the Unix epoch.
- requirements? Account_capability_requirements -
- status "active"|"disabled"|"inactive"|"pending"|"unrequested" - The status of the capability. Can be
active,inactive,pending, orunrequested.
stripe: capability_param
Fields
- requested? boolean -
stripe: Card
You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later.
Related guide: Card payments with Sources
Fields
- account? string|Account? - The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead. This property is only available for accounts where controller.requirement_collection is
application, which includes Custom accounts.
- address_city? string? - City/District/Suburb/Town/Village.
- address_country? string? - Billing address country, if provided when creating card.
- address_line1? string? - Address line 1 (Street address/PO Box/Company name).
- address_line1_check? string? - If
address_line1was provided, results of the check:pass,fail,unavailable, orunchecked.
- address_line2? string? - Address line 2 (Apartment/Suite/Unit/Building).
- address_state? string? - State/County/Province/Region.
- address_zip? string? - ZIP or postal code.
- address_zip_check? string? - If
address_zipwas provided, results of the check:pass,fail,unavailable, orunchecked.
- available_payout_methods? ("instant"|"standard")[]? - A set of available payout methods for this card. Only values from this set should be passed as the
methodwhen creating a payout.
- brand string - Card brand. Can be
American Express,Diners Club,Discover,Eftpos Australia,JCB,MasterCard,UnionPay,Visa, orUnknown.
- country? string? - Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
- currency? string? - Three-letter ISO code for currency. Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available for accounts where controller.requirement_collection is
application, which includes Custom accounts.
- customer? string|Customer|Deleted_customer? - The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
- cvc_check? string? - If a CVC was provided, results of the check:
pass,fail,unavailable, orunchecked. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see Check if a card is valid without a charge.
- default_for_currency? boolean? - Whether this card is the default external account for its currency. This property is only available for accounts where controller.requirement_collection is
application, which includes Custom accounts.
- dynamic_last4? string? - (For tokenized numbers only.) The last four digits of the device account number.
- exp_month int - Two-digit number representing the card's expiration month.
- exp_year int - Four-digit number representing the card's expiration year.
- fingerprint? string? - Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.
- funding string - Card funding type. Can be
credit,debit,prepaid, orunknown.
- id string - Unique identifier for the object.
- last4 string - The last four digits of the card.
- metadata? record { string... }? - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- name? string? - Cardholder name.
- networks? Token_card_networks -
- 'object "card" - String representing the object's type. Objects of the same type share the same value.
- status? string? - For external accounts that are cards, possible values are
newanderrored. If a payout fails, the status is set toerroredand scheduled payouts are stopped until account details are updated.
- tokenization_method? string? - If the card number is tokenized, this is the method that was used. Can be
android_pay(includes Google Pay),apple_pay,masterpass,visa_checkout, or null.
stripe: Card_generated_from_payment_method_details
Fields
- card_present? Payment_method_details_card_present -
- 'type string - The type of payment method transaction-specific details from the transaction that generated this
cardpayment method. Alwayscard_present.
stripe: Card_issuing_account_terms_of_service
Fields
- date? int? - The Unix timestamp marking when the account representative accepted the service agreement.
- ip? string? - The IP address from which the account representative accepted the service agreement.
- user_agent? string - The user agent of the browser from which the account representative accepted the service agreement.
stripe: card_issuing_param
Fields
- user_terms_acceptance? terms_acceptance_param -
stripe: card_issuing_settings_specs
Fields
- tos_acceptance? settings_terms_of_service_specs -
stripe: Card_mandate_payment_method_details
stripe: card_payments_settings_specs
Fields
- decline_on? decline_charge_on_specs -
- statement_descriptor_prefix? string -
- statement_descriptor_prefix_kana? string|"" -
- statement_descriptor_prefix_kanji? string|"" -
stripe: card_present
Simulated data for the card_present payment method.
Fields
- number? string -
stripe: cardholders_cardholder_body
Closed record
Fields
- billing? billing_specs -
- company? company_param -
- email? string - The cardholder's email address.
- expand? cardholders_cardholder_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- individual? individual_param -
- metadata? record { string... } - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- phone_number? string - The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the 3D Secure documentation for more details.
- preferred_locales? ("de"|"en"|"es"|"fr"|"it")[] - The cardholder’s preferred locales (languages), ordered by preference. Locales can be
de,en,es,fr, orit. This changes the language of the 3D Secure flow and one-time password messages sent to the cardholder.
- spending_controls? authorization_controls_param_v2 -
- status? "active"|"inactive" - Specifies whether to permit authorizations on this cardholder's cards.
stripe: CardList
Fields
- data Card[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: cards_card_body
Closed record
Fields
- cancellation_reason? "lost"|"stolen" - Reason why the
statusof this card iscanceled.
- expand? cards_card_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- personalization_design? string -
- pin? encrypted_pin_param_1 -
- shipping? shipping_specs_1 -
- spending_controls? authorization_controls_param -
- status? "active"|"canceled"|"inactive" - Dictates whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to
inactive. If this card is being canceled because it was lost or stolen, this information should be provided ascancellation_reason.
stripe: cards_id_body
Closed record
Fields
- account_holder_name? string - The name of the person or business that owns the bank account.
- account_holder_type? "company"|"individual" - The type of entity that holds the account. This can be either
individualorcompany.
- address_city? string - City/District/Suburb/Town/Village.
- address_country? string - Billing address country, if provided when creating card.
- address_line1? string - Address line 1 (Street address/PO Box/Company name).
- address_line2? string - Address line 2 (Apartment/Suite/Unit/Building).
- address_state? string - State/County/Province/Region.
- address_zip? string - ZIP or postal code.
- exp_month? string - Two digit number representing the card’s expiration month.
- exp_year? string - Four digit number representing the card’s expiration year.
- expand? cards_id_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- name? string - Cardholder name.
- owner? owner -
stripe: cards_id_body_1
Closed record
Fields
- expand? cards_id_body_1ExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: carrier_text_param
Hash containing carrier text, for use with physical bundles that support carrier text.
Fields
- header_body? string|"" -
- header_title? string|"" -
stripe: cart
Cart
Fields
- currency string -
- line_items line_item[] -
- tax? int -
- total int -
stripe: cartes_bancaires_network_options_param
Fields
- cb_avalgo "0"|"1"|"2"|"3"|"4"|"A" -
- cb_exemption? string -
- cb_score? int -
stripe: Cash_balance
A customer's Cash balance represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account.
Fields
- available? record { int... }? - A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the smallest currency unit.
- customer string - The ID of the customer whose cash balance this object represents.
- livemode boolean - Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode.
- 'object "cash_balance" - String representing the object's type. Objects of the same type share the same value.
- settings Customer_balance_customer_balance_settings -
stripe: cash_balance_param
Balance information and default balance settings for this customer.
Fields
- settings? balance_settings_param -
stripe: Charge
The Charge object represents a single attempt to move money into your Stripe account.
PaymentIntent confirmation is the most common way to create Charges, but transferring
money to a different Stripe account through Connect also creates Charges.
Some legacy payment flows create Charges directly, which is not recommended for new integrations.
Fields
- amount int - Amount intended to be collected by this payment. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
- amount_captured int - Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made).
- amount_refunded int - Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued).
- application? string|Application? - ID of the Connect application that created the charge.
- application_fee? string|Application_fee? - The application fee (if any) for the charge. See the Connect documentation for details.
- application_fee_amount? int? - The amount of the application fee (if any) requested for the charge. See the Connect documentation for details.
- balance_transaction? string|Balance_transaction? - ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).
- billing_details Billing_details -
- calculated_statement_descriptor? string? - The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined.
- captured boolean - If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.
- created int - Time at which the object was created. Measured in seconds since the Unix epoch.
- currency string - Three-letter ISO currency code, in lowercase. Must be a supported currency.
- customer? string|Customer|Deleted_customer? - ID of the customer this charge is for if one exists.
- description? string? - An arbitrary string attached to the object. Often useful for displaying to users.
- disputed boolean - Whether the charge has been disputed.
- failure_balance_transaction? string|Balance_transaction? - ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.
- failure_code? string? - Error code explaining reason for charge failure if available (see the errors section for a list of codes).
- failure_message? string? - Message to user further explaining reason for charge failure if available.
- fraud_details? Charge_fraud_details? - Information on fraud assessments for the charge.
- id string - Unique identifier for the object.
- livemode boolean - Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode.
- metadata record { string... } - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- 'object "charge" - String representing the object's type. Objects of the same type share the same value.
- on_behalf_of? string|Account? - The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the Connect documentation for details.
- outcome? Charge_outcome? - Details about whether the payment was accepted, and why. See understanding declines for details.
- paid boolean -
trueif the charge succeeded, or was successfully authorized for later capture.
- payment_intent? string|Payment_intent? - ID of the PaymentIntent associated with this charge, if one exists.
- payment_method? string? - ID of the payment method used in this charge.
- payment_method_details? Payment_method_details? - Details about the payment method at the time of the transaction.
- radar_options? Radar_radar_options -
- receipt_email? string? - This is the email address that the receipt for this charge was sent to.
- receipt_number? string? - This is the transaction number that appears on email receipts sent for this charge. This attribute will be
nulluntil a receipt has been sent.
- receipt_url? string? - This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt.
- refunded boolean - Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.
- refunds? RefundList_1? -
- shipping? Shipping? - Shipping information for the charge.
- source_transfer? string|Transfer? - The transfer ID which created this charge. Only present if the charge came from another Stripe account. See the Connect documentation for details.
- statement_descriptor? string? - For card charges, use
statement_descriptor_suffixinstead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters.
- statement_descriptor_suffix? string? - Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
- status "failed"|"pending"|"succeeded" - The status of the payment is either
succeeded,pending, orfailed.
- transfer_data? Charge_transfer_data? - An optional dictionary including the account to automatically transfer to as part of a destination charge. See the Connect documentation for details.
- transfer_group? string? - A string that identifies this transaction as part of a group. See the Connect documentation for details.
stripe: charge_capture_body
Closed record
Fields
- amount? int - The amount to capture, which must be less than or equal to the original amount. Any additional amount will be automatically refunded.
- application_fee? int - An application fee to add on to this charge.
- application_fee_amount? int - An application fee amount to add on to this charge, which must be less than or equal to the original amount.
- expand? charge_capture_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- receipt_email? string - The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode.
- statement_descriptor? string - For card charges, use
statement_descriptor_suffixinstead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters.
- statement_descriptor_suffix? string - Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
- transfer_data? transfer_data_specs_1 -
- transfer_group? string - A string that identifies this transaction as part of a group.
transfer_groupmay only be provided if it has not been set. See the Connect documentation for details.
stripe: charge_dispute_body
Closed record
Fields
- evidence? dispute_evidence_params -
- expand? charge_dispute_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- submit? boolean - Whether to immediately submit evidence to the bank. If
false, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set totrue(the default).
stripe: Charge_fraud_details
Fields
- stripe_report? string - Assessments from Stripe. If set, the value is
fraudulent.
- user_report? string - Assessments reported by you. If set, possible values of are
safeandfraudulent.
stripe: Charge_outcome
Fields
- network_status? string? - Possible values are
approved_by_network,declined_by_network,not_sent_to_network, andreversed_after_approval. The valuereversed_after_approvalindicates the payment was blocked by Stripe after bank authorization, and may temporarily appear as "pending" on a cardholder's statement.
- reason? string? - An enumerated value providing a more detailed explanation of the outcome's
type. Charges blocked by Radar's default block rule have the valuehighest_risk_level. Charges placed in review by Radar's default review rule have the valueelevated_risk_level. Charges authorized, blocked, or placed in review by custom rules have the valuerule. See understanding declines for more details.
- risk_level? string - Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are
normal,elevated,highest. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the valuenot_assessed. In the event of an error in the evaluation, this field will have the valueunknown. This field is only available with Radar.
- risk_score? int - Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are between 0 and 100. For non-card payments, card-based payments predating the public assignment of risk scores, or in the event of an error during evaluation, this field will not be present. This field is only available with Radar for Fraud Teams.
- seller_message? string? - A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer.
- 'type string - Possible values are
authorized,manual_review,issuer_declined,blocked, andinvalid. See understanding declines and Radar reviews for details.
stripe: charge_refund_body
Closed record
Fields
- amount? int - A positive integer in the smallest currency unit representing how much of this charge to refund. Can refund only up to the remaining, unrefunded amount of the charge.
- expand? charge_refund_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- instructions_email? string - For payment methods without native refund support (e.g., Konbini, PromptPay), use this email from the customer to receive refund instructions.
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- payment_intent? string - The identifier of the PaymentIntent to refund.
- reason? "duplicate"|"fraudulent"|"requested_by_customer" - String indicating the reason for the refund. If set, possible values are
duplicate,fraudulent, andrequested_by_customer. If you believe the charge to be fraudulent, specifyingfraudulentas the reason will add the associated card and email to your block lists, and will also help us improve our fraud detection algorithms.
- refund_application_fee? boolean - Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.
- reverse_transfer? boolean - Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount).<br><br>A transfer can be reversed only by the application that created the charge.
stripe: charge_refunds_body
Closed record
Fields
- amount? int -
- currency? string - Three-letter ISO currency code, in lowercase. Must be a supported currency.
- customer? string - Customer whose customer balance to refund from.
- expand? charge_refunds_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- instructions_email? string - For payment methods without native refund support (e.g., Konbini, PromptPay), use this email from the customer to receive refund instructions.
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- origin? "customer_balance" - Origin of the refund
- payment_intent? string - The identifier of the PaymentIntent to refund.
- reason? "duplicate"|"fraudulent"|"requested_by_customer" - String indicating the reason for the refund. If set, possible values are
duplicate,fraudulent, andrequested_by_customer. If you believe the charge to be fraudulent, specifyingfraudulentas the reason will add the associated card and email to your block lists, and will also help us improve our fraud detection algorithms.
- refund_application_fee? boolean - Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.
- reverse_transfer? boolean - Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount).<br><br>A transfer can be reversed only by the application that created the charge.
stripe: Charge_transfer_data
Fields
- amount? int? - The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.
stripe: ChargeList
Fields
- data Charge[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: charges_body
Closed record
Fields
- amount? int - Amount intended to be collected by this payment. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
- application_fee? int -
- application_fee_amount? int - A fee in cents (or local equivalent) that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the
Stripe-Accountheader in order to take an application fee. For more information, see the application fees documentation.
- capture? boolean - Whether to immediately capture the charge. Defaults to
true. Whenfalse, the charge issues an authorization (or pre-authorization), and will need to be captured later. Uncaptured charges expire after a set number of days (7 by default). For more information, see the authorizing charges and settling later documentation.
- card? record { address_city string, address_country string, address_line1 string, address_line2 string, address_state string, address_zip string, cvc string, exp_month int, exp_year int, metadata record { string... }, name string, number string, 'object "card" }|string - A token, like the ones returned by Stripe.js.
- currency? string - Three-letter ISO currency code, in lowercase. Must be a supported currency.
- customer? string - The ID of an existing customer that will be charged in this request.
- description? string - An arbitrary string which you can attach to a
Chargeobject. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include thedescriptionof the charge(s) that they are describing.
- expand? charges_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- on_behalf_of? string - The Stripe account ID for which these funds are intended. Automatically set if you use the
destinationparameter. For details, see Creating Separate Charges and Transfers.
- radar_options? radar_options_with_hidden_options -
- receipt_email? string - The email address to which this charge's receipt will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a Customer, the email address specified here will override the customer's email address. If
receipt_emailis specified for a charge in live mode, a receipt will be sent regardless of your email settings.
- shipping? optional_fields_shipping -
- 'source? string - A payment source to be charged. This can be the ID of a card (i.e., credit or debit card), a bank account, a source, a token, or a connected account. For certain sources---namely, cards, bank accounts, and attached sources---you must also pass the ID of the associated customer.
- statement_descriptor? string - For card charges, use
statement_descriptor_suffixinstead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters.
- statement_descriptor_suffix? string - Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
- transfer_data? transfer_data_specs -
- transfer_group? string - A string that identifies this transaction as part of a group. For details, see Grouping transactions.
stripe: charges_charge_body
Closed record
Fields
- customer? string - The ID of an existing customer that will be associated with this request. This field may only be updated if there is no existing associated customer with this charge.
- description? string - An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the
descriptionof the charge(s) that they are describing.
- expand? charges_charge_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- fraud_details? fraud_details -
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- receipt_email? string - This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address.
- shipping? optional_fields_shipping -
- transfer_group? string - A string that identifies this transaction as part of a group.
transfer_groupmay only be provided if it has not been set. See the Connect documentation for details.
stripe: Checkout\.session
Fields
- after_expiration? Payment_pages_checkout_session_after_expiration? -
- allow_promotion_codes? boolean? -
- amount_subtotal? int? -
- amount_total? int? -
- automatic_tax Payment_pages_checkout_session_automatic_tax -
- billing_address_collection? "auto"|"required"? -
- cancel_url? string? -
- client_reference_id? string? -
- client_secret? string? -
- consent? Payment_pages_checkout_session_consent? -
- consent_collection? Payment_pages_checkout_session_consent_collection? -
- created int -
- currency? string? -
- currency_conversion? Payment_pages_checkout_session_currency_conversion? -
- custom_fields Payment_pages_checkout_session_custom_fields[] -
- custom_text Payment_pages_checkout_session_custom_text -
- customer? string|Customer|Deleted_customer? -
- customer_creation? "always"|"if_required"? -
- customer_details? Payment_pages_checkout_session_customer_details? -
- customer_email? string? -
- expires_at int -
- id string -
- invoice_creation? Payment_pages_checkout_session_invoice_creation? -
- line_items? PaymentPagesCheckoutSessionListLineItems_1 -
- livemode boolean -
- locale? "auto"|"bg"|"cs"|"da"|"de"|"el"|"en"|"en-GB"|"es"|"es-419"|"et"|"fi"|"fil"|"fr"|"fr-CA"|"hr"|"hu"|"id"|"it"|"ja"|"ko"|"lt"|"lv"|"ms"|"mt"|"nb"|"nl"|"pl"|"pt"|"pt-BR"|"ro"|"ru"|"sk"|"sl"|"sv"|"th"|"tr"|"vi"|"zh"|"zh-HK"|"zh-TW"? -
- metadata? record { string... }? -
- mode "payment"|"setup"|"subscription" -
- 'object "checkout.session" -
- payment_intent? string|Payment_intent? -
- payment_link? string|Payment_link? -
- payment_method_collection? "always"|"if_required"? -
- payment_method_configuration_details? Payment_method_config_biz_payment_method_configuration_details? -
- payment_method_options? Checkout_session_payment_method_options? -
- payment_method_types Checkout\\\\\\\.sessionPaymentmethodtypesItemsString[] -
- payment_status "no_payment_required"|"paid"|"unpaid" -
- phone_number_collection? Payment_pages_checkout_session_phone_number_collection -
- recovered_from? string? -
- redirect_on_completion? "always"|"if_required"|"never" -
- return_url? string -
- saved_payment_method_options? Payment_pages_checkout_session_saved_payment_method_options? -
- setup_intent? string|Setup_intent? -
- shipping_address_collection? Payment_pages_checkout_session_shipping_address_collection? -
- shipping_cost? Payment_pages_checkout_session_shipping_cost? -
- shipping_details? Shipping? -
- shipping_options Payment_pages_checkout_session_shipping_option[] -
- status? "complete"|"expired"|"open"? -
- submit_type? "auto"|"book"|"donate"|"pay"? -
- subscription? string|Subscription? -
- success_url? string? -
- tax_id_collection? Payment_pages_checkout_session_tax_id_collection -
- total_details? Payment_pages_checkout_session_total_details? -
- ui_mode? "embedded"|"hosted"? -
- url? string? -
stripe: Checkout_acss_debit_mandate_options
Fields
- custom_mandate_url? string - A URL for custom mandate text
- default_for? ("invoice"|"subscription")[] - List of Stripe products where this mandate can be selected automatically. Returned when the Session is in
setupmode.
- interval_description? string? - Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
- payment_schedule? "combined"|"interval"|"sporadic"? - Payment schedule for the mandate.
- transaction_type? "business"|"personal"? - Transaction type of the mandate.
stripe: Checkout_acss_debit_payment_method_options
Fields
- currency? "cad"|"usd" - Currency supported by the bank account. Returned when the Session is in
setupmode.
- mandate_options? Checkout_acss_debit_mandate_options -
- setup_future_usage? "none"|"off_session"|"on_session" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
- verification_method? "automatic"|"instant"|"microdeposits" - Bank account verification method.
stripe: Checkout_affirm_payment_method_options
Fields
- setup_future_usage? "none" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
stripe: Checkout_afterpay_clearpay_payment_method_options
Fields
- setup_future_usage? "none" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
stripe: Checkout_alipay_payment_method_options
Fields
- setup_future_usage? "none" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
stripe: Checkout_amazon_pay_payment_method_options
Fields
- setup_future_usage? "none"|"off_session" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
stripe: Checkout_au_becs_debit_payment_method_options
Fields
- setup_future_usage? "none" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
stripe: Checkout_bacs_debit_payment_method_options
Fields
- setup_future_usage? "none"|"off_session"|"on_session" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
stripe: Checkout_bancontact_payment_method_options
Fields
- setup_future_usage? "none" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
stripe: Checkout_boleto_payment_method_options
Fields
- expires_after_days int - The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time.
- setup_future_usage? "none"|"off_session"|"on_session" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
stripe: Checkout_card_installments_options
Fields
- enabled? boolean - Indicates if installments are enabled
stripe: Checkout_card_payment_method_options
Fields
- installments? Checkout_card_installments_options -
- request_three_d_secure "any"|"automatic"|"challenge" - We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to
automatic. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine.
- setup_future_usage? "none"|"off_session"|"on_session" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
- statement_descriptor_suffix_kana? string - Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the concatenation of both prefix and suffix (including separators) will appear truncated to 22 characters.
- statement_descriptor_suffix_kanji? string - Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the concatenation of both prefix and suffix (including separators) will appear truncated to 17 characters.
stripe: Checkout_cashapp_payment_method_options
Fields
- setup_future_usage? "none" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
stripe: Checkout_customer_balance_bank_transfer_payment_method_options
Fields
- eu_bank_transfer? Payment_method_options_customer_balance_eu_bank_account -
- requested_address_types? ("aba"|"iban"|"sepa"|"sort_code"|"spei"|"swift"|"zengin")[] - List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
Permitted values include:
sort_code,zengin,iban, orspei.
- 'type? "eu_bank_transfer"|"gb_bank_transfer"|"jp_bank_transfer"|"mx_bank_transfer"|"us_bank_transfer"? - The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include:
eu_bank_transfer,gb_bank_transfer,jp_bank_transfer,mx_bank_transfer, orus_bank_transfer.
stripe: Checkout_customer_balance_payment_method_options
Fields
- bank_transfer? Checkout_customer_balance_bank_transfer_payment_method_options -
- funding_type? "bank_transfer"? - The funding method type to be used when there are not enough funds in the customer balance. Permitted values include:
bank_transfer.
- setup_future_usage? "none" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
stripe: Checkout_eps_payment_method_options
Fields
- setup_future_usage? "none" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
stripe: Checkout_fpx_payment_method_options
Fields
- setup_future_usage? "none" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
stripe: Checkout_giropay_payment_method_options
Fields
- setup_future_usage? "none" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
stripe: Checkout_grab_pay_payment_method_options
Fields
- setup_future_usage? "none" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
stripe: Checkout_ideal_payment_method_options
Fields
- setup_future_usage? "none" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
stripe: Checkout_klarna_payment_method_options
Fields
- setup_future_usage? "none"|"off_session"|"on_session" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
stripe: Checkout_konbini_payment_method_options
Fields
- expires_after_days? int? - The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and
expires_after_daysset to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST.
- setup_future_usage? "none" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
stripe: Checkout_link_payment_method_options
Fields
- setup_future_usage? "none"|"off_session" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
stripe: Checkout_mobilepay_payment_method_options
Fields
- setup_future_usage? "none" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
stripe: Checkout_multibanco_payment_method_options
Fields
- setup_future_usage? "none" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
stripe: Checkout_oxxo_payment_method_options
Fields
- expires_after_days int - The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
- setup_future_usage? "none" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
stripe: Checkout_p24_payment_method_options
Fields
- setup_future_usage? "none" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
stripe: Checkout_paynow_payment_method_options
Fields
- setup_future_usage? "none" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
stripe: Checkout_paypal_payment_method_options
Fields
- capture_method? "manual" - Controls when the funds will be captured from the customer's account.
- preferred_locale? string? - Preferred locale of the PayPal checkout page that the customer is redirected to.
- reference? string? - A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
- setup_future_usage? "none"|"off_session" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
stripe: Checkout_pix_payment_method_options
Fields
- expires_after_seconds? int? - The number of seconds after which Pix payment will expire.
stripe: Checkout_revolut_pay_payment_method_options
Fields
- setup_future_usage? "none"|"off_session" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
stripe: Checkout_sepa_debit_payment_method_options
Fields
- setup_future_usage? "none"|"off_session"|"on_session" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
stripe: Checkout_session_payment_method_options
Fields
- acss_debit? Checkout_acss_debit_payment_method_options -
- affirm? Checkout_affirm_payment_method_options -
- afterpay_clearpay? Checkout_afterpay_clearpay_payment_method_options -
- alipay? Checkout_alipay_payment_method_options -
- amazon_pay? Checkout_amazon_pay_payment_method_options -
- au_becs_debit? Checkout_au_becs_debit_payment_method_options -
- bacs_debit? Checkout_bacs_debit_payment_method_options -
- bancontact? Checkout_bancontact_payment_method_options -
- boleto? Checkout_boleto_payment_method_options -
- cashapp? Checkout_cashapp_payment_method_options -
- customer_balance? Checkout_customer_balance_payment_method_options -
- giropay? Checkout_giropay_payment_method_options -
- grabpay? Checkout_grab_pay_payment_method_options -
- klarna? Checkout_klarna_payment_method_options -
- konbini? Checkout_konbini_payment_method_options -
- mobilepay? Checkout_mobilepay_payment_method_options -
- multibanco? Checkout_multibanco_payment_method_options -
- paynow? Checkout_paynow_payment_method_options -
- paypal? Checkout_paypal_payment_method_options -
- revolut_pay? Checkout_revolut_pay_payment_method_options -
- sepa_debit? Checkout_sepa_debit_payment_method_options -
- sofort? Checkout_sofort_payment_method_options -
- us_bank_account? Checkout_us_bank_account_payment_method_options -
stripe: checkout_sessions_body
Closed record
Fields
- after_expiration? after_expiration_params -
- allow_promotion_codes? boolean - Enables user redeemable promotion codes.
- automatic_tax? automatic_tax_params -
- billing_address_collection? "auto"|"required" - Specify whether Checkout should collect the customer's billing address. Defaults to
auto.
- cancel_url? string - If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.
- client_reference_id? string - A unique string to reference the Checkout Session. This can be a customer ID, a cart ID, or similar, and can be used to reconcile the session with your internal systems.
- consent_collection? consent_collection_params -
- currency? string - Three-letter ISO currency code, in lowercase. Must be a supported currency. Required in
setupmode whenpayment_method_typesis not set.
- custom_fields? custom_field_param[] - Collect additional information from your customer using custom fields. Up to 3 fields are supported.
- custom_text? custom_text_param -
- customer? string - ID of an existing Customer, if one exists. In
paymentmode, the customer’s most recently saved card payment method will be used to prefill the email, name, card details, and billing address on the Checkout page. Insubscriptionmode, the customer’s default payment method will be used if it’s a card, otherwise the most recently saved card will be used. A valid billing address, billing name and billing email are required on the payment method for Checkout to prefill the customer's card details. If the Customer already has a valid email set, the email will be prefilled and not editable in Checkout. If the Customer does not have a validemail, Checkout will set the email entered during the session on the Customer. If blank for Checkout Sessions insubscriptionmode or withcustomer_creationset asalwaysinpaymentmode, Checkout will create a new Customer object based on information provided during the payment flow. You can setpayment_intent_data.setup_future_usageto have Checkout automatically attach the payment method to the Customer you pass in for future reuse.
- customer_creation? "always"|"if_required" - Configure whether a Checkout Session creates a Customer during Session confirmation.
When a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout
with customer_details.
Sessions that don't create Customers instead are grouped by guest customers
in the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions.
Can only be set in
paymentandsetupmode.
- customer_email? string - If provided, this value will be used when the Customer object is created.
If not provided, customers will be asked to enter their email address.
Use this parameter to prefill customer data if you already have an email
on file. To access information about the customer once a session is
complete, use the
customerfield.
- customer_update? customer_update_params -
- discounts? discount_params[] - The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.
- expand? checkout_sessions_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- expires_at? int - The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 30 minutes to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation.
- invoice_creation? invoice_creation_params -
- line_items? line_item_params[] - A list of items the customer is purchasing. Use this parameter to pass one-time or recurring Prices.
For
paymentmode, there is a maximum of 100 line items, however it is recommended to consolidate line items if there are more than a few dozen. Forsubscriptionmode, there is a maximum of 20 line items with recurring Prices and 20 line items with one-time Prices. Line items with one-time Prices will be on the initial invoice only.
- locale? "auto"|"bg"|"cs"|"da"|"de"|"el"|"en"|"en-GB"|"es"|"es-419"|"et"|"fi"|"fil"|"fr"|"fr-CA"|"hr"|"hu"|"id"|"it"|"ja"|"ko"|"lt"|"lv"|"ms"|"mt"|"nb"|"nl"|"pl"|"pt"|"pt-BR"|"ro"|"ru"|"sk"|"sl"|"sv"|"th"|"tr"|"vi"|"zh"|"zh-HK"|"zh-TW" - The IETF language tag of the locale Checkout is displayed in. If blank or
auto, the browser's locale is used.
- metadata? record { string... } - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- mode? "payment"|"setup"|"subscription" - The mode of the Checkout Session. Pass
subscriptionif the Checkout Session includes at least one recurring item.
- payment_intent_data? payment_intent_data_params -
- payment_method_collection? "always"|"if_required" - Specify whether Checkout should collect a payment method. When set to
if_required, Checkout will not collect a payment method when the total due for the session is 0. This may occur if the Checkout Session includes a free trial or a discount. Can only be set insubscriptionmode. Defaults toalways. If you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring subscriptions with a free trial.
- payment_method_configuration? string - The ID of the payment method configuration to use with this Checkout session.
- payment_method_data? payment_method_data_param -
- payment_method_options? payment_method_options_param -
- payment_method_types? ("acss_debit"|"affirm"|"afterpay_clearpay"|"alipay"|"amazon_pay"|"au_becs_debit"|"bacs_debit"|"bancontact"|"blik"|"boleto"|"card"|"cashapp"|"customer_balance"|"eps"|"fpx"|"giropay"|"grabpay"|"ideal"|"klarna"|"konbini"|"link"|"mobilepay"|"multibanco"|"oxxo"|"p24"|"paynow"|"paypal"|"pix"|"promptpay"|"revolut_pay"|"sepa_debit"|"sofort"|"swish"|"twint"|"us_bank_account"|"wechat_pay"|"zip")[] - A list of the types of payment methods (e.g.,
card) this Checkout Session can accept. You can omit this attribute to manage your payment methods from the Stripe Dashboard. See Dynamic Payment Methods for more details. Read more about the supported payment methods and their requirements in our payment method details guide. If multiple payment methods are passed, Checkout will dynamically reorder them to prioritize the most relevant payment methods based on the customer's location and other characteristics.
- phone_number_collection? phone_number_collection_params -
- redirect_on_completion? "always"|"if_required"|"never" - This parameter applies to
ui_mode: embedded. Learn more about the redirect behavior of embedded sessions. Defaults toalways.
- return_url? string - The URL to redirect your customer back to after they authenticate or cancel their payment on the
payment method's app or site. This parameter is required if ui_mode is
embeddedand redirect-based payment methods are enabled on the session.
- saved_payment_method_options? saved_payment_method_options_param -
- setup_intent_data? setup_intent_data_param -
- shipping_address_collection? shipping_address_collection_params -
- shipping_options? shipping_option_params[] - The shipping rate options to apply to this Session. Up to a maximum of 5.
- submit_type? "auto"|"book"|"donate"|"pay" - Describes the type of transaction being performed by Checkout in order to customize
relevant text on the page, such as the submit button.
submit_typecan only be specified on Checkout Sessions inpaymentmode. If blank orauto,payis used.
- subscription_data? subscription_data_params -
- success_url? string - The URL to which Stripe should send customers when payment or setup
is complete.
This parameter is not allowed if ui_mode is
embedded. If you’d like to use information from the successful Checkout Session on your page, read the guide on customizing your success page.
- tax_id_collection? tax_id_collection_params -
- ui_mode? "embedded"|"hosted" - The UI mode of the Session. Defaults to
hosted.
stripe: Checkout_sofort_payment_method_options
Fields
- setup_future_usage? "none" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
stripe: Checkout_swish_payment_method_options
Fields
- reference? string? - The order reference that will be displayed to customers in the Swish application. Defaults to the
idof the Payment Intent.
stripe: Checkout_us_bank_account_payment_method_options
Fields
- financial_connections? Linked_account_options_us_bank_account -
- setup_future_usage? "none"|"off_session"|"on_session" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
- verification_method? "automatic"|"instant" - Bank account verification method.
stripe: ClientHttp1Settings
Closed record
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy? ProxyConfig - Proxy server related options
stripe: Climate\.order
Fields
- amount_fees int -
- amount_subtotal int -
- amount_total int -
- beneficiary? Climate_removals_beneficiary -
- canceled_at? int? -
- cancellation_reason? "expired"|"product_unavailable"|"requested"? -
- certificate? string? -
- confirmed_at? int? -
- created int -
- currency string -
- delayed_at? int? -
- delivered_at? int? -
- delivery_details Climate_removals_order_deliveries[] -
- expected_delivery_year int -
- id string -
- livemode boolean -
- metadata record { string... } -
- metric_tons string -
- 'object "climate.order" -
- product string|Climate\.product -
- product_substituted_at? int? -
- status "awaiting_funds"|"canceled"|"confirmed"|"delivered"|"open" -
stripe: Climate\.product
Fields
- created int -
- current_prices_per_metric_ton record { Climate_removals_products_price... } -
- delivery_year? int? -
- id string -
- livemode boolean -
- metric_tons_available string -
- name string -
- 'object "climate.product" -
- suppliers Climate\.supplier[] -
stripe: Climate\.supplier
Fields
- id string -
- info_url string -
- livemode boolean -
- locations Climate_removals_location[] -
- name string -
- 'object "climate.supplier" -
- removal_pathway "biomass_carbon_removal_and_storage"|"direct_air_capture"|"enhanced_weathering" -
stripe: climate_orders_body
Closed record
Fields
- amount? int - Requested amount of carbon removal units. Either this or
metric_tonsmust be specified.
- beneficiary? beneficiary_params -
- currency? string - Request currency for the order as a three-letter ISO currency code, in lowercase. Must be a supported settlement currency for your account. If omitted, the account's default currency will be used.
- expand? climate_orders_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- metadata? record { string... } - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- metric_tons? string - Requested number of tons for the order. Either this or
amountmust be specified.
- product string - Unique identifier of the Climate product.
stripe: Climate_removals_beneficiary
Fields
- public_name string - Publicly displayable name for the end beneficiary of carbon removal.
stripe: Climate_removals_location
Fields
- city? string? - The city where the supplier is located.
- country string - Two-letter ISO code representing the country where the supplier is located.
- latitude? decimal? - The geographic latitude where the supplier is located.
- longitude? decimal? - The geographic longitude where the supplier is located.
- region? string? - The state/county/province/region where the supplier is located.
stripe: Climate_removals_order_deliveries
The delivery of a specified quantity of carbon for an order.
Fields
- delivered_at int - Time at which the delivery occurred. Measured in seconds since the Unix epoch.
- location? Climate_removals_location? - Specific location of this delivery.
- metric_tons string - Quantity of carbon removal supplied by this delivery.
- registry_url? string? - Once retired, a URL to the registry entry for the tons from this delivery.
- supplier Climate\.supplier -
stripe: Climate_removals_products_price
Fields
- amount_fees int - Fees for one metric ton of carbon removal in the currency's smallest unit.
- amount_subtotal int - Subtotal for one metric ton of carbon removal (excluding fees) in the currency's smallest unit.
- amount_total int - Total for one metric ton of carbon removal (including fees) in the currency's smallest unit.
stripe: ClimateRemovalsOrdersList
Fields
- data Climate\.order[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: ClimateRemovalsProductsList
Fields
- data Climate\.product[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: ClimateRemovalsSuppliersList
Fields
- data Climate\.supplier[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: collection_options_params
Specifies the requirements that Stripe collects from connected accounts in the Connect Onboarding flow.
Fields
- fields "currently_due"|"eventually_due" -
- future_requirements? "include"|"omit" -
stripe: company_ownership_declaration
Fields
- date? int -
- ip? string -
- user_agent? string -
stripe: company_param
Additional information about a company cardholder.
Fields
- tax_id? string -
stripe: company_specs
Information about the company or business. This field is available for any business_type. Once you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is application, which includes Custom accounts.
Fields
- address? legal_entity_and_kyc_address_specs -
- address_kana? japan_address_kana_specs -
- address_kanji? japan_address_kanji_specs -
- directors_provided? boolean -
- executives_provided? boolean -
- export_license_id? string -
- export_purpose_code? string -
- name? string -
- name_kana? string -
- name_kanji? string -
- owners_provided? boolean -
- ownership_declaration? company_ownership_declaration -
- phone? string -
- registration_number? string -
- structure? ""|"free_zone_establishment"|"free_zone_llc"|"government_instrumentality"|"governmental_unit"|"incorporated_non_profit"|"incorporated_partnership"|"limited_liability_partnership"|"llc"|"multi_member_llc"|"private_company"|"private_corporation"|"private_partnership"|"public_company"|"public_corporation"|"public_partnership"|"registered_charity"|"single_member_llc"|"sole_establishment"|"sole_proprietorship"|"tax_exempt_government_instrumentality"|"unincorporated_association"|"unincorporated_non_profit"|"unincorporated_partnership" -
- tax_id? string -
- tax_id_registrar? string -
- vat_id? string -
- verification? verification_specs -
stripe: completed_sessions_params
Fields
- 'limit int -
stripe: components
Configuration for each component. Exactly 1 component must be enabled.
Fields
- payment_element? payment_element_param -
- pricing_table? pricing_table_param -
stripe: configuration_item_params
Fields
- billing_thresholds? record { usage_gte int }|"" -
- metadata? record { string... } -
- price? string -
- price_data? recurring_price_data -
- quantity? int -
- tax_rates? TaxratesItemsString[]|"" -
stripe: configurations_configuration_body
Closed record
Fields
- active? boolean - Whether the configuration is active and can be used to create portal sessions.
- business_profile? business_profile_update_param -
- expand? configurations_configuration_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- features? features_updating_param -
- login_page? login_page_update_param -
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
stripe: configurations_configuration_body_1
Closed record
Fields
- bbpos_wisepos_e? record { splashscreen string|"" }|"" - An object containing device type specific settings for BBPOS WisePOS E readers
- expand? configurations_configuration_body_1ExpandItemsString[] - Specifies which fields in the response should be expanded.
- name? string - Name of the configuration
- offline? record { enabled boolean }|"" - Configurations for collecting transactions offline.
- stripe_s700? record { splashscreen string|"" }|"" - An object containing device type specific settings for Stripe S700 readers
- tipping? record { aud record { fixed_amounts int[], percentages int[], smart_tip_threshold int }, cad record { fixed_amounts int[], percentages int[], smart_tip_threshold int }, chf record { fixed_amounts int[], percentages int[], smart_tip_threshold int }, czk record { fixed_amounts int[], percentages int[], smart_tip_threshold int }, dkk record { fixed_amounts int[], percentages int[], smart_tip_threshold int }, eur record { fixed_amounts int[], percentages int[], smart_tip_threshold int }, gbp record { fixed_amounts int[], percentages int[], smart_tip_threshold int }, hkd record { fixed_amounts int[], percentages int[], smart_tip_threshold int }, myr record { fixed_amounts int[], percentages int[], smart_tip_threshold int }, nok record { fixed_amounts int[], percentages int[], smart_tip_threshold int }, nzd record { fixed_amounts int[], percentages int[], smart_tip_threshold int }, sek record { fixed_amounts int[], percentages int[], smart_tip_threshold int }, sgd record { fixed_amounts int[], percentages int[], smart_tip_threshold int }, usd record { fixed_amounts int[], percentages int[], smart_tip_threshold int } }|"" - Tipping configurations for readers supporting on-reader tips
- verifone_p400? record { splashscreen string|"" }|"" - An object containing device type specific settings for Verifone P400 readers
stripe: Confirmation_token
ConfirmationTokens help transport client side data collected by Stripe JS over to your server for confirming a PaymentIntent or SetupIntent. If the confirmation is successful, values present on the ConfirmationToken are written onto the Intent.
To learn more about how to use ConfirmationToken, visit the related guides:
Fields
- created int - Time at which the object was created. Measured in seconds since the Unix epoch.
- expires_at? int? - Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent.
- id string - Unique identifier for the object.
- livemode boolean - Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode.
- mandate_data? Confirmation_tokens_resource_mandate_data? - Data used for generating a Mandate.
- 'object "confirmation_token" - String representing the object's type. Objects of the same type share the same value.
- payment_intent? string? - ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.
- payment_method_options? Confirmation_tokens_resource_payment_method_options? - Payment-method-specific configuration for this ConfirmationToken.
- payment_method_preview? Confirmation_tokens_resource_payment_method_preview? - Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken.
- return_url? string? - Return URL used to confirm the Intent.
- setup_future_usage? "off_session"|"on_session"? - Indicates that you intend to make future payments with this ConfirmationToken's payment method. The presence of this property will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.
- setup_intent? string? - ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.
- shipping? Confirmation_tokens_resource_shipping? - Shipping information collected on this ConfirmationToken.
- use_stripe_sdk boolean - Indicates whether the Stripe SDK is used to handle confirmation flow. Defaults to
trueon ConfirmationToken.
stripe: Confirmation_tokens_resource_mandate_data
Data used for generating a Mandate.
Fields
- customer_acceptance Confirmation_tokens_resource_mandate_data_resource_customer_acceptance -
stripe: Confirmation_tokens_resource_mandate_data_resource_customer_acceptance
This hash contains details about the customer acceptance of the Mandate.
Fields
- online? Confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_online? - If this is a Mandate accepted online, this hash contains details about the online acceptance.
- 'type string - The type of customer acceptance information included with the Mandate.
stripe: Confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_online
This hash contains details about the online acceptance.
Fields
- ip_address? string? - The IP address from which the Mandate was accepted by the customer.
- user_agent? string? - The user agent of the browser from which the Mandate was accepted by the customer.
stripe: Confirmation_tokens_resource_payment_method_options
Payment-method-specific configuration
Fields
- card? Confirmation_tokens_resource_payment_method_options_resource_card? - This hash contains the card payment method options.
stripe: Confirmation_tokens_resource_payment_method_options_resource_card
This hash contains the card payment method options.
Fields
- cvc_token? string? - The
cvc_updateToken collected from the Payment Element.
stripe: Confirmation_tokens_resource_payment_method_preview
Details of the PaymentMethod collected by Payment Element
Fields
- acss_debit? Payment_method_acss_debit -
- affirm? Payment_method_affirm -
- afterpay_clearpay? Payment_method_afterpay_clearpay -
- allow_redisplay? "always"|"limited"|"unspecified" - This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.
- amazon_pay? Payment_method_amazon_pay -
- au_becs_debit? Payment_method_au_becs_debit -
- bacs_debit? Payment_method_bacs_debit -
- bancontact? Payment_method_bancontact -
- billing_details Billing_details -
- blik? Payment_method_blik -
- boleto? Payment_method_boleto -
- card? Payment_method_card -
- card_present? Payment_method_card_present -
- cashapp? Payment_method_cashapp -
- customer_balance? Payment_method_customer_balance -
- eps? Payment_method_eps -
- fpx? Payment_method_fpx -
- giropay? Payment_method_giropay -
- grabpay? Payment_method_grabpay -
- ideal? Payment_method_ideal -
- interac_present? Payment_method_interac_present -
- klarna? Payment_method_klarna -
- konbini? Payment_method_konbini -
- link? Payment_method_link -
- mobilepay? Payment_method_mobilepay -
- multibanco? Payment_method_multibanco -
- oxxo? Payment_method_oxxo -
- p24? Payment_method_p24 -
- paynow? Payment_method_paynow -
- paypal? Payment_method_paypal -
- pix? Payment_method_pix -
- promptpay? Payment_method_promptpay -
- revolut_pay? Payment_method_revolut_pay -
- sepa_debit? Payment_method_sepa_debit -
- sofort? Payment_method_sofort -
- swish? Payment_method_swish -
- twint? Payment_method_twint -
- 'type "acss_debit"|"affirm"|"afterpay_clearpay"|"alipay"|"amazon_pay"|"au_becs_debit"|"bacs_debit"|"bancontact"|"blik"|"boleto"|"card"|"card_present"|"cashapp"|"customer_balance"|"eps"|"fpx"|"giropay"|"grabpay"|"ideal"|"interac_present"|"klarna"|"konbini"|"link"|"mobilepay"|"multibanco"|"oxxo"|"p24"|"paynow"|"paypal"|"pix"|"promptpay"|"revolut_pay"|"sepa_debit"|"sofort"|"swish"|"twint"|"us_bank_account"|"wechat_pay"|"zip" - The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
- us_bank_account? Payment_method_us_bank_account -
- wechat_pay? Payment_method_wechat_pay -
- zip? Payment_method_zip -
stripe: Confirmation_tokens_resource_shipping
Fields
- address Address -
- name string - Recipient name.
- phone? string? - Recipient phone (including extension).
stripe: Connect_account_reference
Fields
- 'type "account"|"self" - Type of the account referenced.
stripe: Connect_collection_transfer
Fields
- amount int - Amount transferred, in cents (or local equivalent).
- currency string - Three-letter ISO currency code, in lowercase. Must be a supported currency.
- id string - Unique identifier for the object.
- livemode boolean - Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode.
- 'object "connect_collection_transfer" - String representing the object's type. Objects of the same type share the same value.
stripe: Connect_embedded_account_config_claim
Fields
- enabled boolean - Whether the embedded component is enabled.
- features Connect_embedded_account_features_claim -
stripe: Connect_embedded_account_features_claim
Fields
- external_account_collection boolean - Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for custom accounts (or accounts where the platform is compliance owner). Otherwise, bank account collection is determined by compliance requirements.
stripe: Connect_embedded_account_session_create_components
Fields
- account_management Connect_embedded_account_config_claim -
- account_onboarding Connect_embedded_account_config_claim -
- balances Connect_embedded_payouts_config_claim -
- documents Connect_embedded_base_config_claim -
- payment_details Connect_embedded_payments_config_claim -
- payments Connect_embedded_payments_config_claim -
- payouts Connect_embedded_payouts_config_claim -
- payouts_list Connect_embedded_base_config_claim -
stripe: Connect_embedded_base_config_claim
Fields
- enabled boolean - Whether the embedded component is enabled.
- features Connect_embedded_base_features -
stripe: Connect_embedded_base_features
stripe: Connect_embedded_payments_config_claim
Fields
- enabled boolean - Whether the embedded component is enabled.
- features Connect_embedded_payments_features -
stripe: Connect_embedded_payments_features
Fields
- capture_payments boolean - Whether to allow capturing and cancelling payment intents. This is
trueby default.
- destination_on_behalf_of_charge_management boolean - Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is
falseby default.
- dispute_management boolean - Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is
trueby default.
- refund_management boolean - Whether to allow sending refunds. This is
trueby default.
stripe: Connect_embedded_payouts_config_claim
Fields
- enabled boolean - Whether the embedded component is enabled.
- features Connect_embedded_payouts_features -
stripe: Connect_embedded_payouts_features
Fields
- edit_payout_schedule boolean - Whether to allow payout schedule to be changed. Default
truewhen Stripe owns Loss Liability, defaultfalseotherwise.
- external_account_collection boolean - Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for custom accounts (or accounts where the platform is compliance owner). Otherwise, bank account collection is determined by compliance requirements.
- instant_payouts boolean - Whether to allow creation of instant payouts. Default
truewhen Stripe owns Loss Liability, defaultfalseotherwise.
- standard_payouts boolean - Whether to allow creation of standard payouts. Default
truewhen Stripe owns Loss Liability, defaultfalseotherwise.
stripe: connect_js_account_token_company_specs
Fields
- address? legal_entity_and_kyc_address_specs -
- address_kana? japan_address_kana_specs -
- address_kanji? japan_address_kanji_specs -
- directors_provided? boolean -
- executives_provided? boolean -
- export_license_id? string -
- export_purpose_code? string -
- name? string -
- name_kana? string -
- name_kanji? string -
- owners_provided? boolean -
- ownership_declaration? company_ownership_declaration -
- ownership_declaration_shown_and_signed? boolean -
- phone? string -
- registration_number? string -
- structure? ""|"free_zone_establishment"|"free_zone_llc"|"government_instrumentality"|"governmental_unit"|"incorporated_non_profit"|"incorporated_partnership"|"limited_liability_partnership"|"llc"|"multi_member_llc"|"private_company"|"private_corporation"|"private_partnership"|"public_company"|"public_corporation"|"public_partnership"|"registered_charity"|"single_member_llc"|"sole_establishment"|"sole_proprietorship"|"tax_exempt_government_instrumentality"|"unincorporated_association"|"unincorporated_non_profit"|"unincorporated_partnership" -
- tax_id? string -
- tax_id_registrar? string -
- vat_id? string -
- verification? verification_specs -
stripe: connect_js_account_token_specs
Information for the account this token represents.
Fields
- business_type? "company"|"government_entity"|"individual"|"non_profit" -
- company? connect_js_account_token_company_specs -
- individual? individual_specs_1 -
- tos_shown_and_accepted? boolean -
stripe: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig|CredentialsConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings? ClientHttp1Settings - Configurations related to HTTP/1.x protocol
- http2Settings? ClientHttp2Settings - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache? CacheConfig - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- responseLimits? ResponseLimitConfigs - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
stripe: consent_collection_params
Configure fields for the Checkout Session to gather active consent from customers.
Fields
- payment_method_reuse_agreement? payment_method_reuse_agreement_params -
- promotions? "auto"|"none" -
- terms_of_service? "none"|"required" -
stripe: consent_collection_params_1
Configure fields to gather active consent from customers.
Fields
- payment_method_reuse_agreement? payment_method_reuse_agreement_params -
- promotions? "auto"|"none" -
- terms_of_service? "none"|"required" -
stripe: controller_dashboard_specs
Fields
- 'type? "express"|"full"|"none" -
stripe: controller_fees_specs
Fields
- payer? "account"|"application" -
stripe: controller_losses_specs
Fields
- payments? "application"|"stripe" -
stripe: controller_specs
A hash of configuration describing the account controller's attributes.
Fields
- fees? controller_fees_specs -
- losses? controller_losses_specs -
- requirement_collection? "application"|"stripe" -
- stripe_dashboard? controller_dashboard_specs -
stripe: country_options
Specific options for a registration in the specified country.
Fields
- ae? default -
- at? europe -
- au? default -
- be? europe -
- bg? europe -
- bh? default -
- ca? canada -
- ch? default -
- cl? simplified -
- co? simplified -
- cy? europe -
- cz? europe -
- de? europe -
- dk? europe -
- ee? europe -
- eg? simplified -
- es? europe -
- fi? europe -
- fr? europe -
- gb? default -
- ge? simplified -
- gr? europe -
- hr? europe -
- hu? europe -
- id? simplified -
- ie? europe -
- 'is? default -
- it? europe -
- jp? default -
- ke? simplified -
- kr? simplified -
- kz? simplified -
- lt? europe -
- lu? europe -
- lv? europe -
- mt? europe -
- mx? simplified -
- my? simplified -
- ng? simplified -
- nl? europe -
- no? default -
- nz? default -
- om? default -
- pl? europe -
- pt? europe -
- ro? europe -
- sa? simplified -
- se? europe -
- sg? default -
- si? europe -
- sk? europe -
- th? simplified -
- tr? simplified -
- us? united_states -
- vn? simplified -
- za? default -
stripe: Country_spec
Stripe needs to collect certain pieces of information about each account created. These requirements can differ depending on the account's country. The Country Specs API makes these rules available to your integration.
You can also view the information from this API call as an online guide.
Fields
- default_currency string - The default currency for this country. This applies to both payment methods and bank accounts.
- id string - Unique identifier for the object. Represented as the ISO country code for this country.
- 'object "country_spec" - String representing the object's type. Objects of the same type share the same value.
- supported_bank_account_currencies record { string[]... } - Currencies that can be accepted in the specific country (for transfers).
- supported_payment_currencies Country_specSupportedpaymentcurrenciesItemsString[] - Currencies that can be accepted in the specified country (for payments).
- supported_payment_methods Country_specSupportedpaymentmethodsItemsString[] - Payment methods available in the specified country. You may need to enable some payment methods (e.g., ACH) on your account before they appear in this list. The
stripepayment method refers to charging through your platform.
- supported_transfer_countries Country_specSupportedtransfercountriesItemsString[] - Countries that can accept transfers from the specified country.
- verification_fields Country_spec_verification_fields -
stripe: Country_spec_verification_field_details
Fields
- additional Country_spec_verification_field_detailsAdditionalItemsString[] - Additional fields which are only required for some users.
- minimum Country_spec_verification_field_detailsMinimumItemsString[] - Fields which every account must eventually provide.
stripe: Country_spec_verification_fields
Fields
- company Country_spec_verification_field_details -
- individual Country_spec_verification_field_details -
stripe: CountrySpecList
Fields
- data Country_spec[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: Coupon
A coupon contains information about a percent-off or amount-off discount you might want to apply to a customer. Coupons may be applied to subscriptions, invoices, checkout sessions, quotes, and more. Coupons do not work with conventional one-off charges or payment intents.
Fields
- amount_off? int? - Amount (in the
currencyspecified) that will be taken off the subtotal of any invoices for this customer.
- applies_to? Coupon_applies_to -
- created int - Time at which the object was created. Measured in seconds since the Unix epoch.
- currency? string? - If
amount_offhas been set, the three-letter ISO code for the currency of the amount to take off.
- currency_options? record { Coupon_currency_option... } - Coupons defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
- duration "forever"|"once"|"repeating" - One of
forever,once, andrepeating. Describes how long a customer who applies this coupon will get the discount.
- duration_in_months? int? - If
durationisrepeating, the number of months the coupon applies. Null if coupondurationisforeveroronce.
- id string - Unique identifier for the object.
- livemode boolean - Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode.
- max_redemptions? int? - Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
- metadata? record { string... }? - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- name? string? - Name of the coupon displayed to customers on for instance invoices or receipts.
- 'object "coupon" - String representing the object's type. Objects of the same type share the same value.
- percent_off? decimal? - Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead.
- redeem_by? int? - Date after which the coupon can no longer be redeemed.
- times_redeemed int - Number of times this coupon has been applied to a customer.
- valid boolean - Taking account of the above properties, whether this coupon can still be applied to a customer.
stripe: Coupon_applies_to
Fields
- products Coupon_applies_toProductsItemsString[] - A list of product IDs this coupon applies to
stripe: Coupon_currency_option
Fields
- amount_off int - Amount (in the
currencyspecified) that will be taken off the subtotal of any invoices for this customer.
stripe: coupon_offer_param
Fields
- coupon string -
stripe: coupons_body
Closed record
Fields
- amount_off? int - A positive integer representing the amount to subtract from an invoice total (required if
percent_offis not passed).
- applies_to? applies_to_params -
- currency? string - Three-letter ISO code for the currency of the
amount_offparameter (required ifamount_offis passed).
- currency_options? record { currency_option_1... } - Coupons defined in each available currency option (only supported if
amount_offis passed). Each key must be a three-letter ISO currency code and a supported currency.
- duration? "forever"|"once"|"repeating" - Specifies how long the discount will be in effect if used on a subscription. Defaults to
once.
- duration_in_months? int - Required only if
durationisrepeating, in which case it must be a positive integer that specifies the number of months the discount will be in effect.
- expand? coupons_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- id? string - Unique string of your choice that will be used to identify this coupon when applying it to a customer. If you don't want to specify a particular code, you can leave the ID blank and we'll generate a random code for you.
- max_redemptions? int - A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use.
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- name? string - Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the
idis shown ifnameis not set.
- percent_off? decimal - A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if
amount_offis not passed).
- redeem_by? int - Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers.
stripe: coupons_coupon_body
Closed record
Fields
- currency_options? record { currency_option_1... } - Coupons defined in each available currency option (only supported if the coupon is amount-based). Each key must be a three-letter ISO currency code and a supported currency.
- expand? coupons_coupon_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- name? string - Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the
idis shown ifnameis not set.
stripe: CouponsResourceCouponList
Fields
- data Coupon[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: create_location_address_param
The full address of the location.
Fields
- city? string -
- country string -
- line1? string -
- line2? string -
- postal_code? string -
- state? string -
stripe: created_param
Fields
- gt? int -
- gte? int -
- lt? int -
- lte? int -
stripe: Credit_note
Issue a credit note to adjust an invoice's amount after the invoice is finalized.
Related guide: Credit notes
Fields
- amount int - The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax.
- amount_shipping int - This is the sum of all the shipping amounts.
- created int - Time at which the object was created. Measured in seconds since the Unix epoch.
- currency string - Three-letter ISO currency code, in lowercase. Must be a supported currency.
- customer string|Customer|Deleted_customer - ID of the customer.
- customer_balance_transaction? string|Customer_balance_transaction? - Customer balance transaction related to this credit note.
- discount_amount int - The integer amount in cents (or local equivalent) representing the total amount of discount that was credited.
- discount_amounts Discounts_resource_discount_amount[] - The aggregate amounts calculated per discount for all line items.
- effective_at? int? - The date when this credit note is in effect. Same as
createdunless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
- id string - Unique identifier for the object.
- lines CreditNoteLinesList_1 -
- livemode boolean - Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode.
- memo? string? - Customer-facing text that appears on the credit note PDF.
- metadata? record { string... }? - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- number string - A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.
- 'object "credit_note" - String representing the object's type. Objects of the same type share the same value.
- out_of_band_amount? int? - Amount that was credited outside of Stripe.
- pdf string - The link to download the PDF of the credit note.
- reason? "duplicate"|"fraudulent"|"order_change"|"product_unsatisfactory"? - Reason for issuing this credit note, one of
duplicate,fraudulent,order_change, orproduct_unsatisfactory
- shipping_cost? Invoices_resource_shipping_cost? - The details of the cost of shipping, including the ShippingRate applied to the invoice.
- status "issued"|"void" - Status of this credit note, one of
issuedorvoid. Learn more about voiding credit notes.
- subtotal int - The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.
- subtotal_excluding_tax? int? - The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts.
- tax_amounts Credit_note_tax_amount[] - The aggregate amounts calculated per tax rate for all line items.
- total int - The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.
- total_excluding_tax? int? - The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts.
- 'type "post_payment"|"pre_payment" - Type of this credit note, one of
pre_paymentorpost_payment. Apre_paymentcredit note means it was issued when the invoice was open. Apost_paymentcredit note means it was issued when the invoice was paid.
- voided_at? int? - The time that the credit note was voided.
stripe: Credit_note_line_item
The credit note line item object
Fields
- amount int - The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.
- amount_excluding_tax? int? - The integer amount in cents (or local equivalent) representing the amount being credited for this line item, excluding all tax and discounts.
- description? string? - Description of the item being credited.
- discount_amount int - The integer amount in cents (or local equivalent) representing the discount being credited for this line item.
- discount_amounts Discounts_resource_discount_amount[] - The amount of discount calculated per discount for this line item
- id string - Unique identifier for the object.
- invoice_line_item? string - ID of the invoice line item being credited
- livemode boolean - Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode.
- 'object "credit_note_line_item" - String representing the object's type. Objects of the same type share the same value.
- quantity? int? - The number of units of product being credited.
- tax_amounts Credit_note_tax_amount[] - The amount of tax calculated per tax rate for this line item
- tax_rates Tax_rate[] - The tax rates which apply to the line item.
- 'type "custom_line_item"|"invoice_line_item" - The type of the credit note line item, one of
invoice_line_itemorcustom_line_item. When the type isinvoice_line_itemthere is an additionalinvoice_line_itemproperty on the resource the value of which is the id of the credited line item on the invoice.
- unit_amount? int? - The cost of each unit of product being credited.
- unit_amount_decimal? string? - Same as
unit_amount, but contains a decimal value with at most 12 decimal places.
- unit_amount_excluding_tax? string? - The amount in cents (or local equivalent) representing the unit amount being credited for this line item, excluding all tax and discounts.
stripe: credit_note_line_item_params
Fields
- amount? int -
- description? string -
- invoice_line_item? string -
- quantity? int -
- tax_rates? TaxratesItemsString[]|"" -
- 'type "custom_line_item"|"invoice_line_item" -
- unit_amount? int -
- unit_amount_decimal? string -
stripe: credit_note_shipping_cost
When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.
Fields
- shipping_rate? string -
stripe: credit_note_shipping_cost_1
Fields
- shipping_rate? string -
stripe: credit_note_shipping_cost_2
Fields
- shipping_rate? string -
stripe: Credit_note_tax_amount
Fields
- amount int - The amount, in cents (or local equivalent), of the tax.
- inclusive boolean - Whether this tax amount is inclusive or exclusive.
- taxability_reason? "customer_exempt"|"not_collecting"|"not_subject_to_tax"|"not_supported"|"portion_product_exempt"|"portion_reduced_rated"|"portion_standard_rated"|"product_exempt"|"product_exempt_holiday"|"proportionally_rated"|"reduced_rated"|"reverse_charge"|"standard_rated"|"taxable_basis_reduced"|"zero_rated"? - The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
- taxable_amount? int? - The amount on which tax is calculated, in cents (or local equivalent).
stripe: credit_notes_body
Closed record
Fields
- amount? int - The integer amount in cents (or local equivalent) representing the total amount of the credit note.
- credit_amount? int - The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
- effective_at? int - The date when this credit note is in effect. Same as
createdunless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
- email_type? "credit_note"|"none" - Type of email to send to the customer, one of
credit_noteornoneand the default iscredit_note.
- expand? credit_notes_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- invoice string - ID of the invoice.
- lines? credit_note_line_item_params[] - Line items that make up the credit note.
- memo? string - The credit note's memo appears on the credit note PDF.
- metadata? record { string... } - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- out_of_band_amount? int - The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
- reason? "duplicate"|"fraudulent"|"order_change"|"product_unsatisfactory" - Reason for issuing this credit note, one of
duplicate,fraudulent,order_change, orproduct_unsatisfactory
- refund? string - ID of an existing refund to link this credit note to.
- refund_amount? int - The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
- shipping_cost? credit_note_shipping_cost -
stripe: credit_notes_id_body
Closed record
Fields
- expand? credit_notes_id_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- memo? string - Credit note memo.
- metadata? record { string... } - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
stripe: CreditNoteLinesList
Fields
- data Credit_note_line_item[] - Details about each object.
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: CreditNoteLinesList_1
Line items that make up the credit note
Fields
- data Credit_note_line_item[] - Details about each object.
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: CreditNotesList
Fields
- data Credit_note[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: Currency_option
Fields
- custom_unit_amount? Custom_unit_amount? - When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
- tax_behavior? "exclusive"|"inclusive"|"unspecified"? - Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of
inclusive,exclusive, orunspecified. Once specified as eitherinclusiveorexclusive, it cannot be changed.
- tiers? Price_tier[] - Each element represents a pricing tier. This parameter requires
billing_schemeto be set totiered. See also the documentation forbilling_scheme.
- unit_amount? int? - The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if
billing_scheme=per_unit.
- unit_amount_decimal? string? - The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if
billing_scheme=per_unit.
stripe: currency_option
Fields
- amount int -
- tax_behavior? "exclusive"|"inclusive"|"unspecified" -
stripe: currency_option_1
Fields
- amount_off int -
stripe: currency_option_2
Fields
- custom_unit_amount? custom_unit_amount -
- tax_behavior? "exclusive"|"inclusive"|"unspecified" -
- tiers? tier[] -
- unit_amount? int -
- unit_amount_decimal? string -
stripe: currency_option_3
Fields
- minimum_amount? int -
stripe: currency_option_update
Fields
- amount? int -
- tax_behavior? "exclusive"|"inclusive"|"unspecified" -
stripe: custom_field_dropdown_param
Fields
- default_value? string -
- options custom_field_option_param[] -
stripe: custom_field_dropdown_param_1
Fields
- options custom_field_option_param[] -
stripe: custom_field_label_param
Fields
- custom string -
- 'type "custom" -
stripe: custom_field_numeric_param
Fields
- default_value? string -
- maximum_length? int -
- minimum_length? int -
stripe: custom_field_numeric_param_1
Fields
- maximum_length? int -
- minimum_length? int -
stripe: custom_field_option_param
Fields
- label string -
- value string -
stripe: custom_field_param
Fields
- dropdown? custom_field_dropdown_param -
- 'key string -
- label custom_field_label_param -
- numeric? custom_field_numeric_param -
- optional? boolean -
- text? custom_field_text_param -
- 'type "dropdown"|"numeric"|"text" -
stripe: custom_field_param_1
Fields
- dropdown? custom_field_dropdown_param_1 -
- 'key string -
- label custom_field_label_param -
- numeric? custom_field_numeric_param_1 -
- optional? boolean -
- text? custom_field_text_param_1 -
- 'type "dropdown"|"numeric"|"text" -
stripe: custom_field_text_param
Fields
- default_value? string -
- maximum_length? int -
- minimum_length? int -
stripe: custom_field_text_param_1
Fields
- maximum_length? int -
- minimum_length? int -
stripe: custom_text_param
Display additional text for your customers using custom text.
Fields
- after_submit? record { message string }|"" -
- shipping_address? record { message string }|"" -
- submit? record { message string }|"" -
- terms_of_service_acceptance? record { message string }|"" -
stripe: custom_unit_amount
Fields
- enabled boolean -
- maximum? int -
- minimum? int -
- preset? int -
stripe: Custom_unit_amount
Fields
- maximum? int? - The maximum unit amount the customer can specify for this item.
- minimum? int? - The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
- preset? int? - The starting unit amount which can be updated by the customer.
stripe: custom_unit_amount_1
When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
Fields
- enabled boolean -
- maximum? int -
- minimum? int -
- preset? int -
stripe: Customer
This object represents a customer of your business. Use it to create recurring charges and track payments that belong to the same customer.
Related guide: Save a card during payment
Fields
- address? Address? - The customer's address.
- balance? int - The current balance, if any, that's stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize.
- cash_balance? Cash_balance? - The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is "cash_balance". The
settings[reconciliation_mode]field describes if these funds apply to these payment intents manually or automatically.
- created int - Time at which the object was created. Measured in seconds since the Unix epoch.
- currency? string? - Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.
- default_source? string|Bank_account|Card|Source? - ID of the default payment source for the customer. If you use payment methods created through the PaymentMethods API, see the invoice_settings.default_payment_method field instead.
- delinquent? boolean? - Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the
invoice.due_datewill set this field totrue. If an invoice becomes uncollectible by dunning,delinquentdoesn't reset tofalse. If you care whether the customer has paid their most recent subscription invoice, usesubscription.statusinstead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field tofalse.
- description? string? - An arbitrary string attached to the object. Often useful for displaying to users.
- discount? Discount? - Describes the current discount active on the customer, if there is one.
- email? string? - The customer's email address.
- id string - Unique identifier for the object.
- invoice_credit_balance? record { int... } - The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes.
- invoice_prefix? string? - The prefix for the customer used to generate unique invoice numbers.
- invoice_settings? Invoice_setting_customer_setting -
- livemode boolean - Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode.
- metadata? record { string... } - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- name? string? - The customer's full name or business name.
- next_invoice_sequence? int - The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses.
- 'object "customer" - String representing the object's type. Objects of the same type share the same value.
- phone? string? - The customer's phone number.
- preferred_locales? CustomerPreferredlocalesItemsString[]? - The customer's preferred locales (languages), ordered by preference.
- shipping? Shipping? - Mailing and shipping address for the customer. Appears on invoices emailed to this customer.
- sources? ApmsSourcesSourceList_1 -
- subscriptions? SubscriptionList_1 -
- tax? Customer_tax -
- tax_exempt? "exempt"|"none"|"reverse"? - Describes the customer's tax exemption status, which is
none,exempt, orreverse. When set toreverse, invoice and receipt PDFs include the following text: "Reverse charge".
- tax_ids? TaxIDsList_1 -
- test_clock? string|Test_helpers\.test_clock? - ID of the test clock that this customer belongs to.
stripe: Customer_acceptance
Fields
- accepted_at? int? - The time that the customer accepts the mandate.
- offline? Offline_acceptance -
- online? Online_acceptance -
- 'type "offline"|"online" - The mandate includes the type of customer acceptance information, such as:
onlineoroffline.
stripe: Customer_balance_customer_balance_settings
Fields
- reconciliation_mode "automatic"|"manual" - The configuration for how funds that land in the customer cash balance are reconciled.
- using_merchant_default boolean - A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance
stripe: Customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft
Fields
- balance_transaction string|Balance_transaction - The Balance Transaction that corresponds to funds taken out of your Stripe balance.
- linked_transaction string|Customer_cash_balance_transaction - The Cash Balance Transaction that brought the customer balance negative, triggering the clawback of funds.
stripe: Customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction
Fields
- payment_intent string|Payment_intent - The Payment Intent that funds were applied to.
stripe: Customer_balance_resource_cash_balance_transaction_resource_funded_transaction
Fields
stripe: Customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer
Fields
- reference? string? - The user-supplied reference field on the bank transfer.
- 'type "eu_bank_transfer"|"gb_bank_transfer"|"jp_bank_transfer"|"mx_bank_transfer"|"us_bank_transfer" - The funding method type used to fund the customer balance. Permitted values include:
eu_bank_transfer,gb_bank_transfer,jp_bank_transfer,mx_bank_transfer, orus_bank_transfer.
stripe: Customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transfer
Fields
- bic? string? - The BIC of the bank of the sender of the funding.
- iban_last4? string? - The last 4 digits of the IBAN of the sender of the funding.
- sender_name? string? - The full name of the sender, as supplied by the sending bank.
stripe: Customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_gb_bank_transfer
Fields
- account_number_last4? string? - The last 4 digits of the account number of the sender of the funding.
- sender_name? string? - The full name of the sender, as supplied by the sending bank.
- sort_code? string? - The sort code of the bank of the sender of the funding
stripe: Customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transfer
Fields
- sender_bank? string? - The name of the bank of the sender of the funding.
- sender_branch? string? - The name of the bank branch of the sender of the funding.
- sender_name? string? - The full name of the sender, as supplied by the sending bank.
stripe: Customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_us_bank_transfer
Fields
- network? "ach"|"domestic_wire_us"|"swift" - The banking network used for this funding.
- sender_name? string? - The full name of the sender, as supplied by the sending bank.
stripe: Customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction
Fields
stripe: Customer_balance_resource_cash_balance_transaction_resource_transferred_to_balance
Fields
- balance_transaction string|Balance_transaction - The Balance Transaction that corresponds to funds transferred to your Stripe balance.
stripe: Customer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction
Fields
- payment_intent string|Payment_intent - The Payment Intent that funds were unapplied from.
stripe: Customer_balance_transaction
Each customer has a Balance value,
which denotes a debit or credit that's automatically applied to their next invoice upon finalization.
You may modify the value directly by using the update customer API,
or by creating a Customer Balance Transaction, which increments or decrements the customer's balance by the specified amount.
Related guide: Customer balance
Fields
- amount int - The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's
balance.
- created int - Time at which the object was created. Measured in seconds since the Unix epoch.
- credit_note? string|Credit_note? - The ID of the credit note (if any) related to the transaction.
- currency string - Three-letter ISO currency code, in lowercase. Must be a supported currency.
- description? string? - An arbitrary string attached to the object. Often useful for displaying to users.
- ending_balance int - The customer's
balanceafter the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice.
- id string - Unique identifier for the object.
- livemode boolean - Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode.
- metadata? record { string... }? - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- 'object "customer_balance_transaction" - String representing the object's type. Objects of the same type share the same value.
- 'type "adjustment"|"applied_to_invoice"|"credit_note"|"initial"|"invoice_overpaid"|"invoice_too_large"|"invoice_too_small"|"migration"|"unapplied_from_invoice"|"unspent_receiver_credit" - Transaction type:
adjustment,applied_to_invoice,credit_note,initial,invoice_overpaid,invoice_too_large,invoice_too_small,unspent_receiver_credit, orunapplied_from_invoice. See the Customer Balance page to learn more about transaction types.
stripe: customer_balance_transactions_body
Closed record
Fields
- amount int - The integer amount in cents (or local equivalent) to apply to the customer's credit balance.
- currency string - Three-letter ISO currency code, in lowercase. Must be a supported currency. Specifies the
invoice_credit_balancethat this transaction will apply to. If the customer'scurrencyis not set, it will be updated to this value.
- description? string - An arbitrary string attached to the object. Often useful for displaying to users.
- expand? customer_balance_transactions_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
stripe: customer_bank_accounts_body
Closed record
Fields
- bank_account? record { account_holder_name string, account_holder_type "company"|"individual" , account_number string, country string, currency string, 'object "bank_account" , routing_number string }|string - Either a token, like the ones returned by Stripe.js, or a dictionary containing a user's bank account details.
- card? record { address_city string, address_country string, address_line1 string, address_line2 string, address_state string, address_zip string, cvc string, exp_month int, exp_year int, metadata record { string... }, name string, number string, 'object "card" }|string - A token, like the ones returned by Stripe.js.
- expand? customer_bank_accounts_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- metadata? record { string... } - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- 'source? string - Please refer to full documentation instead.
stripe: customer_cards_body
Closed record
Fields
- bank_account? record { account_holder_name string, account_holder_type "company"|"individual" , account_number string, country string, currency string, 'object "bank_account" , routing_number string }|string - Either a token, like the ones returned by Stripe.js, or a dictionary containing a user's bank account details.
- card? record { address_city string, address_country string, address_line1 string, address_line2 string, address_state string, address_zip string, cvc string, exp_month int, exp_year int, metadata record { string... }, name string, number string, 'object "card" }|string - A token, like the ones returned by Stripe.js.
- expand? customer_cards_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- metadata? record { string... } - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- 'source? string - Please refer to full documentation instead.
stripe: customer_cash_balance_body
Closed record
Fields
- expand? customer_cash_balance_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- settings? balance_settings_param_1 -
stripe: Customer_cash_balance_transaction
Customers with certain payments enabled have a cash balance, representing funds that were paid by the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions represent when funds are moved into or out of this balance. This includes funding by the customer, allocation to payments, and refunds to the customer.
Fields
- adjusted_for_overdraft? Customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft -
- created int - Time at which the object was created. Measured in seconds since the Unix epoch.
- currency string - Three-letter ISO currency code, in lowercase. Must be a supported currency.
- ending_balance int - The total available cash balance for the specified currency after this transaction was applied. Represented in the smallest currency unit.
- id string - Unique identifier for the object.
- livemode boolean - Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode.
- net_amount int - The amount by which the cash balance changed, represented in the smallest currency unit. A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance.
- 'object "customer_cash_balance_transaction" - String representing the object's type. Objects of the same type share the same value.
- refunded_from_payment? Customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction -
- transferred_to_balance? Customer_balance_resource_cash_balance_transaction_resource_transferred_to_balance -
- 'type "adjusted_for_overdraft"|"applied_to_payment"|"funded"|"funding_reversed"|"refunded_from_payment"|"return_canceled"|"return_initiated"|"transferred_to_balance"|"unapplied_from_payment" - The type of the cash balance transaction. New types may be added in future. See Customer Balance to learn more about these types.
- unapplied_from_payment? Customer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction -
stripe: customer_details
Details about the customer, including address and tax IDs.
Fields
- address? postal_address -
- address_source? "billing"|"shipping" -
- ip_address? string -
- tax_ids? data_params[] -
- taxability_override? "customer_exempt"|"none"|"reverse_charge" -
stripe: customer_details_param
Details about the customer you want to invoice or overrides for an existing customer. If automatic_tax is enabled then one of customer, customer_details, subscription, or schedule must be set.
Fields
- tax? tax_param_1 -
- tax_exempt? ""|"exempt"|"none"|"reverse" -
- tax_ids? data_params[] -
stripe: customer_details_param_1
Fields
- tax? tax_param_1 -
- tax_exempt? ""|"exempt"|"none"|"reverse" -
- tax_ids? data_params[] -
stripe: customer_details_param_2
Fields
- tax? tax_param_1 -
- tax_exempt? ""|"exempt"|"none"|"reverse" -
- tax_ids? data_params[] -
stripe: customer_details_params
Fields
- email string -
stripe: customer_fund_cash_balance_body
Closed record
Fields
- amount int - Amount to be used for this test cash balance transaction. A positive integer representing how much to fund in the smallest currency unit (e.g., 100 cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency).
- currency string - Three-letter ISO currency code, in lowercase. Must be a supported currency.
- expand? customer_fund_cash_balance_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- reference? string - A description of the test funding. This simulates free-text references supplied by customers when making bank transfers to their cash balance. You can use this to test how Stripe's reconciliation algorithm applies to different user inputs.
stripe: customer_funding_instructions_body
Closed record
Fields
- bank_transfer bank_transfer_params -
- currency string - Three-letter ISO currency code, in lowercase. Must be a supported currency.
- expand? customer_funding_instructions_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- funding_type "bank_transfer" - The
funding_typeto get the instructions for.
stripe: customer_mapping_param
Fields that specify how to map a meter event to a customer.
Fields
- event_payload_key string -
- 'type "by_id" -
stripe: customer_param
Default invoice settings for this customer.
Fields
- default_payment_method? string -
- rendering_options? record { amount_tax_display ""|"exclude_tax"|"include_inclusive_tax" }|"" -
stripe: Customer_session
A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access control over a Customer.
Fields
- client_secret string - The client secret of this Customer Session. Used on the client to set up secure access to the given
customer. The client secret can be used to provide access tocustomerfrom your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret.
- components? Customer_session_resource_components -
- created int - Time at which the object was created. Measured in seconds since the Unix epoch.
- expires_at int - The timestamp at which this Customer Session will expire.
- livemode boolean - Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode.
- 'object "customer_session" - String representing the object's type. Objects of the same type share the same value.
stripe: Customer_session_resource_components
Configuration for the components supported by this Customer Session.
Fields
- payment_element Customer_session_resource_components_resource_payment_element -
- pricing_table Customer_session_resource_components_resource_pricing_table -
stripe: Customer_session_resource_components_resource_buy_button
This hash contains whether the buy button is enabled.
Fields
- enabled boolean - Whether the buy button is enabled.
stripe: Customer_session_resource_components_resource_payment_element
This hash contains whether the Payment Element is enabled and the features it supports.
Fields
- enabled boolean - Whether the Payment Element is enabled.
- features? Customer_session_resource_components_resource_payment_element_resource_features? - This hash defines whether the Payment Element supports certain features.
stripe: Customer_session_resource_components_resource_payment_element_resource_features
This hash contains the features the Payment Element supports.
Fields
- payment_method_allow_redisplay_filters ("always"|"limited"|"unspecified")[] - A list of
allow_redisplayvalues that controls which saved payment methods the Payment Element displays by filtering to only show payment methods with anallow_redisplayvalue that is present in this list. If not specified, defaults to ["always"]. In order to display all saved payment methods, specify ["always", "limited", "unspecified"].
- payment_method_redisplay "disabled"|"enabled" - Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to
disabled.
- payment_method_redisplay_limit? int? - Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to
10.
- payment_method_remove "disabled"|"enabled" - Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to
disabled. Allowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches thecustomerobject from that PaymentMethod.
- payment_method_save "disabled"|"enabled" - Controls whether the Payment Element displays a checkbox offering to save a new payment method. This parameter defaults to
disabled. If a customer checks the box, theallow_redisplayvalue on the PaymentMethod is set to'always'at confirmation time. For PaymentIntents, thesetup_future_usagevalue is also set to the value defined inpayment_method_save_usage.
- payment_method_save_usage? "off_session"|"on_session"? - When using PaymentIntents and the customer checks the save checkbox, this field determines the
setup_future_usagevalue used to confirm the PaymentIntent. When using SetupIntents, directly configure theusagevalue on SetupIntent creation.
stripe: Customer_session_resource_components_resource_pricing_table
This hash contains whether the pricing table is enabled.
Fields
- enabled boolean - Whether the pricing table is enabled.
stripe: customer_sessions_body
Closed record
Fields
- components components -
- customer string - The ID of an existing customer for which to create the Customer Session.
- expand? customer_sessions_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: customer_sources_body
Closed record
Fields
- bank_account? record { account_holder_name string, account_holder_type "company"|"individual" , account_number string, country string, currency string, 'object "bank_account" , routing_number string }|string - Either a token, like the ones returned by Stripe.js, or a dictionary containing a user's bank account details.
- card? record { address_city string, address_country string, address_line1 string, address_line2 string, address_state string, address_zip string, cvc string, exp_month int, exp_year int, metadata record { string... }, name string, number string, 'object "card" }|string - A token, like the ones returned by Stripe.js.
- expand? customer_sources_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- metadata? record { string... } - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- 'source? string - Please refer to full documentation instead.
stripe: customer_subscriptions_body
Closed record
Fields
- add_invoice_items? add_invoice_item_entry[] - A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
- application_fee_percent? decimal|"" - A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees documentation.
- automatic_tax? automatic_tax_config -
- backdate_start_date? int - For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
- billing_cycle_anchor? int - A future timestamp in UTC format to anchor the subscription's billing cycle. The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for
weekintervals, the day of month formonthandyearintervals, and the month of year foryearintervals.
- cancel_at? int - A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using
proration_behavior. If set during a future period, this will always cause a proration for that period.
- cancel_at_period_end? boolean - Boolean indicating whether this subscription should cancel at the end of the current period.
- collection_method? "charge_automatically"|"send_invoice" - Either
charge_automatically, orsend_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription asactive. Defaults tocharge_automatically.
- coupon? string - The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use
discountsinstead.
- currency? string - Three-letter ISO currency code, in lowercase. Must be a supported currency.
- days_until_due? int - Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where
collection_methodis set tosend_invoice.
- default_payment_method? string - ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over
default_source. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
- default_source? string - ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If
default_payment_methodis also set,default_payment_methodwill take precedence. If neither are set, invoices will use the customer's invoice_settings.default_payment_method or default_source.
- default_tax_rates? DefaulttaxratesItemsString[]|"" - The tax rates that will apply to any subscription item that does not have
tax_ratesset. Invoices created will have theirdefault_tax_ratespopulated from the subscription.
- expand? customer_subscriptions_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- invoice_settings? invoice_settings_param -
- items? subscription_item_create_params[] - A list of up to 20 subscription items, each with an attached price.
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- off_session? boolean - Indicates if a customer is on or off-session while an invoice payment is attempted.
- payment_behavior? "allow_incomplete"|"default_incomplete"|"error_if_incomplete"|"pending_if_incomplete" - Only applies to subscriptions with
collection_method=charge_automatically. Useallow_incompleteto create Subscriptions withstatus=incompleteif the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration Guide for Billing to learn more. This is the default behavior. Usedefault_incompleteto create Subscriptions withstatus=incompletewhen the first invoice requires payment, otherwise start as active. Subscriptions transition tostatus=activewhen successfully confirming the PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer actions are needed to pay a subscription’s invoice, such as failed payments, SCA regulation, or collecting a mandate for a bank debit payment method. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition tostatus=incomplete_expired, which is a terminal state. Useerror_if_incompleteif you want Stripe to return an HTTP 402 status code if a subscription's first invoice can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't create a Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the changelog to learn more.pending_if_incompleteis only used with updates and cannot be passed when creating a Subscription. Subscriptions withcollection_method=send_invoiceare automatically activated regardless of the first Invoice status.
- payment_settings? payment_settings -
- pending_invoice_item_interval? record { interval "day"|"month"|"week"|"year" , interval_count int }|"" - Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.
- promotion_code? string - The ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use
discountsinstead.
- proration_behavior? "always_invoice"|"create_prorations"|"none" - Determines how to handle prorations resulting from the
billing_cycle_anchor. If no value is passed, the default iscreate_prorations.
- transfer_data? transfer_data_specs_3 -
- trial_end? "now"|int - Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value
nowcan be provided to end the customer's trial immediately. Can be at most two years frombilling_cycle_anchor. See Using trial periods on subscriptions to learn more.
- trial_from_plan? boolean - Indicates if a plan's
trial_period_daysshould be applied to the subscription. Settingtrial_endper subscription is preferred, and this defaults tofalse. Setting this flag totruetogether withtrial_endis not allowed. See Using trial periods on subscriptions to learn more.
- trial_period_days? int - Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See Using trial periods on subscriptions to learn more.
- trial_settings? trial_settings_config_1 -
stripe: Customer_tax
Fields
- automatic_tax "failed"|"not_collecting"|"supported"|"unrecognized_location" - Surfaces if automatic tax computation is possible given the current customer location information.
- ip_address? string? - A recent IP address of the customer used for tax reporting and tax location inference.
- location? Customer_tax_location? - The customer's location as identified by Stripe Tax.
stripe: customer_tax_ids_body
Closed record
Fields
- expand? customer_tax_ids_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'type "ad_nrt"|"ae_trn"|"ar_cuit"|"au_abn"|"au_arn"|"bg_uic"|"bh_vat"|"bo_tin"|"br_cnpj"|"br_cpf"|"ca_bn"|"ca_gst_hst"|"ca_pst_bc"|"ca_pst_mb"|"ca_pst_sk"|"ca_qst"|"ch_uid"|"ch_vat"|"cl_tin"|"cn_tin"|"co_nit"|"cr_tin"|"de_stn"|"do_rcn"|"ec_ruc"|"eg_tin"|"es_cif"|"eu_oss_vat"|"eu_vat"|"gb_vat"|"ge_vat"|"hk_br"|"hu_tin"|"id_npwp"|"il_vat"|"in_gst"|"is_vat"|"jp_cn"|"jp_rn"|"jp_trn"|"ke_pin"|"kr_brn"|"kz_bin"|"li_uid"|"mx_rfc"|"my_frp"|"my_itn"|"my_sst"|"ng_tin"|"no_vat"|"no_voec"|"nz_gst"|"om_vat"|"pe_ruc"|"ph_tin"|"ro_tin"|"rs_pib"|"ru_inn"|"ru_kpp"|"sa_vat"|"sg_gst"|"sg_uen"|"si_tin"|"sv_nit"|"th_vat"|"tr_tin"|"tw_vat"|"ua_vat"|"us_ein"|"uy_ruc"|"ve_rif"|"vn_tin"|"za_vat" - Type of the tax ID, one of
ad_nrt,ae_trn,ar_cuit,au_abn,au_arn,bg_uic,bh_vat,bo_tin,br_cnpj,br_cpf,ca_bn,ca_gst_hst,ca_pst_bc,ca_pst_mb,ca_pst_sk,ca_qst,ch_uid,ch_vat,cl_tin,cn_tin,co_nit,cr_tin,de_stn,do_rcn,ec_ruc,eg_tin,es_cif,eu_oss_vat,eu_vat,gb_vat,ge_vat,hk_br,hu_tin,id_npwp,il_vat,in_gst,is_vat,jp_cn,jp_rn,jp_trn,ke_pin,kr_brn,kz_bin,li_uid,mx_rfc,my_frp,my_itn,my_sst,ng_tin,no_vat,no_voec,nz_gst,om_vat,pe_ruc,ph_tin,ro_tin,rs_pib,ru_inn,ru_kpp,sa_vat,sg_gst,sg_uen,si_tin,sv_nit,th_vat,tr_tin,tw_vat,ua_vat,us_ein,uy_ruc,ve_rif,vn_tin, orza_vat
- value string - Value of the tax ID.
stripe: Customer_tax_location
Fields
- country string - The customer's country as identified by Stripe Tax.
- 'source "billing_address"|"ip_address"|"payment_method"|"shipping_destination" - The data source used to infer the customer's location.
- state? string? - The customer's state, county, province, or region as identified by Stripe Tax.
stripe: customer_update_creation_param
Fields
- allowed_updates? ("address"|"email"|"name"|"phone"|"shipping"|"tax_id")[]|"" -
- enabled boolean -
stripe: customer_update_params
Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when customer is provided.
Fields
- address? "auto"|"never" -
- name? "auto"|"never" -
- shipping? "auto"|"never" -
stripe: customer_update_updating_param
Fields
- allowed_updates? ("address"|"email"|"name"|"phone"|"shipping"|"tax_id")[]|"" -
- enabled? boolean -
stripe: CustomerBalanceTransactionList
Fields
- data Customer_balance_transaction[] - Details about each object.
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: CustomerCashBalanceTransactionList
Customers with certain payments enabled have a cash balance, representing funds that were paid by the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions represent when funds are moved into or out of this balance. This includes funding by the customer, allocation to payments, and refunds to the customer.
Fields
- data Customer_cash_balance_transaction[] - Details about each object.
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: CustomerPaymentMethodResourceList
Fields
- data Payment_method[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: CustomerResourceCustomerList
Fields
- data Customer[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: customers_body
Closed record
Fields
- balance? int - An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.
- cash_balance? cash_balance_param -
- coupon? string -
- description? string - An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.
- email? string - Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to 512 characters.
- expand? customers_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- invoice_prefix? string - The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.
- invoice_settings? customer_param -
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- name? string - The customer's full name or business name.
- next_invoice_sequence? int - The sequence to be used on the customer's next invoice. Defaults to 1.
- payment_method? string -
- phone? string - The customer's phone number.
- preferred_locales? customers_bodyPreferredlocalesItemsString[] - Customer's preferred languages, ordered by preference.
- promotion_code? string - The ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount.
- 'source? string -
- tax? tax_param -
- tax_exempt? ""|"exempt"|"none"|"reverse" - The customer's tax exemption. One of
none,exempt, orreverse.
- tax_id_data? data_params[] - The customer's tax IDs.
- test_clock? string - ID of the test clock to attach to the customer.
stripe: customers_customer_body
Closed record
Fields
- balance? int - An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.
- bank_account? record { account_holder_name string, account_holder_type "company"|"individual" , account_number string, country string, currency string, 'object "bank_account" , routing_number string }|string - Either a token, like the ones returned by Stripe.js, or a dictionary containing a user's bank account details.
- card? record { address_city string, address_country string, address_line1 string, address_line2 string, address_state string, address_zip string, cvc string, exp_month int, exp_year int, metadata record { string... }, name string, number string, 'object "card" }|string - A token, like the ones returned by Stripe.js.
- cash_balance? cash_balance_param -
- coupon? string -
- default_alipay_account? string - ID of Alipay account to make the customer's new default for invoice payments.
- default_bank_account? string - ID of bank account to make the customer's new default for invoice payments.
- default_card? string - ID of card to make the customer's new default for invoice payments.
- default_source? string - If you are using payment methods created via the PaymentMethods API, see the invoice_settings.default_payment_method parameter. Provide the ID of a payment source already attached to this customer to make it this customer's default payment source. If you want to add a new payment source and make it the default, see the source property.
- description? string - An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.
- email? string - Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to 512 characters.
- expand? customers_customer_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- invoice_prefix? string - The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.
- invoice_settings? customer_param -
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- name? string - The customer's full name or business name.
- next_invoice_sequence? int - The sequence to be used on the customer's next invoice. Defaults to 1.
- phone? string - The customer's phone number.
- preferred_locales? customers_customer_bodyPreferredlocalesItemsString[] - Customer's preferred languages, ordered by preference.
- promotion_code? string - The ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount.
- 'source? string -
- tax? tax_param -
- tax_exempt? ""|"exempt"|"none"|"reverse" - The customer's tax exemption. One of
none,exempt, orreverse.
stripe: CustomfieldsItemsObject
Fields
- name string -
- value string -
stripe: customs_param
Fields
- eori_number? string -
stripe: cvc_params
The updated CVC value this token represents.
Fields
- cvc string -
stripe: data_params
Fields
- 'type "ad_nrt"|"ae_trn"|"ar_cuit"|"au_abn"|"au_arn"|"bg_uic"|"bh_vat"|"bo_tin"|"br_cnpj"|"br_cpf"|"ca_bn"|"ca_gst_hst"|"ca_pst_bc"|"ca_pst_mb"|"ca_pst_sk"|"ca_qst"|"ch_uid"|"ch_vat"|"cl_tin"|"cn_tin"|"co_nit"|"cr_tin"|"de_stn"|"do_rcn"|"ec_ruc"|"eg_tin"|"es_cif"|"eu_oss_vat"|"eu_vat"|"gb_vat"|"ge_vat"|"hk_br"|"hu_tin"|"id_npwp"|"il_vat"|"in_gst"|"is_vat"|"jp_cn"|"jp_rn"|"jp_trn"|"ke_pin"|"kr_brn"|"kz_bin"|"li_uid"|"mx_rfc"|"my_frp"|"my_itn"|"my_sst"|"ng_tin"|"no_vat"|"no_voec"|"nz_gst"|"om_vat"|"pe_ruc"|"ph_tin"|"ro_tin"|"rs_pib"|"ru_inn"|"ru_kpp"|"sa_vat"|"sg_gst"|"sg_uen"|"si_tin"|"sv_nit"|"th_vat"|"tr_tin"|"tw_vat"|"ua_vat"|"us_ein"|"uy_ruc"|"ve_rif"|"vn_tin"|"za_vat" -
- value string -
stripe: date_of_birth
Fields
- day int -
- month int -
- year int -
stripe: date_of_birth_specs
Fields
- day int -
- month int -
- year int -
stripe: decline_charge_on_specs
Fields
- avs_failure? boolean -
- cvc_failure? boolean -
stripe: default
Fields
- 'type "standard" -
stripe: default_settings_params
Object representing the subscription schedule's default settings.
Fields
- application_fee_percent? decimal -
- automatic_tax? automatic_tax_config_3 -
- billing_cycle_anchor? "automatic"|"phase_start" -
- collection_method? "charge_automatically"|"send_invoice" -
- default_payment_method? string -
- description? string|"" -
- invoice_settings? subscription_schedule_default_settings_param -
- on_behalf_of? string|"" -
stripe: defaults_param
Default configuration to be used on Stripe Tax calculations.
Fields
- tax_behavior? "exclusive"|"inclusive"|"inferred_by_currency" -
- tax_code? string -
stripe: Deleted_account
Fields
- deleted true - Always true for a deleted object
- id string - Unique identifier for the object.
- 'object "account" - String representing the object's type. Objects of the same type share the same value.
stripe: Deleted_apple_pay_domain
Fields
- deleted true - Always true for a deleted object
- id string - Unique identifier for the object.
- 'object "apple_pay_domain" - String representing the object's type. Objects of the same type share the same value.
stripe: Deleted_application
Fields
- deleted true - Always true for a deleted object
- id string - Unique identifier for the object.
- name? string? - The name of the application.
- 'object "application" - String representing the object's type. Objects of the same type share the same value.
stripe: Deleted_bank_account
Fields
- currency? string? - Three-letter ISO code for the currency paid out to the bank account.
- deleted true - Always true for a deleted object
- id string - Unique identifier for the object.
- 'object "bank_account" - String representing the object's type. Objects of the same type share the same value.
stripe: Deleted_card
Fields
- currency? string? - Three-letter ISO code for the currency paid out to the bank account.
- deleted true - Always true for a deleted object
- id string - Unique identifier for the object.
- 'object "card" - String representing the object's type. Objects of the same type share the same value.
stripe: Deleted_coupon
Fields
- deleted true - Always true for a deleted object
- id string - Unique identifier for the object.
- 'object "coupon" - String representing the object's type. Objects of the same type share the same value.
stripe: Deleted_customer
Fields
- deleted true - Always true for a deleted object
- id string - Unique identifier for the object.
- 'object "customer" - String representing the object's type. Objects of the same type share the same value.
stripe: Deleted_discount
Fields
- checkout_session? string? - The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.
- coupon Coupon -
- customer? string|Customer|Deleted_customer? - The ID of the customer associated with this discount.
- deleted true - Always true for a deleted object
- id string - The ID of the discount object. Discounts cannot be fetched by ID. Use
expand[]=discountsin API calls to expand discount IDs in an array.
- invoice? string? - The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.
- invoice_item? string? - The invoice item
id(or invoice line itemidfor invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.
- 'object "discount" - String representing the object's type. Objects of the same type share the same value.
- promotion_code? string|Promotion_code? - The promotion code applied to create this discount.
- 'start int - Date that the coupon was applied.
- subscription? string? - The subscription that this coupon is applied to, if it is applied to a particular subscription.
- subscription_item? string? - The subscription item that this coupon is applied to, if it is applied to a particular subscription item.
stripe: Deleted_invoice
Fields
- deleted true - Always true for a deleted object
- id string - Unique identifier for the object.
- 'object "invoice" - String representing the object's type. Objects of the same type share the same value.
stripe: Deleted_invoiceitem
Fields
- deleted true - Always true for a deleted object
- id string - Unique identifier for the object.
- 'object "invoiceitem" - String representing the object's type. Objects of the same type share the same value.
stripe: Deleted_person
Fields
- deleted true - Always true for a deleted object
- id string - Unique identifier for the object.
- 'object "person" - String representing the object's type. Objects of the same type share the same value.
stripe: Deleted_plan
Fields
- deleted true - Always true for a deleted object
- id string - Unique identifier for the object.
- 'object "plan" - String representing the object's type. Objects of the same type share the same value.
stripe: Deleted_price
Fields
- deleted true - Always true for a deleted object
- id string - Unique identifier for the object.
- 'object "price" - String representing the object's type. Objects of the same type share the same value.
stripe: Deleted_product
Fields
- deleted true - Always true for a deleted object
- id string - Unique identifier for the object.
- 'object "product" - String representing the object's type. Objects of the same type share the same value.
stripe: Deleted_product_feature
Fields
- deleted true - Always true for a deleted object
- id string - Unique identifier for the object.
- 'object "product_feature" - String representing the object's type. Objects of the same type share the same value.
stripe: Deleted_radar\.value_list
Fields
- deleted true -
- id string -
- 'object "radar.value_list" -
stripe: Deleted_radar\.value_list_item
Fields
- deleted true -
- id string -
- 'object "radar.value_list_item" -
stripe: Deleted_subscription_item
Fields
- deleted true - Always true for a deleted object
- id string - Unique identifier for the object.
- 'object "subscription_item" - String representing the object's type. Objects of the same type share the same value.
stripe: Deleted_tax_id
Fields
- deleted true - Always true for a deleted object
- id string - Unique identifier for the object.
- 'object "tax_id" - String representing the object's type. Objects of the same type share the same value.
stripe: Deleted_terminal\.configuration
Fields
- deleted true -
- id string -
- 'object "terminal.configuration" -
stripe: Deleted_terminal\.location
Fields
- deleted true -
- id string -
- 'object "terminal.location" -
stripe: Deleted_terminal\.reader
Fields
- deleted true -
- id string -
- 'object "terminal.reader" -
stripe: Deleted_test_helpers\.test_clock
Fields
- deleted true -
- id string -
- 'object "test_helpers.test_clock" -
stripe: Deleted_webhook_endpoint
Fields
- deleted true - Always true for a deleted object
- id string - Unique identifier for the object.
- 'object "webhook_endpoint" - String representing the object's type. Objects of the same type share the same value.
stripe: delivery_estimate
Fields
- maximum? delivery_estimate_bound -
- minimum? delivery_estimate_bound -
stripe: delivery_estimate_1
The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
Fields
- maximum? delivery_estimate_bound -
- minimum? delivery_estimate_bound -
stripe: delivery_estimate_bound
Fields
- unit "business_day"|"day"|"hour"|"month"|"week" -
- value int -
stripe: Destination_details_unimplemented
stripe: Discount
A discount represents the actual application of a coupon or promotion code. It contains information about when the discount began, when it will end, and what it is applied to.
Related guide: Applying discounts to subscriptions
Fields
- checkout_session? string? - The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.
- coupon Coupon -
- customer? string|Customer|Deleted_customer? - The ID of the customer associated with this discount.
- end? int? - If the coupon has a duration of
repeating, the date that this discount will end. If the coupon has a duration ofonceorforever, this attribute will be null.
- id string - The ID of the discount object. Discounts cannot be fetched by ID. Use
expand[]=discountsin API calls to expand discount IDs in an array.
- invoice? string? - The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.
- invoice_item? string? - The invoice item
id(or invoice line itemidfor invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.
- 'object "discount" - String representing the object's type. Objects of the same type share the same value.
- promotion_code? string|Promotion_code? - The promotion code applied to create this discount.
- 'start int - Date that the coupon was applied.
- subscription? string? - The subscription that this coupon is applied to, if it is applied to a particular subscription.
- subscription_item? string? - The subscription item that this coupon is applied to, if it is applied to a particular subscription item.
stripe: discount_params
Fields
- coupon? string -
- promotion_code? string -
stripe: Discounts1ItemsObject
Fields
- coupon? string -
- discount? string -
- promotion_code? string -
stripe: discounts_data_param
Fields
- coupon? string -
- discount? string -
- promotion_code? string -
stripe: Discounts_resource_discount_amount
Fields
- amount int - The amount, in cents (or local equivalent), of the discount.
- discount string|Discount|Deleted_discount - The discount that was applied to get this discount amount.
stripe: Discounts_resource_stackable_discount
Fields
- promotion_code? string|Promotion_code? - ID of the promotion code to create a new discount for.
stripe: DiscountsItemsObject
Fields
- coupon? string -
- discount? string -
- promotion_code? string -
stripe: display_preference_param
Fields
- preference? "none"|"off"|"on" -
stripe: Dispute
A dispute occurs when a customer questions your charge with their card issuer. When this happens, you have the opportunity to respond to the dispute with evidence that shows that the charge is legitimate.
Related guide: Disputes and fraud
Fields
- amount int - Disputed amount. Usually the amount of the charge, but it can differ (usually because of currency fluctuation or because only part of the order is disputed).
- balance_transactions Balance_transaction[] - List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute.
- created int - Time at which the object was created. Measured in seconds since the Unix epoch.
- currency string - Three-letter ISO currency code, in lowercase. Must be a supported currency.
- evidence Dispute_evidence -
- evidence_details Dispute_evidence_details -
- id string - Unique identifier for the object.
- is_charge_refundable boolean - If true, it's still possible to refund the disputed payment. After the payment has been fully refunded, no further funds are withdrawn from your Stripe account as a result of this dispute.
- livemode boolean - Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode.
- metadata record { string... } - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- 'object "dispute" - String representing the object's type. Objects of the same type share the same value.
- payment_intent? string|Payment_intent? - ID of the PaymentIntent that's disputed.
- payment_method_details? Dispute_payment_method_details -
- reason string - Reason given by cardholder for dispute. Possible values are
bank_cannot_process,check_returned,credit_not_processed,customer_initiated,debit_not_authorized,duplicate,fraudulent,general,incorrect_account_details,insufficient_funds,product_not_received,product_unacceptable,subscription_canceled, orunrecognized. Learn more about dispute reasons.
- status "lost"|"needs_response"|"under_review"|"warning_closed"|"warning_needs_response"|"warning_under_review"|"won" - Current status of dispute. Possible values are
warning_needs_response,warning_under_review,warning_closed,needs_response,under_review,won, orlost.
stripe: dispute_close_body
Closed record
Fields
- expand? dispute_close_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: dispute_close_body_1
Closed record
Fields
- expand? dispute_close_body_1ExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: Dispute_evidence
Fields
- access_activity_log? string? - Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity.
- billing_address? string? - The billing address provided by the customer.
- cancellation_policy? string|File? - (ID of a file upload) Your subscription cancellation policy, as shown to the customer.
- cancellation_policy_disclosure? string? - An explanation of how and when the customer was shown your refund policy prior to purchase.
- cancellation_rebuttal? string? - A justification for why the customer's subscription was not canceled.
- customer_communication? string|File? - (ID of a file upload) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service.
- customer_email_address? string? - The email address of the customer.
- customer_name? string? - The name of the customer.
- customer_purchase_ip? string? - The IP address that the customer used when making the purchase.
- customer_signature? string|File? - (ID of a file upload) A relevant document or contract showing the customer's signature.
- duplicate_charge_documentation? string|File? - (ID of a file upload) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate.
- duplicate_charge_explanation? string? - An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate.
- duplicate_charge_id? string? - The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge.
- product_description? string? - A description of the product or service that was sold.
- receipt? string|File? - (ID of a file upload) Any receipt or message sent to the customer notifying them of the charge.
- refund_policy? string|File? - (ID of a file upload) Your refund policy, as shown to the customer.
- refund_policy_disclosure? string? - Documentation demonstrating that the customer was shown your refund policy prior to purchase.
- refund_refusal_explanation? string? - A justification for why the customer is not entitled to a refund.
- service_date? string? - The date on which the customer received or began receiving the purchased service, in a clear human-readable format.
- service_documentation? string|File? - (ID of a file upload) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement.
- shipping_address? string? - The address to which a physical product was shipped. You should try to include as complete address information as possible.
- shipping_carrier? string? - The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas.
- shipping_date? string? - The date on which a physical product began its route to the shipping address, in a clear human-readable format.
- shipping_documentation? string|File? - (ID of a file upload) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer's full shipping address, if possible.
- shipping_tracking_number? string? - The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
- uncategorized_file? string|File? - (ID of a file upload) Any additional evidence or statements.
- uncategorized_text? string? - Any additional evidence or statements.
stripe: Dispute_evidence_details
Fields
- due_by? int? - Date by which evidence must be submitted in order to successfully challenge dispute. Will be 0 if the customer's bank or credit card company doesn't allow a response for this particular dispute.
- has_evidence boolean - Whether evidence has been staged for this dispute.
- past_due boolean - Whether the last evidence submission was submitted past the due date. Defaults to
falseif no evidence submissions have occurred. Iftrue, then delivery of the latest evidence is not guaranteed.
- submission_count int - The number of times evidence has been submitted. Typically, you may only submit evidence once.
stripe: dispute_evidence_params
Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000.
Fields
- access_activity_log? string -
- billing_address? string -
- cancellation_policy? string -
- cancellation_policy_disclosure? string -
- cancellation_rebuttal? string -
- customer_communication? string -
- customer_email_address? string -
- customer_name? string -
- customer_purchase_ip? string -
- customer_signature? string -
- duplicate_charge_documentation? string -
- duplicate_charge_explanation? string -
- duplicate_charge_id? string -
- product_description? string -
- receipt? string -
- refund_policy? string -
- refund_policy_disclosure? string -
- refund_refusal_explanation? string -
- service_date? string -
- service_documentation? string -
- shipping_address? string -
- shipping_carrier? string -
- shipping_date? string -
- shipping_documentation? string -
- shipping_tracking_number? string -
- uncategorized_file? string -
- uncategorized_text? string -
stripe: Dispute_payment_method_details
Fields
- klarna? Dispute_payment_method_details_klarna -
- paypal? Dispute_payment_method_details_paypal -
- 'type "card"|"klarna"|"paypal" - Payment method type.
stripe: Dispute_payment_method_details_card
Fields
- brand string - Card brand. Can be
amex,diners,discover,eftpos_au,jcb,mastercard,unionpay,visa, orunknown.
- network_reason_code? string? - The card network's specific dispute reason code, which maps to one of Stripe's primary dispute categories to simplify response guidance. The Network code map lists all available dispute reason codes by network.
stripe: Dispute_payment_method_details_klarna
Fields
- reason_code? string? - The reason for the dispute as defined by Klarna
stripe: Dispute_payment_method_details_paypal
Fields
- case_id? string? - The ID of the dispute in PayPal.
- reason_code? string? - The reason for the dispute as defined by PayPal
stripe: dispute_submit_body
Closed record
Fields
- expand? dispute_submit_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
stripe: DisputeList
Fields
- data Dispute[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: disputes_dispute_body
Closed record
Fields
- evidence? dispute_evidence_params -
- expand? disputes_dispute_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- submit? boolean - Whether to immediately submit evidence to the bank. If
false, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set totrue(the default).
stripe: disputes_dispute_body_1
Closed record
Fields
- amount? int - The dispute amount in the card's currency and in the smallest currency unit.
- evidence? evidence_param -
- expand? disputes_dispute_body_1ExpandItemsString[] - Specifies which fields in the response should be expanded.
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
stripe: documents_param
Fields
- files? documents_paramFilesItemsString[] -
stripe: documents_param_1
Fields
- files? (string|"")[] -
stripe: documents_specs
Documents that may be submitted to satisfy various informational requests.
Fields
- bank_account_ownership_verification? documents_param -
- company_license? documents_param -
- company_memorandum_of_association? documents_param -
- company_ministerial_decree? documents_param -
- company_registration_verification? documents_param -
- company_tax_id_verification? documents_param -
- proof_of_registration? documents_param -
stripe: dropdownOptionsItemsObject
Fields
- label string -
- value string -
stripe: Email_sent
Fields
- email_sent_at int - The timestamp when the email was sent.
- email_sent_to string - The recipient's email address.
stripe: encrypted_pin_param
The desired PIN for this card.
Fields
- encrypted_number? string -
stripe: encrypted_pin_param_1
The desired new PIN for this card.
Fields
- encrypted_number? string -
stripe: end_behavior
Fields
- missing_payment_method "cancel"|"create_invoice"|"pause" -
stripe: end_user_details_params
End user details.
Fields
- ip_address? string -
- present boolean -
stripe: Entitlements\.active_entitlement
Fields
- feature string|Entitlements\.feature -
- id string -
- livemode boolean -
- lookup_key string -
- 'object "entitlements.active_entitlement" -
stripe: Entitlements\.feature
Fields
- active boolean -
- id string -
- livemode boolean -
- lookup_key string -
- metadata record { string... } -
- name string -
- 'object "entitlements.feature" -
stripe: entitlements_features_body
Closed record
Fields
- expand? entitlements_features_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- lookup_key string - A unique key you provide as your own system identifier. This may be up to 80 characters.
- metadata? record { string... } - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- name string - The feature's name, for your own purpose, not meant to be displayable to the customer.
stripe: EntitlementsResourceCustomerEntitlementList
Fields
- data Entitlements\.active_entitlement[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: EntitlementsResourceFeatureList
Fields
- data Entitlements\.feature[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: EntitlementsResourceProductFeatureList
Fields
- data Product_feature[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: Ephemeral_key
Fields
- created int - Time at which the object was created. Measured in seconds since the Unix epoch.
- expires int - Time at which the key will expire. Measured in seconds since the Unix epoch.
- id string - Unique identifier for the object.
- livemode boolean - Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode.
- 'object "ephemeral_key" - String representing the object's type. Objects of the same type share the same value.
- secret? string - The key's secret. You can use this value to make authorized requests to the Stripe API.
stripe: ephemeral_keys_body
Closed record
Fields
- customer? string - The ID of the Customer you'd like to modify using the resulting ephemeral key.
- expand? ephemeral_keys_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- issuing_card? string - The ID of the Issuing Card you'd like to access using the resulting ephemeral key.
- nonce? string - A single-use token, created by Stripe.js, used for creating ephemeral keys for Issuing Cards without exchanging sensitive information.
- verification_session? string - The ID of the Identity VerificationSession you'd like to access using the resulting ephemeral key
stripe: ephemeral_keys_key_body
Closed record
Fields
- expand? ephemeral_keys_key_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: eu_bank_account_params
Fields
- country string -
stripe: eu_bank_transfer_params
Fields
- country string -
stripe: europe
Fields
- standard? standard -
- 'type "ioss"|"oss_non_union"|"oss_union"|"standard" -
stripe: Event
Events are our way of letting you know when something interesting happens in
your account. When an interesting event occurs, we create a new Event
object. For example, when a charge succeeds, we create a charge.succeeded
event, and when an invoice payment attempt fails, we create an
invoice.payment_failed event. Certain API requests might create multiple
events. For example, if you create a new subscription for a
customer, you receive both a customer.subscription.created event and a
charge.succeeded event.
Events occur when the state of another API resource changes. The event's data
field embeds the resource's state at the time of the change. For
example, a charge.succeeded event contains a charge, and an
invoice.payment_failed event contains an invoice.
As with other API resources, you can use endpoints to retrieve an
individual event or a list of events
from the API. We also have a separate
webhooks system for sending the
Event objects directly to an endpoint on your server. You can manage
webhooks in your
account settings. Learn how
to listen for events
so that your integration can automatically trigger reactions.
When using Connect, you can also receive event notifications
that occur in connected accounts. For these events, there's an
additional account attribute in the received Event object.
We only guarantee access to events through the Retrieve Event API for 30 days.
Fields
- account? string - The connected account that originates the event.
- api_version? string? - The Stripe API version used to render
data. This property is populated only for events on or after October 31, 2014.
- created int - Time at which the object was created. Measured in seconds since the Unix epoch.
- data Notification_event_data -
- id string - Unique identifier for the object.
- livemode boolean - Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode.
- 'object "event" - String representing the object's type. Objects of the same type share the same value.
- pending_webhooks int - Number of webhooks that haven't been successfully delivered (for example, to return a 20x response) to the URLs you specify.
- request? Notification_event_request? - Information on the API request that triggers the event.
- 'type string - Description of the event (for example,
invoice.createdorcharge.refunded).
stripe: event_adjustment_cancel_settings_param
Specifies which event to cancel.
Fields
- identifier? string -
stripe: evidence_param
Evidence provided for the dispute.
Fields
- canceled? record { additional_documentation string|"" , canceled_at int|"" , cancellation_policy_provided boolean|"" , cancellation_reason string|"" , expected_at int|"" , explanation string|"" , product_description string|"" , product_type ""|"merchandise"|"service" , return_status ""|"merchant_rejected"|"successful" , returned_at int|"" }|"" -
- reason? "canceled"|"duplicate"|"fraudulent"|"merchandise_not_as_described"|"no_valid_authorization"|"not_received"|"other"|"service_not_as_described" -
stripe: Exchange_rate
ExchangeRate objects allow you to determine the rates that Stripe is currently
using to convert from one currency to another. Since this number is variable
throughout the day, there are various reasons why you might want to know the current
rate (for example, to dynamically price an item for a user with a default
payment in a foreign currency).
Please refer to our Exchange Rates API guide for more details.
[Note: this integration path is supported but no longer recommended] Additionally, you can guarantee that a charge is made with an exchange rate that you expect is current. To do so, you must pass in the exchange_rate to charges endpoints. If the value is no longer up to date, the charge won't go through. Please refer to our Using with charges guide for more details.
This Exchange Rates API is a Beta Service and is subject to Stripe's terms of service. You may use the API solely for the purpose of transacting on Stripe. For example, the API may be queried in order to:
- localize prices for processing payments on Stripe
- reconcile Stripe transactions
- determine how much money to send to a connected account
- determine app fees to charge a connected account
Using this Exchange Rates API beta for any purpose other than to transact on Stripe is strictly prohibited and constitutes a violation of Stripe's terms of service.
Fields
- id string - Unique identifier for the object. Represented as the three-letter ISO currency code in lowercase.
- 'object "exchange_rate" - String representing the object's type. Objects of the same type share the same value.
- rates record {||} - Hash where the keys are supported currencies and the values are the exchange rate at which the base id currency converts to the key currency.
stripe: ExchangeRateList
Fields
- data Exchange_rate[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: external_account_documents_param
Documents that may be submitted to satisfy various informational requests.
Fields
- bank_account_ownership_verification? documents_param -
stripe: External_account_requirements
Fields
- currently_due? External_account_requirementsCurrentlydueItemsString[]? - Fields that need to be collected to keep the external account enabled. If not collected by
current_deadline, these fields appear inpast_dueas well, and the account is disabled.
- errors? Account_requirements_error[]? - Fields that are
currently_dueand need to be collected again because validation or verification failed.
- past_due? External_account_requirementsPastdueItemsString[]? - Fields that weren't collected by
current_deadline. These fields need to be collected to enable the external account.
- pending_verification? External_account_requirementsPendingverificationItemsString[]? - Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to
eventually_due,currently_due, orpast_due. Fields might appear ineventually_due,currently_due, orpast_dueand inpending_verificationif verification fails but another verification is still pending.
stripe: external_accounts_id_body
Closed record
Fields
- account_holder_name? string - The name of the person or business that owns the bank account.
- account_holder_type? ""|"company"|"individual" - The type of entity that holds the account. This can be either
individualorcompany.
- account_type? "checking"|"futsu"|"savings"|"toza" - The bank account type. This can only be
checkingorsavingsin most countries. In Japan, this can only befutsuortoza.
- address_city? string - City/District/Suburb/Town/Village.
- address_country? string - Billing address country, if provided when creating card.
- address_line1? string - Address line 1 (Street address/PO Box/Company name).
- address_line2? string - Address line 2 (Apartment/Suite/Unit/Building).
- address_state? string - State/County/Province/Region.
- address_zip? string - ZIP or postal code.
- default_for_currency? boolean - When set to true, this becomes the default external account for its currency.
- documents? external_account_documents_param -
- exp_month? string - Two digit number representing the card’s expiration month.
- exp_year? string - Four digit number representing the card’s expiration year.
- expand? external_accounts_id_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- name? string - Cardholder name.
stripe: ExternalAccountList
Fields
- data (Bank_account|Card)[] - The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: ExternalAccountList_1
External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests where controller[is_controller] is true.
Fields
- data (Bank_account|Card)[] - The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: failure_details_params
Details about a failed InboundTransfer.
Fields
- code? "account_closed"|"account_frozen"|"bank_account_restricted"|"bank_ownership_changed"|"debit_not_authorized"|"incorrect_account_holder_address"|"incorrect_account_holder_name"|"incorrect_account_holder_tax_id"|"insufficient_funds"|"invalid_account_number"|"invalid_currency"|"no_account"|"other" -
stripe: feature_access
Encodes whether a FinancialAccount has access to a particular feature. Stripe or the platform can control features via the requested field.
Fields
- card_issuing? access -
- deposit_insurance? access -
- financial_addresses? financial_addresses -
- inbound_transfers? inbound_transfers -
- intra_stripe_flows? access -
- outbound_payments? outbound_payments -
- outbound_transfers? outbound_transfers -
stripe: feature_access_1
Encodes whether a FinancialAccount has access to a particular feature, with a status enum and associated status_details. Stripe or the platform may control features via the requested field.
Fields
- card_issuing? access -
- deposit_insurance? access -
- financial_addresses? financial_addresses -
- inbound_transfers? inbound_transfers -
- intra_stripe_flows? access -
- outbound_payments? outbound_payments -
- outbound_transfers? outbound_transfers -
stripe: features
Fields
- name string -
stripe: features_creation_param
Information about the features available in the portal.
Fields
- customer_update? customer_update_creation_param -
- invoice_history? invoice_list_param -
- payment_method_update? payment_method_update_param -
- subscription_cancel? subscription_cancel_creation_param -
- subscription_update? subscription_update_creation_param -
stripe: features_id_body
Closed record
Fields
- active? boolean - Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
- expand? features_id_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- name? string - The feature's name, for your own purpose, not meant to be displayable to the customer.
stripe: features_param
Fields
- payment_method_allow_redisplay_filters? ("always"|"limited"|"unspecified")[] -
- payment_method_redisplay? "disabled"|"enabled" -
- payment_method_redisplay_limit? int -
- payment_method_remove? "disabled"|"enabled" -
- payment_method_save? "disabled"|"enabled" -
- payment_method_save_usage? "off_session"|"on_session" -
stripe: features_updating_param
Information about the features available in the portal.
Fields
- customer_update? customer_update_updating_param -
- invoice_history? invoice_list_param -
- payment_method_update? payment_method_update_param -
- subscription_cancel? subscription_cancel_updating_param -
- subscription_update? subscription_update_updating_param -
stripe: Fee
Fields
- amount int - Amount of the fee, in cents.
- application? string? - ID of the Connect application that earned the fee.
- currency string - Three-letter ISO currency code, in lowercase. Must be a supported currency.
- description? string? - An arbitrary string attached to the object. Often useful for displaying to users.
- 'type string - Type of the fee, one of:
application_fee,payment_method_passthrough_fee,stripe_feeortax.
stripe: Fee_refund
Application Fee Refund objects allow you to refund an application fee that
has previously been created but not yet refunded. Funds will be refunded to
the Stripe account from which the fee was originally collected.
Related guide: Refunding application fees
Fields
- amount int - Amount, in cents (or local equivalent).
- balance_transaction? string|Balance_transaction? - Balance transaction that describes the impact on your account balance.
- created int - Time at which the object was created. Measured in seconds since the Unix epoch.
- currency string - Three-letter ISO currency code, in lowercase. Must be a supported currency.
- fee string|Application_fee - ID of the application fee that was refunded.
- id string - Unique identifier for the object.
- metadata? record { string... }? - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- 'object "fee_refund" - String representing the object's type. Objects of the same type share the same value.
stripe: FeeRefundList
Fields
- data Fee_refund[] - Details about each object.
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: FeeRefundList_1
A list of refunds that have been applied to the fee.
Fields
- data Fee_refund[] - Details about each object.
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: File
This object represents files hosted on Stripe's servers. You can upload files with the create file request (for example, when uploading dispute evidence). Stripe also creates files independently (for example, the results of a Sigma scheduled query).
Related guide: File upload guide
Fields
- created int - Time at which the object was created. Measured in seconds since the Unix epoch.
- expires_at? int? - The file expires and isn't available at this time in epoch seconds.
- filename? string? - The suitable name for saving the file to a filesystem.
- id string - Unique identifier for the object.
- links? FileResourceFileLinkList_1? -
- 'object "file" - String representing the object's type. Objects of the same type share the same value.
- purpose "account_requirement"|"additional_verification"|"business_icon"|"business_logo"|"customer_signature"|"dispute_evidence"|"document_provider_identity_document"|"finance_report_run"|"identity_document"|"identity_document_downloadable"|"pci_document"|"selfie"|"sigma_scheduled_query"|"tax_document_user_upload"|"terminal_reader_splashscreen" - The purpose of the uploaded file.
- size int - The size of the file object in bytes.
- title? string? - A suitable title for the document.
- 'type? string? - The returned file type (for example,
csv,pdf,jpg, orpng).
- url? string? - Use your live secret API key to download the file from this URL.
stripe: File_link
To share the contents of a File object with non-Stripe users, you can
create a FileLink. FileLinks contain a URL that you can use to
retrieve the contents of the file without authentication.
Fields
- created int - Time at which the object was created. Measured in seconds since the Unix epoch.
- expired boolean - Returns if the link is already expired.
- expires_at? int? - Time that the link expires.
- id string - Unique identifier for the object.
- livemode boolean - Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode.
- metadata record { string... } - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- 'object "file_link" - String representing the object's type. Objects of the same type share the same value.
- url? string? - The publicly accessible URL to download the file.
stripe: file_link_creation_params
Optional parameters that automatically create a file link for the newly created file.
Fields
- create boolean -
- expires_at? int -
- metadata? record { string... }|"" -
stripe: file_links_body
Closed record
Fields
- expand? file_links_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- expires_at? int - The link isn't usable after this future timestamp.
- file string - The ID of the file. The file's
purposemust be one of the following:business_icon,business_logo,customer_signature,dispute_evidence,finance_report_run,identity_document_downloadable,pci_document,selfie,sigma_scheduled_query,tax_document_user_upload, orterminal_reader_splashscreen.
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
stripe: file_links_link_body
Closed record
Fields
- expand? file_links_link_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- expires_at? "now"|int|"" - A future timestamp after which the link will no longer be usable, or
nowto expire the link immediately.
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
stripe: FileResourceFileLinkList
Fields
- data File_link[] - Details about each object.
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: FileResourceFileLinkList_1
A list of file links that point at this file.
Fields
- data File_link[] - Details about each object.
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: FileResourceFileList
Fields
- data File[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: files_body
Closed record
Fields
- expand? files_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- file record { fileContent byte[], fileName string } - A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the
multipart/form-dataprotocol.
- file_link_data? file_link_creation_params -
- purpose "account_requirement"|"additional_verification"|"business_icon"|"business_logo"|"customer_signature"|"dispute_evidence"|"identity_document"|"pci_document"|"tax_document_user_upload"|"terminal_reader_splashscreen" - The purpose of the uploaded file.
stripe: filters_params
Filters to restrict the kinds of accounts to collect.
Fields
- account_subcategories? ("checking"|"credit_card"|"line_of_credit"|"mortgage"|"savings")[] -
- countries? filters_paramsCountriesItemsString[] -
stripe: financial_account_features_body
Closed record
Fields
- card_issuing? access_1 -
- deposit_insurance? access_2 -
- expand? financial_account_features_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- financial_addresses? financial_addresses_1 -
- inbound_transfers? inbound_transfers_1 -
- intra_stripe_flows? access_3 -
- outbound_payments? outbound_payments_1 -
- outbound_transfers? outbound_transfers_1 -
stripe: financial_accounts_financial_account_body
Closed record
Fields
- expand? financial_accounts_financial_account_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- features? feature_access_1 -
- metadata? record { string... } - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- platform_restrictions? platform_restrictions -
stripe: financial_addresses
Fields
- aba? aba_access -
stripe: financial_addresses_1
Contains Features that add FinancialAddresses to the FinancialAccount.
Fields
- aba? aba_access -
stripe: Financial_connections\.account
Fields
- account_holder? Bank_connections_resource_accountholder? -
- balance? Bank_connections_resource_balance? -
- balance_refresh? Bank_connections_resource_balance_refresh? -
- category "cash"|"credit"|"investment"|"other" -
- created int -
- display_name? string? -
- id string -
- institution_name string -
- last4? string? -
- livemode boolean -
- 'object "financial_connections.account" -
- ownership? string|Financial_connections\.account_ownership? -
- ownership_refresh? Bank_connections_resource_ownership_refresh? -
- permissions? ("balances"|"ownership"|"payment_method"|"transactions")[]? -
- status "active"|"disconnected"|"inactive" -
- subcategory "checking"|"credit_card"|"line_of_credit"|"mortgage"|"other"|"savings" -
- subscriptions? ("transactions")[]? -
- supported_payment_method_types ("link"|"us_bank_account")[] -
- transaction_refresh? Bank_connections_resource_transaction_refresh? -
stripe: Financial_connections\.account_owner
Fields
- email? string? -
- id string -
- name string -
- 'object "financial_connections.account_owner" -
- ownership string -
- phone? string? -
- raw_address? string? -
- refreshed_at? int? -
stripe: Financial_connections\.account_ownership
Fields
- created int -
- id string -
- 'object "financial_connections.account_ownership" -
- owners BankConnectionsResourceOwnerList_1 -
stripe: Financial_connections\.session
Fields
- account_holder? Bank_connections_resource_accountholder? -
- accounts BankConnectionsResourceLinkedAccountList_1 -
- client_secret string -
- id string -
- livemode boolean -
- 'object "financial_connections.session" -
- permissions ("balances"|"ownership"|"payment_method"|"transactions")[] -
- prefetch? ("balances"|"ownership"|"transactions")[]? -
- return_url? string -
stripe: Financial_connections\.transaction
Fields
- account string -
- amount int -
- currency string -
- description string -
- id string -
- livemode boolean -
- 'object "financial_connections.transaction" -
- status "pending"|"posted"|"void" -
- status_transitions Bank_connections_resource_transaction_resource_status_transitions -
- transacted_at int -
- transaction_refresh string -
- updated int -
stripe: financial_connections_sessions_body
Closed record
Fields
- account_holder accountholder_params_1 -
- expand? financial_connections_sessions_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- filters? filters_params -
- permissions (financial_connections_sessions_bodyPermissionsItemsString)[] - List of data features that you would like to request access to.
Possible values are
balances,transactions,ownership, andpayment_method.
- prefetch? ("balances"|"ownership"|"transactions")[] - List of data features that you would like to retrieve upon account creation.
- return_url? string - For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
stripe: Financial_reporting_finance_report_run_run_parameters
Fields
- columns? Financial_reporting_finance_report_run_run_parametersColumnsItemsString[] - The set of output columns requested for inclusion in the report run.
- connected_account? string - Connected account ID by which to filter the report run.
- currency? string - Currency of objects to be included in the report run.
- interval_end? int - Ending timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after the user specified
interval_startand 1 second before this report's lastdata_available_endvalue.
- interval_start? int - Starting timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after this report's
data_available_startand 1 second before the user specifiedinterval_endvalue.
- payout? string - Payout ID by which to filter the report run.
- reporting_category? string - Category of balance transactions to be included in the report run.
- timezone? string - Defaults to
Etc/UTC. The output timezone for all timestamps in the report. A list of possible time zone values is maintained at the IANA Time Zone Database. Has no effect oninterval_startorinterval_end.
stripe: FinancialReportingFinanceReportRunList
Fields
- data Reporting\.report_run[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: FinancialReportingFinanceReportTypeList
Fields
- data Reporting\.report_type[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: fixed_amount
Fields
- amount int -
- currency string -
- currency_options? record { currency_option... } -
stripe: fixed_amount_1
Describes a fixed amount to charge for shipping. Must be present if type is fixed_amount.
Fields
- amount int -
- currency string -
- currency_options? record { currency_option... } -
stripe: fixed_amount_update
Describes a fixed amount to charge for shipping. Must be present if type is fixed_amount.
Fields
- currency_options? record { currency_option_update... } -
stripe: fleet_cardholder_prompt_data_specs
Fields
- driver_id? string -
- odometer? int -
- unspecified_id? string -
- user_id? string -
- vehicle_number? string -
stripe: fleet_reported_breakdown_fuel_specs
Fields
- gross_amount_decimal? string -
stripe: fleet_reported_breakdown_non_fuel_specs
Fields
- gross_amount_decimal? string -
stripe: fleet_reported_breakdown_specs
Fields
- non_fuel? fleet_reported_breakdown_non_fuel_specs -
stripe: fleet_reported_breakdown_tax_specs
Fields
- local_amount_decimal? string -
- national_amount_decimal? string -
stripe: fleet_specs
Fleet-specific information for authorizations using Fleet cards.
Fields
- cardholder_prompt_data? fleet_cardholder_prompt_data_specs -
- purchase_type? "fuel_and_non_fuel_purchase"|"fuel_purchase"|"non_fuel_purchase" -
- reported_breakdown? fleet_reported_breakdown_specs -
- service_type? "full_service"|"non_fuel_transaction"|"self_service" -
stripe: fleet_specs_1
Fields
- cardholder_prompt_data? fleet_cardholder_prompt_data_specs -
- purchase_type? "fuel_and_non_fuel_purchase"|"fuel_purchase"|"non_fuel_purchase" -
- reported_breakdown? fleet_reported_breakdown_specs -
- service_type? "full_service"|"non_fuel_transaction"|"self_service" -
stripe: flight_segment_specs
Fields
- arrival_airport_code? string -
- carrier? string -
- departure_airport_code? string -
- flight_number? string -
- service_class? string -
- stopover_allowed? boolean -
stripe: flight_specs
Fields
- departure_at? int -
- passenger_name? string -
- refundable? boolean -
- segments? flight_segment_specs[] -
- travel_agency? string -
stripe: flow_data_after_completion_param
Fields
- hosted_confirmation? after_completion_hosted_confirmation_param -
- redirect? after_completion_redirect_param -
- 'type "hosted_confirmation"|"portal_homepage"|"redirect" -
stripe: flow_data_param
Information about a specific flow for the customer to go through. See the docs to learn more about using customer portal deep links and flows.
Fields
- after_completion? flow_data_after_completion_param -
- subscription_cancel? flow_data_subscription_cancel_param -
- subscription_update? flow_data_subscription_update_param -
- subscription_update_confirm? flow_data_subscription_update_confirm_param -
- 'type "payment_method_update"|"subscription_cancel"|"subscription_update"|"subscription_update_confirm" -
stripe: flow_data_subscription_cancel_param
Fields
- retention? retention_param -
- subscription string -
stripe: flow_data_subscription_update_confirm_param
Fields
- discounts? subscription_update_confirm_discount_params[] -
- items subscription_update_confirm_item_params[] -
- subscription string -
stripe: flow_data_subscription_update_param
Fields
- subscription string -
stripe: Forwarded_request_context
Metadata about the forwarded request.
Fields
- destination_duration int - The time it took in milliseconds for the destination endpoint to respond.
- destination_ip_address string - The IP address of the destination.
stripe: Forwarded_request_details
Details about the request forwarded to the destination endpoint.
Fields
- body string - The body payload to send to the destination endpoint.
- headers Forwarded_request_header[] - The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included.
- http_method "POST" - The HTTP method used to call the destination endpoint.
stripe: Forwarded_request_header
Header data.
Fields
- name string - The header name.
- value string - The header value.
stripe: Forwarded_response_details
Details about the response from the destination endpoint.
Fields
- body string - The response body from the destination endpoint to Stripe.
- headers Forwarded_request_header[] - HTTP headers that the destination endpoint returned.
- status int - The HTTP status code that the destination endpoint returned.
stripe: Forwarding\.request
Fields
- created int -
- id string -
- livemode boolean -
- 'object "forwarding.request" -
- payment_method string -
- replacements ("card_cvc"|"card_expiry"|"card_number"|"cardholder_name")[] -
- request_context? Forwarded_request_context? -
- request_details? Forwarded_request_details? -
- response_details? Forwarded_response_details? -
- url? string? -
stripe: forwarding_requests_body
Closed record
Fields
- expand? forwarding_requests_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- payment_method string - The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.
- replacements ("card_cvc"|"card_expiry"|"card_number"|"cardholder_name")[] - The field kinds to be replaced in the forwarded request.
- request? request_param -
- url string - The destination URL for the forwarded request. Must be supported by the config.
stripe: ForwardingRequestList
List of ForwardingRequest data.
Fields
- data Forwarding\.request[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: fraud_details
A set of key-value pairs you can attach to a charge giving information about its riskiness. If you believe a charge is fraudulent, include a user_report key with a value of fraudulent. If you believe a charge is safe, include a user_report key with a value of safe. Stripe will use the information you send to improve our fraud detection algorithms.
Fields
- user_report ""|"fraudulent"|"safe" -
stripe: from_invoice
Revise an existing invoice. The new invoice will be created in status=draft. See the revision documentation for more details.
Fields
- action "revision" -
- invoice string -
stripe: from_quote_params
Clone an existing quote. The new quote will be created in status=draft. When using this parameter, you cannot specify any other parameters except for expires_at.
Fields
- is_revision? boolean -
- quote string -
stripe: fuel_specs
Information about fuel that was purchased with this transaction.
Fields
- industry_product_code? string -
- quantity_decimal? string -
- 'type? "diesel"|"other"|"unleaded_plus"|"unleaded_regular"|"unleaded_super" -
- unit? "charging_minute"|"imperial_gallon"|"kilogram"|"kilowatt_hour"|"liter"|"other"|"pound"|"us_gallon" -
- unit_cost_decimal? string -
stripe: fuel_specs_1
Fields
- industry_product_code? string -
- quantity_decimal? string -
- 'type? "diesel"|"other"|"unleaded_plus"|"unleaded_regular"|"unleaded_super" -
- unit? "charging_minute"|"imperial_gallon"|"kilogram"|"kilowatt_hour"|"liter"|"other"|"pound"|"us_gallon" -
- unit_cost_decimal? string -
stripe: Funding_instructions
Each customer has a balance that is
automatically applied to future invoices and payments using the customer_balance payment method.
Customers can fund this balance by initiating a bank transfer to any account in the
financial_addresses field.
Related guide: Customer balance funding instructions
Fields
- bank_transfer Funding_instructions_bank_transfer -
- currency string - Three-letter ISO currency code, in lowercase. Must be a supported currency.
- funding_type "bank_transfer" - The
funding_typeof the returned instructions
- livemode boolean - Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode.
- 'object "funding_instructions" - String representing the object's type. Objects of the same type share the same value.
stripe: Funding_instructions_bank_transfer
Fields
- country string - The country of the bank account to fund
- financial_addresses Funding_instructions_bank_transfer_financial_address[] - A list of financial addresses that can be used to fund a particular balance
- 'type "eu_bank_transfer"|"jp_bank_transfer" - The bank_transfer type
stripe: Funding_instructions_bank_transfer_aba_record
ABA Records contain U.S. bank account details per the ABA format.
Fields
- account_number string - The ABA account number
- bank_name string - The bank name
- routing_number string - The ABA routing number
stripe: Funding_instructions_bank_transfer_financial_address
FinancialAddresses contain identifying information that resolves to a FinancialAccount.
Fields
- sort_code? Funding_instructions_bank_transfer_sort_code_record -
- supported_networks? ("ach"|"bacs"|"domestic_wire_us"|"fps"|"sepa"|"spei"|"swift"|"zengin")[] - The payment networks supported by this FinancialAddress
- 'type "aba"|"iban"|"sort_code"|"spei"|"swift"|"zengin" - The type of financial address
stripe: Funding_instructions_bank_transfer_iban_record
Iban Records contain E.U. bank account details per the SEPA format.
Fields
- account_holder_name string - The name of the person or business that owns the bank account
- bic string - The BIC/SWIFT code of the account.
- country string - Two-letter country code (ISO 3166-1 alpha-2).
- iban string - The IBAN of the account.
stripe: Funding_instructions_bank_transfer_sort_code_record
Sort Code Records contain U.K. bank account details per the sort code format.
Fields
- account_holder_name string - The name of the person or business that owns the bank account
- account_number string - The account number
- sort_code string - The six-digit sort code
stripe: Funding_instructions_bank_transfer_spei_record
SPEI Records contain Mexico bank account details per the SPEI format.
Fields
- bank_code string - The three-digit bank code
- bank_name string - The short banking institution name
- clabe string - The CLABE number
stripe: Funding_instructions_bank_transfer_swift_record
SWIFT Records contain U.S. bank account details per the SWIFT format.
Fields
- account_number string - The account number
- bank_name string - The bank name
- swift_code string - The SWIFT code
stripe: Funding_instructions_bank_transfer_zengin_record
Zengin Records contain Japan bank account details per the Zengin format.
Fields
- account_holder_name? string? - The account holder name
- account_number? string? - The account number
- account_type? string? - The bank account type. In Japan, this can only be
futsuortoza.
- bank_code? string? - The bank code of the account
- bank_name? string? - The bank name of the account
- branch_code? string? - The branch code of the account
- branch_name? string? - The branch name of the account
stripe: Gelato_data_document_report_date_of_birth
Point in Time
Fields
- day? int? - Numerical day between 1 and 31.
- month? int? - Numerical month between 1 and 12.
- year? int? - The four-digit year.
stripe: Gelato_data_document_report_expiration_date
Point in Time
Fields
- day? int? - Numerical day between 1 and 31.
- month? int? - Numerical month between 1 and 12.
- year? int? - The four-digit year.
stripe: Gelato_data_document_report_issued_date
Point in Time
Fields
- day? int? - Numerical day between 1 and 31.
- month? int? - Numerical month between 1 and 12.
- year? int? - The four-digit year.
stripe: Gelato_data_id_number_report_date
Point in Time
Fields
- day? int? - Numerical day between 1 and 31.
- month? int? - Numerical month between 1 and 12.
- year? int? - The four-digit year.
stripe: Gelato_data_verified_outputs_date
Point in Time
Fields
- day? int? - Numerical day between 1 and 31.
- month? int? - Numerical month between 1 and 12.
- year? int? - The four-digit year.
stripe: Gelato_document_report
Result from a document check
Fields
- address? Address? - Address as it appears in the document.
- dob? Gelato_data_document_report_date_of_birth? - Date of birth as it appears in the document.
- 'error? Gelato_document_report_error? - Details on the verification error. Present when status is
unverified.
- expiration_date? Gelato_data_document_report_expiration_date? - Expiration date of the document.
- files? Gelato_document_reportFilesItemsString[]? - Array of File ids containing images for this document.
- first_name? string? - First name as it appears in the document.
- issued_date? Gelato_data_document_report_issued_date? - Issued date of the document.
- issuing_country? string? - Issuing country of the document.
- last_name? string? - Last name as it appears in the document.
- number? string? - Document ID number.
- status "unverified"|"verified" - Status of this
documentcheck.
- 'type? "driving_license"|"id_card"|"passport"? - Type of the document.
stripe: Gelato_document_report_error
Fields
- code? "document_expired"|"document_type_not_supported"|"document_unverified_other"? - A short machine-readable string giving the reason for the verification failure.
- reason? string? - A human-readable message giving the reason for the failure. These messages can be shown to your users.
stripe: Gelato_email_report
Result from a email check
Fields
- email? string? - Email to be verified.
- 'error? Gelato_email_report_error? - Details on the verification error. Present when status is
unverified.
- status "unverified"|"verified" - Status of this
emailcheck.
stripe: Gelato_email_report_error
Fields
- code? "email_unverified_other"|"email_verification_declined"? - A short machine-readable string giving the reason for the verification failure.
- reason? string? - A human-readable message giving the reason for the failure. These messages can be shown to your users.
stripe: Gelato_id_number_report
Result from an id_number check
Fields
- dob? Gelato_data_id_number_report_date? - Date of birth.
- 'error? Gelato_id_number_report_error? - Details on the verification error. Present when status is
unverified.
- first_name? string? - First name.
- id_number? string? - ID number. When
id_number_typeisus_ssn, only the last 4 digits are present.
- id_number_type? "br_cpf"|"sg_nric"|"us_ssn"? - Type of ID number.
- last_name? string? - Last name.
- status "unverified"|"verified" - Status of this
id_numbercheck.
stripe: Gelato_id_number_report_error
Fields
- code? "id_number_insufficient_document_data"|"id_number_mismatch"|"id_number_unverified_other"? - A short machine-readable string giving the reason for the verification failure.
- reason? string? - A human-readable message giving the reason for the failure. These messages can be shown to your users.
stripe: Gelato_phone_report
Result from a phone check
Fields
- 'error? Gelato_phone_report_error? - Details on the verification error. Present when status is
unverified.
- phone? string? - Phone to be verified.
- status "unverified"|"verified" - Status of this
phonecheck.
stripe: Gelato_phone_report_error
Fields
- code? "phone_unverified_other"|"phone_verification_declined"? - A short machine-readable string giving the reason for the verification failure.
- reason? string? - A human-readable message giving the reason for the failure. These messages can be shown to your users.
stripe: Gelato_provided_details
Fields
- email? string - Email of user being verified
- phone? string - Phone number of user being verified
stripe: Gelato_report_document_options
Fields
- allowed_types? ("driving_license"|"id_card"|"passport")[] - Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
- require_id_number? boolean - Collect an ID number and perform an ID number check with the document’s extracted name and date of birth.
- require_live_capture? boolean - Disable image uploads, identity document images have to be captured using the device’s camera.
- require_matching_selfie? boolean - Capture a face image and perform a selfie check comparing a photo ID and a picture of your user’s face. Learn more.
stripe: Gelato_report_id_number_options
stripe: Gelato_selfie_report
Result from a selfie check
Fields
- 'error? Gelato_selfie_report_error? - Details on the verification error. Present when status is
unverified.
- status "unverified"|"verified" - Status of this
selfiecheck.
stripe: Gelato_selfie_report_error
Fields
- code? "selfie_document_missing_photo"|"selfie_face_mismatch"|"selfie_manipulated"|"selfie_unverified_other"? - A short machine-readable string giving the reason for the verification failure.
- reason? string? - A human-readable message giving the reason for the failure. These messages can be shown to your users.
stripe: Gelato_session_document_options
Fields
- allowed_types? ("driving_license"|"id_card"|"passport")[] - Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.
- require_id_number? boolean - Collect an ID number and perform an ID number check with the document’s extracted name and date of birth.
- require_live_capture? boolean - Disable image uploads, identity document images have to be captured using the device’s camera.
- require_matching_selfie? boolean - Capture a face image and perform a selfie check comparing a photo ID and a picture of your user’s face. Learn more.
stripe: Gelato_session_email_options
Fields
- require_verification? boolean - Request one time password verification of
provided_details.email.
stripe: Gelato_session_id_number_options
stripe: Gelato_session_last_error
Shows last VerificationSession error
Fields
- code? "abandoned"|"consent_declined"|"country_not_supported"|"device_not_supported"|"document_expired"|"document_type_not_supported"|"document_unverified_other"|"email_unverified_other"|"email_verification_declined"|"id_number_insufficient_document_data"|"id_number_mismatch"|"id_number_unverified_other"|"phone_unverified_other"|"phone_verification_declined"|"selfie_document_missing_photo"|"selfie_face_mismatch"|"selfie_manipulated"|"selfie_unverified_other"|"under_supported_age"? - A short machine-readable string giving the reason for the verification or user-session failure.
- reason? string? - A message that explains the reason for verification or user-session failure.
stripe: Gelato_session_phone_options
Fields
- require_verification? boolean - Request one time password verification of
provided_details.phone.
stripe: Gelato_verification_report_options
Fields
- document? Gelato_report_document_options -
- id_number? Gelato_report_id_number_options -
stripe: Gelato_verification_session_options
Fields
- document? Gelato_session_document_options -
- email? Gelato_session_email_options -
- id_number? Gelato_session_id_number_options -
- phone? Gelato_session_phone_options -
stripe: Gelato_verified_outputs
Fields
- address? Address? - The user's verified address.
- dob? Gelato_data_verified_outputs_date? - The user’s verified date of birth.
- email? string? - The user's verified email address
- first_name? string? - The user's verified first name.
- id_number? string? - The user's verified id number.
- id_number_type? "br_cpf"|"sg_nric"|"us_ssn"? - The user's verified id number type.
- last_name? string? - The user's verified last name.
- phone? string? - The user's verified phone number
stripe: GelatoVerificationReportList
Fields
- data Identity\.verification_report[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: GelatoVerificationSessionList
Fields
- data Identity\.verification_session[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: GetAccountQueries
Represents the Queries record for the operation: GetAccount
Fields
- expand? GetAccountQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetAccountsAccountBankAccountsIdQueries
Represents the Queries record for the operation: GetAccountsAccountBankAccountsId
Fields
- expand? GetAccountsAccountBankAccountsIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetAccountsAccountCapabilitiesCapabilityQueries
Represents the Queries record for the operation: GetAccountsAccountCapabilitiesCapability
Fields
- expand? GetAccountsAccountCapabilitiesCapabilityQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetAccountsAccountCapabilitiesQueries
Represents the Queries record for the operation: GetAccountsAccountCapabilities
Fields
- expand? GetAccountsAccountCapabilitiesQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetAccountsAccountExternalAccountsIdQueries
Represents the Queries record for the operation: GetAccountsAccountExternalAccountsId
Fields
- expand? GetAccountsAccountExternalAccountsIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetAccountsAccountExternalAccountsQueries
Represents the Queries record for the operation: GetAccountsAccountExternalAccounts
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetAccountsAccountExternalAccountsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- 'object? "bank_account"|"card" - Filter external accounts according to a particular object type.
stripe: GetAccountsAccountPeoplePersonQueries
Represents the Queries record for the operation: GetAccountsAccountPeoplePerson
Fields
- expand? GetAccountsAccountPeoplePersonQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetAccountsAccountPeopleQueries
Represents the Queries record for the operation: GetAccountsAccountPeople
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetAccountsAccountPeopleQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- relationship? all_people_relationship_specs - Filters on the list of people returned based on the person's relationship to the account's company.
stripe: GetAccountsAccountPersonsPersonQueries
Represents the Queries record for the operation: GetAccountsAccountPersonsPerson
Fields
- expand? GetAccountsAccountPersonsPersonQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetAccountsAccountPersonsQueries
Represents the Queries record for the operation: GetAccountsAccountPersons
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetAccountsAccountPersonsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- relationship? all_people_relationship_specs_1 - Filters on the list of people returned based on the person's relationship to the account's company.
stripe: GetAccountsAccountQueries
Represents the Queries record for the operation: GetAccountsAccount
Fields
- expand? GetAccountsAccountQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetAccountsQueries
Represents the Queries record for the operation: GetAccounts
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetAccountsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- created? created - Only return connected accounts that were created during the given date interval.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetApplePayDomainsDomainQueries
Represents the Queries record for the operation: GetApplePayDomainsDomain
Fields
- expand? GetApplePayDomainsDomainQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetApplePayDomainsQueries
Represents the Queries record for the operation: GetApplePayDomains
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- domain_name? string -
- expand? GetApplePayDomainsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetApplicationFeesFeeRefundsIdQueries
Represents the Queries record for the operation: GetApplicationFeesFeeRefundsId
Fields
- expand? GetApplicationFeesFeeRefundsIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetApplicationFeesIdQueries
Represents the Queries record for the operation: GetApplicationFeesId
Fields
- expand? GetApplicationFeesIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetApplicationFeesIdRefundsQueries
Represents the Queries record for the operation: GetApplicationFeesIdRefunds
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetApplicationFeesIdRefundsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetApplicationFeesQueries
Represents the Queries record for the operation: GetApplicationFees
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetApplicationFeesQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- charge? string - Only return application fees for the charge specified by this charge ID.
- created? created_1 - Only return applications fees that were created during the given date interval.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetAppsSecretsFindQueries
Represents the Queries record for the operation: GetAppsSecretsFind
Fields
- expand? GetAppsSecretsFindQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- scope scope_param_2 - Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
- name string - A name for the secret that's unique within the scope.
stripe: GetAppsSecretsQueries
Represents the Queries record for the operation: GetAppsSecrets
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetAppsSecretsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- scope scope_param - Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetBalanceHistoryIdQueries
Represents the Queries record for the operation: GetBalanceHistoryId
Fields
- expand? GetBalanceHistoryIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetBalanceHistoryQueries
Represents the Queries record for the operation: GetBalanceHistory
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetBalanceHistoryQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- created? created_2 - Only return transactions that were created during the given date interval.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- payout? string - For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.
- currency? string - Only return transactions in a certain currency. Three-letter ISO currency code, in lowercase. Must be a supported currency.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- 'source? string - Only returns the original transaction.
- 'type? string - Only returns transactions of the given type. One of:
adjustment,advance,advance_funding,anticipation_repayment,application_fee,application_fee_refund,charge,climate_order_purchase,climate_order_refund,connect_collection_transfer,contribution,issuing_authorization_hold,issuing_authorization_release,issuing_dispute,issuing_transaction,obligation_outbound,obligation_reversal_inbound,payment,payment_failure_refund,payment_network_reserve_hold,payment_network_reserve_release,payment_refund,payment_reversal,payment_unreconciled,payout,payout_cancel,payout_failure,refund,refund_failure,reserve_transaction,reserved_funds,stripe_fee,stripe_fx_fee,tax_fee,topup,topup_reversal,transfer,transfer_cancel,transfer_failure, ortransfer_refund.
stripe: GetBalanceQueries
Represents the Queries record for the operation: GetBalance
Fields
- expand? GetBalanceQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetBalanceTransactionsIdQueries
Represents the Queries record for the operation: GetBalanceTransactionsId
Fields
- expand? GetBalanceTransactionsIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetBalanceTransactionsQueries
Represents the Queries record for the operation: GetBalanceTransactions
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetBalanceTransactionsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- created? created_3 - Only return transactions that were created during the given date interval.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- payout? string - For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.
- currency? string - Only return transactions in a certain currency. Three-letter ISO currency code, in lowercase. Must be a supported currency.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- 'source? string - Only returns the original transaction.
- 'type? string - Only returns transactions of the given type. One of:
adjustment,advance,advance_funding,anticipation_repayment,application_fee,application_fee_refund,charge,climate_order_purchase,climate_order_refund,connect_collection_transfer,contribution,issuing_authorization_hold,issuing_authorization_release,issuing_dispute,issuing_transaction,obligation_outbound,obligation_reversal_inbound,payment,payment_failure_refund,payment_network_reserve_hold,payment_network_reserve_release,payment_refund,payment_reversal,payment_unreconciled,payout,payout_cancel,payout_failure,refund,refund_failure,reserve_transaction,reserved_funds,stripe_fee,stripe_fx_fee,tax_fee,topup,topup_reversal,transfer,transfer_cancel,transfer_failure, ortransfer_refund.
stripe: GetBillingMetersIdEventSummariesQueries
Represents the Queries record for the operation: GetBillingMetersIdEventSummaries
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- start_time int - The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.
- expand? GetBillingMetersIdEventSummariesQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- value_grouping_window? "day"|"hour" - Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. For hourly granularity, start and end times must align with hour boundaries (e.g., 00:00, 01:00, ..., 23:00). For daily granularity, start and end times must align with UTC day boundaries (00:00 UTC).
- end_time int - The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- customer string - The customer for which to fetch event summaries.
stripe: GetBillingMetersIdQueries
Represents the Queries record for the operation: GetBillingMetersId
Fields
- expand? GetBillingMetersIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetBillingMetersQueries
Represents the Queries record for the operation: GetBillingMeters
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetBillingMetersQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- status? "active"|"inactive" - Filter results to only include meters with the given status.
stripe: GetBillingPortalConfigurationsConfigurationQueries
Represents the Queries record for the operation: GetBillingPortalConfigurationsConfiguration
Fields
- expand? GetBillingPortalConfigurationsConfigurationQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetBillingPortalConfigurationsQueries
Represents the Queries record for the operation: GetBillingPortalConfigurations
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetBillingPortalConfigurationsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- active? boolean - Only return configurations that are active or inactive (e.g., pass
trueto only list active configurations).
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- is_default? boolean - Only return the default or non-default configurations (e.g., pass
trueto only list the default configuration).
stripe: GetChargesChargeDisputeQueries
Represents the Queries record for the operation: GetChargesChargeDispute
Fields
- expand? GetChargesChargeDisputeQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetChargesChargeQueries
Represents the Queries record for the operation: GetChargesCharge
Fields
- expand? GetChargesChargeQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetChargesChargeRefundsQueries
Represents the Queries record for the operation: GetChargesChargeRefunds
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetChargesChargeRefundsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetChargesChargeRefundsRefundQueries
Represents the Queries record for the operation: GetChargesChargeRefundsRefund
Fields
- expand? GetChargesChargeRefundsRefundQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetChargesQueries
Represents the Queries record for the operation: GetCharges
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetChargesQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- transfer_group? string - Only return charges for this transfer group.
- created? created_4 - Only return charges that were created during the given date interval.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- payment_intent? string - Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- customer? string - Only return charges for the customer specified by this customer ID.
stripe: GetChargesSearchQueries
Represents the Queries record for the operation: GetChargesSearch
Fields
- expand? GetChargesSearchQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- query string - The search query string. See search query language and the list of supported query fields for charges.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- page? string - A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
stripe: GetCheckoutSessionsQueries
Represents the Queries record for the operation: GetCheckoutSessions
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- customer_details? customer_details_params - Only return the Checkout Sessions for the Customer details specified.
- expand? GetCheckoutSessionsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- created? created_5 - Only return Checkout Sessions that were created during the given date interval.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- payment_intent? string - Only return the Checkout Session for the PaymentIntent specified.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- subscription? string - Only return the Checkout Session for the subscription specified.
- payment_link? string - Only return the Checkout Sessions for the Payment Link specified.
- customer? string - Only return the Checkout Sessions for the Customer specified.
- status? "complete"|"expired"|"open" - Only return the Checkout Sessions matching the given status.
stripe: GetCheckoutSessionsSessionLineItemsQueries
Represents the Queries record for the operation: GetCheckoutSessionsSessionLineItems
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetCheckoutSessionsSessionLineItemsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetCheckoutSessionsSessionQueries
Represents the Queries record for the operation: GetCheckoutSessionsSession
Fields
- expand? GetCheckoutSessionsSessionQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetClimateOrdersOrderQueries
Represents the Queries record for the operation: GetClimateOrdersOrder
Fields
- expand? GetClimateOrdersOrderQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetClimateOrdersQueries
Represents the Queries record for the operation: GetClimateOrders
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetClimateOrdersQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetClimateProductsProductQueries
Represents the Queries record for the operation: GetClimateProductsProduct
Fields
- expand? GetClimateProductsProductQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetClimateProductsQueries
Represents the Queries record for the operation: GetClimateProducts
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetClimateProductsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetClimateSuppliersQueries
Represents the Queries record for the operation: GetClimateSuppliers
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetClimateSuppliersQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetClimateSuppliersSupplierQueries
Represents the Queries record for the operation: GetClimateSuppliersSupplier
Fields
- expand? GetClimateSuppliersSupplierQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetConfirmationTokensConfirmationTokenQueries
Represents the Queries record for the operation: GetConfirmationTokensConfirmationToken
Fields
- expand? GetConfirmationTokensConfirmationTokenQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetCountrySpecsCountryQueries
Represents the Queries record for the operation: GetCountrySpecsCountry
Fields
- expand? GetCountrySpecsCountryQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetCountrySpecsQueries
Represents the Queries record for the operation: GetCountrySpecs
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetCountrySpecsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetCouponsCouponQueries
Represents the Queries record for the operation: GetCouponsCoupon
Fields
- expand? GetCouponsCouponQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetCouponsQueries
Represents the Queries record for the operation: GetCoupons
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetCouponsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- created? created_6 - A filter on the list, based on the object
createdfield. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetCreditNotesCreditNoteLinesQueries
Represents the Queries record for the operation: GetCreditNotesCreditNoteLines
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetCreditNotesCreditNoteLinesQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetCreditNotesIdQueries
Represents the Queries record for the operation: GetCreditNotesId
Fields
- expand? GetCreditNotesIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetCreditNotesPreviewLinesQueries
Represents the Queries record for the operation: GetCreditNotesPreviewLines
Fields
- reason? "duplicate"|"fraudulent"|"order_change"|"product_unsatisfactory" - Reason for issuing this credit note, one of
duplicate,fraudulent,order_change, orproduct_unsatisfactory
- amount? int - The integer amount in cents (or local equivalent) representing the total amount of the credit note.
- metadata? record { string... } - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- email_type? "credit_note"|"none" - Type of email to send to the customer, one of
credit_noteornoneand the default iscredit_note.
- shipping_cost? credit_note_shipping_cost_2 - When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.
- credit_amount? int - The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
- memo? string - The credit note's memo appears on the credit note PDF.
- out_of_band_amount? int - The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
- effective_at? int - The date when this credit note is in effect. Same as
createdunless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetCreditNotesPreviewLinesQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- refund_amount? int - The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- invoice string - ID of the invoice.
- lines? credit_note_line_item_params[] - Line items that make up the credit note.
- refund? string - ID of an existing refund to link this credit note to.
stripe: GetCreditNotesPreviewQueries
Represents the Queries record for the operation: GetCreditNotesPreview
Fields
- reason? "duplicate"|"fraudulent"|"order_change"|"product_unsatisfactory" - Reason for issuing this credit note, one of
duplicate,fraudulent,order_change, orproduct_unsatisfactory
- amount? int - The integer amount in cents (or local equivalent) representing the total amount of the credit note.
- metadata? record { string... } - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- email_type? "credit_note"|"none" - Type of email to send to the customer, one of
credit_noteornoneand the default iscredit_note.
- shipping_cost? credit_note_shipping_cost_1 - When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.
- credit_amount? int - The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
- memo? string - The credit note's memo appears on the credit note PDF.
- out_of_band_amount? int - The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
- effective_at? int - The date when this credit note is in effect. Same as
createdunless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
- expand? GetCreditNotesPreviewQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- refund_amount? int - The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
- invoice string - ID of the invoice.
- lines? credit_note_line_item_params[] - Line items that make up the credit note.
- refund? string - ID of an existing refund to link this credit note to.
stripe: GetCreditNotesQueries
Represents the Queries record for the operation: GetCreditNotes
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetCreditNotesQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- created? created_7 - Only return credit notes that were created during the given date interval.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- invoice? string - Only return credit notes for the invoice specified by this invoice ID.
- customer? string - Only return credit notes for the customer specified by this customer ID.
stripe: GetCustomersCustomerBalanceTransactionsQueries
Represents the Queries record for the operation: GetCustomersCustomerBalanceTransactions
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetCustomersCustomerBalanceTransactionsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetCustomersCustomerBalanceTransactionsTransactionQueries
Represents the Queries record for the operation: GetCustomersCustomerBalanceTransactionsTransaction
Fields
- expand? GetCustomersCustomerBalanceTransactionsTransactionQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetCustomersCustomerBankAccountsIdQueries
Represents the Queries record for the operation: GetCustomersCustomerBankAccountsId
Fields
- expand? GetCustomersCustomerBankAccountsIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetCustomersCustomerBankAccountsQueries
Represents the Queries record for the operation: GetCustomersCustomerBankAccounts
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetCustomersCustomerBankAccountsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetCustomersCustomerCardsIdQueries
Represents the Queries record for the operation: GetCustomersCustomerCardsId
Fields
- expand? GetCustomersCustomerCardsIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetCustomersCustomerCardsQueries
Represents the Queries record for the operation: GetCustomersCustomerCards
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetCustomersCustomerCardsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetCustomersCustomerCashBalanceQueries
Represents the Queries record for the operation: GetCustomersCustomerCashBalance
Fields
- expand? GetCustomersCustomerCashBalanceQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetCustomersCustomerCashBalanceTransactionsQueries
Represents the Queries record for the operation: GetCustomersCustomerCashBalanceTransactions
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetCustomersCustomerCashBalanceTransactionsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetCustomersCustomerCashBalanceTransactionsTransactionQueries
Represents the Queries record for the operation: GetCustomersCustomerCashBalanceTransactionsTransaction
Fields
- expand? GetCustomersCustomerCashBalanceTransactionsTransactionQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetCustomersCustomerDiscountQueries
Represents the Queries record for the operation: GetCustomersCustomerDiscount
Fields
- expand? GetCustomersCustomerDiscountQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetCustomersCustomerPaymentMethodsPaymentMethodQueries
Represents the Queries record for the operation: GetCustomersCustomerPaymentMethodsPaymentMethod
Fields
- expand? GetCustomersCustomerPaymentMethodsPaymentMethodQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetCustomersCustomerPaymentMethodsQueries
Represents the Queries record for the operation: GetCustomersCustomerPaymentMethods
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetCustomersCustomerPaymentMethodsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- 'type? "acss_debit"|"affirm"|"afterpay_clearpay"|"alipay"|"amazon_pay"|"au_becs_debit"|"bacs_debit"|"bancontact"|"blik"|"boleto"|"card"|"cashapp"|"customer_balance"|"eps"|"fpx"|"giropay"|"grabpay"|"ideal"|"klarna"|"konbini"|"link"|"mobilepay"|"multibanco"|"oxxo"|"p24"|"paynow"|"paypal"|"pix"|"promptpay"|"revolut_pay"|"sepa_debit"|"sofort"|"swish"|"twint"|"us_bank_account"|"wechat_pay"|"zip" - An optional filter on the list, based on the object
typefield. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request.
- allow_redisplay? "always"|"limited"|"unspecified" - This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to
unspecified.
stripe: GetCustomersCustomerQueries
Represents the Queries record for the operation: GetCustomersCustomer
Fields
- expand? GetCustomersCustomerQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetCustomersCustomerSourcesIdQueries
Represents the Queries record for the operation: GetCustomersCustomerSourcesId
Fields
- expand? GetCustomersCustomerSourcesIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetCustomersCustomerSourcesQueries
Represents the Queries record for the operation: GetCustomersCustomerSources
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetCustomersCustomerSourcesQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- 'object? string - Filter sources according to a particular object type.
stripe: GetCustomersCustomerSubscriptionsQueries
Represents the Queries record for the operation: GetCustomersCustomerSubscriptions
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetCustomersCustomerSubscriptionsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscountQueries
Represents the Queries record for the operation: GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount
Fields
- expand? GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscountQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetCustomersCustomerSubscriptionsSubscriptionExposedIdQueries
Represents the Queries record for the operation: GetCustomersCustomerSubscriptionsSubscriptionExposedId
Fields
- expand? GetCustomersCustomerSubscriptionsSubscriptionExposedIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetCustomersCustomerTaxIdsIdQueries
Represents the Queries record for the operation: GetCustomersCustomerTaxIdsId
Fields
- expand? GetCustomersCustomerTaxIdsIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetCustomersCustomerTaxIdsQueries
Represents the Queries record for the operation: GetCustomersCustomerTaxIds
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetCustomersCustomerTaxIdsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetCustomersQueries
Represents the Queries record for the operation: GetCustomers
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetCustomersQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- test_clock? string - Provides a list of customers that are associated with the specified test clock. The response will not include customers with test clocks if this parameter is not set.
- created? created_8 - Only return customers that were created during the given date interval.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- email? string - A case-sensitive filter on the list based on the customer's
emailfield. The value must be a string.
stripe: GetCustomersSearchQueries
Represents the Queries record for the operation: GetCustomersSearch
Fields
- expand? GetCustomersSearchQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- query string - The search query string. See search query language and the list of supported query fields for customers.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- page? string - A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
stripe: GetDisputesDisputeQueries
Represents the Queries record for the operation: GetDisputesDispute
Fields
- expand? GetDisputesDisputeQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetDisputesQueries
Represents the Queries record for the operation: GetDisputes
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetDisputesQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- charge? string - Only return disputes associated to the charge specified by this charge ID.
- created? created_9 -
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- payment_intent? string - Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetEntitlementsActiveEntitlementsIdQueries
Represents the Queries record for the operation: GetEntitlementsActiveEntitlementsId
Fields
- expand? GetEntitlementsActiveEntitlementsIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetEntitlementsActiveEntitlementsQueries
Represents the Queries record for the operation: GetEntitlementsActiveEntitlements
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetEntitlementsActiveEntitlementsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- customer string - The ID of the customer.
stripe: GetEntitlementsFeaturesIdQueries
Represents the Queries record for the operation: GetEntitlementsFeaturesId
Fields
- expand? GetEntitlementsFeaturesIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetEntitlementsFeaturesQueries
Represents the Queries record for the operation: GetEntitlementsFeatures
Fields
- archived? boolean - If set, filter results to only include features with the given archive status.
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetEntitlementsFeaturesQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- lookup_key? string - If set, filter results to only include features with the given lookup_key.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetEventsIdQueries
Represents the Queries record for the operation: GetEventsId
Fields
- expand? GetEventsIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetEventsQueries
Represents the Queries record for the operation: GetEvents
Fields
- delivery_success? boolean - Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned.
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetEventsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- types? GetEventsQueriesTypesItemsString[] - An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass either
typeortypes, but not both.
- created? created_10 - Only return events that were created during the given date interval.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- 'type? string - A string containing a specific event name, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property.
stripe: GetExchangeRatesQueries
Represents the Queries record for the operation: GetExchangeRates
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with the exchange rate for currency X your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetExchangeRatesQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and total number of supported payout currencies, and the default is the max.
- starting_after? string - A cursor for use in pagination.
starting_afteris the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with the exchange rate for currency X, your subsequent call can includestarting_after=Xin order to fetch the next page of the list.
stripe: GetExchangeRatesRateIdQueries
Represents the Queries record for the operation: GetExchangeRatesRateId
Fields
- expand? GetExchangeRatesRateIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetFileLinksLinkQueries
Represents the Queries record for the operation: GetFileLinksLink
Fields
- expand? GetFileLinksLinkQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetFileLinksQueries
Represents the Queries record for the operation: GetFileLinks
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetFileLinksQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- expired? boolean - Filter links by their expiration status. By default, Stripe returns all links.
- file? string - Only return links for the given file.
- created? created_11 - Only return links that were created during the given date interval.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetFilesFileQueries
Represents the Queries record for the operation: GetFilesFile
Fields
- expand? GetFilesFileQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetFilesQueries
Represents the Queries record for the operation: GetFiles
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetFilesQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- purpose? "account_requirement"|"additional_verification"|"business_icon"|"business_logo"|"customer_signature"|"dispute_evidence"|"document_provider_identity_document"|"finance_report_run"|"identity_document"|"identity_document_downloadable"|"pci_document"|"selfie"|"sigma_scheduled_query"|"tax_document_user_upload"|"terminal_reader_splashscreen" - Filter queries by the file purpose. If you don't provide a purpose, the queries return unfiltered files.
- created? created_12 - Only return files that were created during the given date interval.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetFinancialConnectionsAccountsAccountOwnersQueries
Represents the Queries record for the operation: GetFinancialConnectionsAccountsAccountOwners
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetFinancialConnectionsAccountsAccountOwnersQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- ownership string - The ID of the ownership object to fetch owners from.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetFinancialConnectionsAccountsAccountQueries
Represents the Queries record for the operation: GetFinancialConnectionsAccountsAccount
Fields
- expand? GetFinancialConnectionsAccountsAccountQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetFinancialConnectionsAccountsQueries
Represents the Queries record for the operation: GetFinancialConnectionsAccounts
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetFinancialConnectionsAccountsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- account_holder? accountholder_params - If present, only return accounts that belong to the specified account holder.
account_holder[customer]andaccount_holder[account]are mutually exclusive.
- session? string - If present, only return accounts that were collected as part of the given session.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetFinancialConnectionsSessionsSessionQueries
Represents the Queries record for the operation: GetFinancialConnectionsSessionsSession
Fields
- expand? GetFinancialConnectionsSessionsSessionQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetFinancialConnectionsTransactionsQueries
Represents the Queries record for the operation: GetFinancialConnectionsTransactions
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetFinancialConnectionsTransactionsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- transacted_at? transacted_at - A filter on the list based on the object
transacted_atfield. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:
- transaction_refresh? transaction_refresh_params - A filter on the list based on the object
transaction_refreshfield. The value can be a dictionary with the following options:
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- account string - The ID of the Stripe account whose transactions will be retrieved.
stripe: GetFinancialConnectionsTransactionsTransactionQueries
Represents the Queries record for the operation: GetFinancialConnectionsTransactionsTransaction
Fields
- expand? GetFinancialConnectionsTransactionsTransactionQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetForwardingRequestsIdQueries
Represents the Queries record for the operation: GetForwardingRequestsId
Fields
- expand? GetForwardingRequestsIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetForwardingRequestsQueries
Represents the Queries record for the operation: GetForwardingRequests
Fields
- ending_before? string - A pagination cursor to fetch the previous page of the list. The value must be a ForwardingRequest ID.
- expand? GetForwardingRequestsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- created? created_param - Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A pagination cursor to fetch the next page of the list. The value must be a ForwardingRequest ID.
stripe: GetIdentityVerificationReportsQueries
Represents the Queries record for the operation: GetIdentityVerificationReports
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetIdentityVerificationReportsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- verification_session? string - Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID.
- created? created_13 - Only return VerificationReports that were created during the given date interval.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- client_reference_id? string - A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- 'type? "document"|"id_number" - Only return VerificationReports of this type
stripe: GetIdentityVerificationReportsReportQueries
Represents the Queries record for the operation: GetIdentityVerificationReportsReport
Fields
- expand? GetIdentityVerificationReportsReportQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetIdentityVerificationSessionsQueries
Represents the Queries record for the operation: GetIdentityVerificationSessions
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetIdentityVerificationSessionsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- created? created_14 - Only return VerificationSessions that were created during the given date interval.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- client_reference_id? string - A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- status? "canceled"|"processing"|"requires_input"|"verified" - Only return VerificationSessions with this status. Learn more about the lifecycle of sessions.
stripe: GetIdentityVerificationSessionsSessionQueries
Represents the Queries record for the operation: GetIdentityVerificationSessionsSession
Fields
- expand? GetIdentityVerificationSessionsSessionQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetInvoiceitemsInvoiceitemQueries
Represents the Queries record for the operation: GetInvoiceitemsInvoiceitem
Fields
- expand? GetInvoiceitemsInvoiceitemQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetInvoiceitemsQueries
Represents the Queries record for the operation: GetInvoiceitems
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetInvoiceitemsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- created? created_15 - Only return invoice items that were created during the given date interval.
- pending? boolean - Set to
trueto only show pending invoice items, which are not yet attached to any invoices. Set tofalseto only show invoice items already attached to invoices. If unspecified, no filter is applied.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- invoice? string - Only return invoice items belonging to this invoice. If none is provided, all invoice items will be returned. If specifying an invoice, no customer identifier is needed.
- customer? string - The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned.
stripe: GetInvoicesInvoiceLinesQueries
Represents the Queries record for the operation: GetInvoicesInvoiceLines
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetInvoicesInvoiceLinesQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetInvoicesInvoiceQueries
Represents the Queries record for the operation: GetInvoicesInvoice
Fields
- expand? GetInvoicesInvoiceQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetInvoicesQueries
Represents the Queries record for the operation: GetInvoices
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetInvoicesQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- created? created_16 - Only return invoices that were created during the given date interval.
- collection_method? "charge_automatically"|"send_invoice" - The collection method of the invoice to retrieve. Either
charge_automaticallyorsend_invoice.
- due_date? due_date -
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- subscription? string - Only return invoices for the subscription specified by this subscription ID.
- customer? string - Only return invoices for the customer specified by this customer ID.
- status? "draft"|"open"|"paid"|"uncollectible"|"void" - The status of the invoice, one of
draft,open,paid,uncollectible, orvoid. Learn more
stripe: GetInvoicesSearchQueries
Represents the Queries record for the operation: GetInvoicesSearch
Fields
- expand? GetInvoicesSearchQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- query string - The search query string. See search query language and the list of supported query fields for invoices.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- page? string - A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
stripe: GetInvoicesUpcomingLinesQueries
Represents the Queries record for the operation: GetInvoicesUpcomingLines
Fields
- subscription_items? subscription_item_update_params[] - A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use
subscription_details.itemsinstead.
- invoice_items? invoice_item_preview_params[] - List of invoice items to add or update in the upcoming invoice preview.
- subscription_billing_cycle_anchor? subscription_billing_cycle_anchor_1 - For new subscriptions, a future timestamp to anchor the subscription's billing cycle. This is used to determine the date of the first full invoice, and, for plans with
monthoryearintervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set tonoworunchanged. This field has been deprecated and will be removed in a future API version. Usesubscription_details.billing_cycle_anchorinstead.
- subscription? string - The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a
subscription_details.itemsis provided, you will preview creating a subscription with those items. If neithersubscriptionnorsubscription_details.itemsis provided, you will retrieve the next upcoming invoice from among the customer's subscriptions.
- issuer? param_3 - The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
- subscription_cancel_now? boolean - This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use
subscription_details.cancel_nowinstead.
- customer_details? customer_details_param_2 - Details about the customer you want to invoice or overrides for an existing customer. If
automatic_taxis enabled then one ofcustomer,customer_details,subscription, orschedulemust be set.
- subscription_cancel_at_period_end? boolean - Boolean indicating whether this subscription should cancel at the end of the current period. This field has been deprecated and will be removed in a future API version. Use
subscription_details.cancel_at_period_endinstead.
- discounts? discounts_1 - The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.
- subscription_resume_at? "now" - For paused subscriptions, setting
subscription_resume_attonowwill preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Usesubscription_details.resume_atinstead.
- subscription_start_date? int - Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use
subscription_details.start_dateinstead.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- currency? string - The currency to preview this invoice in. Defaults to that of
customerif not specified.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- subscription_proration_date? int - If previewing an update to a subscription, and doing proration,
subscription_proration_dateforces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set,subscription, and one ofsubscription_items, orsubscription_trial_endare required. Also,subscription_proration_behaviorcannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Usesubscription_details.proration_dateinstead.
- schedule_details? schedule_details_params_2 - The schedule creation or modification params to apply as a preview. Cannot be used with
subscriptionorsubscription_prefixed fields.
- coupon? string - The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use
discountsinstead.
- on_behalf_of? on_behalf_of_1 - The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details.
- subscription_trial_end? subscription_trial_end_1 - If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of
subscription_itemsorsubscriptionis required. This field has been deprecated and will be removed in a future API version. Usesubscription_details.trial_endinstead.
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- schedule? string - The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.
- expand? GetInvoicesUpcomingLinesQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- automatic_tax? automatic_tax_param_3 - Settings for automatic tax lookup for this invoice preview.
- subscription_details? subscription_details_params_2 - The subscription creation or modification params to apply as a preview. Cannot be used with
scheduleorschedule_detailsfields.
- subscription_cancel_at? subscription_cancel_at_1 - A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using
proration_behavior. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Usesubscription_details.cancel_atinstead.
- subscription_default_tax_rates? subscription_default_tax_rates_1 - If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have
tax_ratesset. This field has been deprecated and will be removed in a future API version. Usesubscription_details.default_tax_ratesinstead.
- subscription_proration_behavior? "always_invoice"|"create_prorations"|"none" - Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting
billing_cycle_anchor=now, or starting a trial), or if an item'squantitychanges. The default value iscreate_prorations. This field has been deprecated and will be removed in a future API version. Usesubscription_details.proration_behaviorinstead.
- preview_mode? "next"|"recurring" - Customizes the types of values to include when calculating the invoice. Defaults to
nextif unspecified.
- customer? string - The identifier of the customer whose upcoming invoice you'd like to retrieve. If
automatic_taxis enabled then one ofcustomer,customer_details,subscription, orschedulemust be set.
stripe: GetInvoicesUpcomingQueries
Represents the Queries record for the operation: GetInvoicesUpcoming
Fields
- subscription_items? subscription_item_update_params[] - A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use
subscription_details.itemsinstead.
- invoice_items? invoice_item_preview_params[] - List of invoice items to add or update in the upcoming invoice preview.
- subscription_billing_cycle_anchor? subscription_billing_cycle_anchor - For new subscriptions, a future timestamp to anchor the subscription's billing cycle. This is used to determine the date of the first full invoice, and, for plans with
monthoryearintervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set tonoworunchanged. This field has been deprecated and will be removed in a future API version. Usesubscription_details.billing_cycle_anchorinstead.
- subscription? string - The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a
subscription_details.itemsis provided, you will preview creating a subscription with those items. If neithersubscriptionnorsubscription_details.itemsis provided, you will retrieve the next upcoming invoice from among the customer's subscriptions.
- issuer? param_2 - The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
- subscription_cancel_now? boolean - This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use
subscription_details.cancel_nowinstead.
- customer_details? customer_details_param_1 - Details about the customer you want to invoice or overrides for an existing customer. If
automatic_taxis enabled then one ofcustomer,customer_details,subscription, orschedulemust be set.
- subscription_cancel_at_period_end? boolean - Boolean indicating whether this subscription should cancel at the end of the current period. This field has been deprecated and will be removed in a future API version. Use
subscription_details.cancel_at_period_endinstead.
- discounts? discounts - The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.
- subscription_resume_at? "now" - For paused subscriptions, setting
subscription_resume_attonowwill preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Usesubscription_details.resume_atinstead.
- subscription_start_date? int - Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use
subscription_details.start_dateinstead.
- currency? string - The currency to preview this invoice in. Defaults to that of
customerif not specified.
- subscription_proration_date? int - If previewing an update to a subscription, and doing proration,
subscription_proration_dateforces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set,subscription, and one ofsubscription_items, orsubscription_trial_endare required. Also,subscription_proration_behaviorcannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Usesubscription_details.proration_dateinstead.
- schedule_details? schedule_details_params_1 - The schedule creation or modification params to apply as a preview. Cannot be used with
subscriptionorsubscription_prefixed fields.
- coupon? string - The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use
discountsinstead.
- on_behalf_of? on_behalf_of - The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details.
- subscription_trial_end? subscription_trial_end - If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of
subscription_itemsorsubscriptionis required. This field has been deprecated and will be removed in a future API version. Usesubscription_details.trial_endinstead.
- schedule? string - The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.
- expand? GetInvoicesUpcomingQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- automatic_tax? automatic_tax_param_2 - Settings for automatic tax lookup for this invoice preview.
- subscription_details? subscription_details_params_1 - The subscription creation or modification params to apply as a preview. Cannot be used with
scheduleorschedule_detailsfields.
- subscription_cancel_at? subscription_cancel_at - A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using
proration_behavior. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Usesubscription_details.cancel_atinstead.
- subscription_default_tax_rates? subscription_default_tax_rates - If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have
tax_ratesset. This field has been deprecated and will be removed in a future API version. Usesubscription_details.default_tax_ratesinstead.
- subscription_proration_behavior? "always_invoice"|"create_prorations"|"none" - Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting
billing_cycle_anchor=now, or starting a trial), or if an item'squantitychanges. The default value iscreate_prorations. This field has been deprecated and will be removed in a future API version. Usesubscription_details.proration_behaviorinstead.
- preview_mode? "next"|"recurring" - Customizes the types of values to include when calculating the invoice. Defaults to
nextif unspecified.
- customer? string - The identifier of the customer whose upcoming invoice you'd like to retrieve. If
automatic_taxis enabled then one ofcustomer,customer_details,subscription, orschedulemust be set.
stripe: GetIssuingAuthorizationsAuthorizationQueries
Represents the Queries record for the operation: GetIssuingAuthorizationsAuthorization
Fields
- expand? GetIssuingAuthorizationsAuthorizationQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetIssuingAuthorizationsQueries
Represents the Queries record for the operation: GetIssuingAuthorizations
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetIssuingAuthorizationsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- created? created_17 - Only return authorizations that were created during the given date interval.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- cardholder? string - Only return authorizations that belong to the given cardholder.
- card? string - Only return authorizations that belong to the given card.
- status? "closed"|"pending"|"reversed" - Only return authorizations with the given status. One of
pending,closed, orreversed.
stripe: GetIssuingCardholdersCardholderQueries
Represents the Queries record for the operation: GetIssuingCardholdersCardholder
Fields
- expand? GetIssuingCardholdersCardholderQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetIssuingCardholdersQueries
Represents the Queries record for the operation: GetIssuingCardholders
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetIssuingCardholdersQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- created? created_18 - Only return cardholders that were created during the given date interval.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- phone_number? string - Only return cardholders that have the given phone number.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- 'type? "company"|"individual" - Only return cardholders that have the given type. One of
individualorcompany.
- email? string - Only return cardholders that have the given email address.
- status? "active"|"blocked"|"inactive" - Only return cardholders that have the given status. One of
active,inactive, orblocked.
stripe: GetIssuingCardsCardQueries
Represents the Queries record for the operation: GetIssuingCardsCard
Fields
- expand? GetIssuingCardsCardQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetIssuingCardsQueries
Represents the Queries record for the operation: GetIssuingCards
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- last4? string - Only return cards that have the given last four digits.
- expand? GetIssuingCardsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- personalization_design? string -
- created? created_19 - Only return cards that were issued during the given date interval.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- exp_month? int - Only return cards that have the given expiration month.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- exp_year? int - Only return cards that have the given expiration year.
- cardholder? string - Only return cards belonging to the Cardholder with the provided ID.
- 'type? "physical"|"virtual" - Only return cards that have the given type. One of
virtualorphysical.
- status? "active"|"canceled"|"inactive" - Only return cards that have the given status. One of
active,inactive, orcanceled.
stripe: GetIssuingDisputesDisputeQueries
Represents the Queries record for the operation: GetIssuingDisputesDispute
Fields
- expand? GetIssuingDisputesDisputeQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetIssuingDisputesQueries
Represents the Queries record for the operation: GetIssuingDisputes
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetIssuingDisputesQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- created? created_20 - Only return Issuing disputes that were created during the given date interval.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- 'transaction? string - Select the Issuing dispute for the given transaction.
- status? "expired"|"lost"|"submitted"|"unsubmitted"|"won" - Select Issuing disputes with the given status.
stripe: GetIssuingPersonalizationDesignsPersonalizationDesignQueries
Represents the Queries record for the operation: GetIssuingPersonalizationDesignsPersonalizationDesign
Fields
- expand? GetIssuingPersonalizationDesignsPersonalizationDesignQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetIssuingPersonalizationDesignsQueries
Represents the Queries record for the operation: GetIssuingPersonalizationDesigns
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetIssuingPersonalizationDesignsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- preferences? preferences_list_param - Only return personalization designs with the given preferences.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- lookup_keys? GetIssuingPersonalizationDesignsQueriesLookupkeysItemsString[] - Only return personalization designs with the given lookup keys.
- status? "active"|"inactive"|"rejected"|"review" - Only return personalization designs with the given status.
stripe: GetIssuingPhysicalBundlesPhysicalBundleQueries
Represents the Queries record for the operation: GetIssuingPhysicalBundlesPhysicalBundle
Fields
- expand? GetIssuingPhysicalBundlesPhysicalBundleQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetIssuingPhysicalBundlesQueries
Represents the Queries record for the operation: GetIssuingPhysicalBundles
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetIssuingPhysicalBundlesQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- 'type? "custom"|"standard" - Only return physical bundles with the given type.
- status? "active"|"inactive"|"review" - Only return physical bundles with the given status.
stripe: GetIssuingSettlementsSettlementQueries
Represents the Queries record for the operation: GetIssuingSettlementsSettlement
Fields
- expand? GetIssuingSettlementsSettlementQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetIssuingTokensQueries
Represents the Queries record for the operation: GetIssuingTokens
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetIssuingTokensQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- created? created_21 - Only return Issuing tokens that were created during the given date interval.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- card string - The Issuing card identifier to list tokens for.
- status? "active"|"deleted"|"requested"|"suspended" - Select Issuing tokens with the given status.
stripe: GetIssuingTokensTokenQueries
Represents the Queries record for the operation: GetIssuingTokensToken
Fields
- expand? GetIssuingTokensTokenQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetIssuingTransactionsQueries
Represents the Queries record for the operation: GetIssuingTransactions
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetIssuingTransactionsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- created? created_22 - Only return transactions that were created during the given date interval.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- cardholder? string - Only return transactions that belong to the given cardholder.
- 'type? "capture"|"refund" - Only return transactions that have the given type. One of
captureorrefund.
- card? string - Only return transactions that belong to the given card.
stripe: GetIssuingTransactionsTransactionQueries
Represents the Queries record for the operation: GetIssuingTransactionsTransaction
Fields
- expand? GetIssuingTransactionsTransactionQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetLinkAccountSessionsSessionQueries
Represents the Queries record for the operation: GetLinkAccountSessionsSession
Fields
- expand? GetLinkAccountSessionsSessionQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetLinkedAccountsAccountOwnersQueries
Represents the Queries record for the operation: GetLinkedAccountsAccountOwners
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetLinkedAccountsAccountOwnersQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- ownership string - The ID of the ownership object to fetch owners from.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetLinkedAccountsAccountQueries
Represents the Queries record for the operation: GetLinkedAccountsAccount
Fields
- expand? GetLinkedAccountsAccountQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetLinkedAccountsQueries
Represents the Queries record for the operation: GetLinkedAccounts
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetLinkedAccountsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- account_holder? accountholder_params_2 - If present, only return accounts that belong to the specified account holder.
account_holder[customer]andaccount_holder[account]are mutually exclusive.
- session? string - If present, only return accounts that were collected as part of the given session.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetMandatesMandateQueries
Represents the Queries record for the operation: GetMandatesMandate
Fields
- expand? GetMandatesMandateQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetPaymentIntentsIntentQueries
Represents the Queries record for the operation: GetPaymentIntentsIntent
Fields
- expand? GetPaymentIntentsIntentQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- client_secret? string - The client secret of the PaymentIntent. We require it if you use a publishable key to retrieve the source.
stripe: GetPaymentIntentsQueries
Represents the Queries record for the operation: GetPaymentIntents
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetPaymentIntentsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- created? created_23 - A filter on the list, based on the object
createdfield. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- customer? string - Only return PaymentIntents for the customer that this customer ID specifies.
stripe: GetPaymentIntentsSearchQueries
Represents the Queries record for the operation: GetPaymentIntentsSearch
Fields
- expand? GetPaymentIntentsSearchQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- query string - The search query string. See search query language and the list of supported query fields for payment intents.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- page? string - A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
stripe: GetPaymentLinksPaymentLinkLineItemsQueries
Represents the Queries record for the operation: GetPaymentLinksPaymentLinkLineItems
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetPaymentLinksPaymentLinkLineItemsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetPaymentLinksPaymentLinkQueries
Represents the Queries record for the operation: GetPaymentLinksPaymentLink
Fields
- expand? GetPaymentLinksPaymentLinkQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetPaymentLinksQueries
Represents the Queries record for the operation: GetPaymentLinks
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetPaymentLinksQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- active? boolean - Only return payment links that are active or inactive (e.g., pass
falseto list all inactive payment links).
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetPaymentMethodConfigurationsConfigurationQueries
Represents the Queries record for the operation: GetPaymentMethodConfigurationsConfiguration
Fields
- expand? GetPaymentMethodConfigurationsConfigurationQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetPaymentMethodConfigurationsQueries
Represents the Queries record for the operation: GetPaymentMethodConfigurations
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetPaymentMethodConfigurationsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- application? application - The Connect application to filter by.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetPaymentMethodDomainsPaymentMethodDomainQueries
Represents the Queries record for the operation: GetPaymentMethodDomainsPaymentMethodDomain
Fields
- expand? GetPaymentMethodDomainsPaymentMethodDomainQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetPaymentMethodDomainsQueries
Represents the Queries record for the operation: GetPaymentMethodDomains
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- domain_name? string - The domain name that this payment method domain object represents.
- expand? GetPaymentMethodDomainsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- enabled? boolean - Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements
stripe: GetPaymentMethodsPaymentMethodQueries
Represents the Queries record for the operation: GetPaymentMethodsPaymentMethod
Fields
- expand? GetPaymentMethodsPaymentMethodQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetPaymentMethodsQueries
Represents the Queries record for the operation: GetPaymentMethods
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetPaymentMethodsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- 'type? "acss_debit"|"affirm"|"afterpay_clearpay"|"alipay"|"amazon_pay"|"au_becs_debit"|"bacs_debit"|"bancontact"|"blik"|"boleto"|"card"|"cashapp"|"customer_balance"|"eps"|"fpx"|"giropay"|"grabpay"|"ideal"|"klarna"|"konbini"|"link"|"mobilepay"|"multibanco"|"oxxo"|"p24"|"paynow"|"paypal"|"pix"|"promptpay"|"revolut_pay"|"sepa_debit"|"sofort"|"swish"|"twint"|"us_bank_account"|"wechat_pay"|"zip" - An optional filter on the list, based on the object
typefield. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request.
- customer? string - The ID of the customer whose PaymentMethods will be retrieved.
stripe: GetPayoutsPayoutQueries
Represents the Queries record for the operation: GetPayoutsPayout
Fields
- expand? GetPayoutsPayoutQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetPayoutsQueries
Represents the Queries record for the operation: GetPayouts
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetPayoutsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- created? created_24 - Only return payouts that were created during the given date interval.
- destination? string - The ID of an external account - only return payouts sent to this external account.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- arrival_date? arrival_date - Only return payouts that are expected to arrive during the given date interval.
- status? string - Only return payouts that have the given status:
pending,paid,failed, orcanceled.
stripe: GetPlansPlanQueries
Represents the Queries record for the operation: GetPlansPlan
Fields
- expand? GetPlansPlanQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetPlansQueries
Represents the Queries record for the operation: GetPlans
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetPlansQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- product? string - Only return plans for the given product.
- created? created_25 - A filter on the list, based on the object
createdfield. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- active? boolean - Only return plans that are active or inactive (e.g., pass
falseto list all inactive plans).
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetPricesPriceQueries
Represents the Queries record for the operation: GetPricesPrice
Fields
- expand? GetPricesPriceQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetPricesQueries
Represents the Queries record for the operation: GetPrices
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetPricesQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- product? string - Only return prices for the given product.
- created? created_26 - A filter on the list, based on the object
createdfield. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
- recurring? all_prices_recurring_params - Only return prices with these recurring fields.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- active? boolean - Only return prices that are active or inactive (e.g., pass
falseto list all inactive prices).
- currency? string - Only return prices for the given currency.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- lookup_keys? GetPricesQueriesLookupkeysItemsString[] - Only return the price with these lookup_keys, if any exist. You can specify up to 10 lookup_keys.
- 'type? "one_time"|"recurring" - Only return prices of type
recurringorone_time.
stripe: GetPricesSearchQueries
Represents the Queries record for the operation: GetPricesSearch
Fields
- expand? GetPricesSearchQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- query string - The search query string. See search query language and the list of supported query fields for prices.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- page? string - A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
stripe: GetProductsIdQueries
Represents the Queries record for the operation: GetProductsId
Fields
- expand? GetProductsIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetProductsProductFeaturesIdQueries
Represents the Queries record for the operation: GetProductsProductFeaturesId
Fields
- expand? GetProductsProductFeaturesIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetProductsProductFeaturesQueries
Represents the Queries record for the operation: GetProductsProductFeatures
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetProductsProductFeaturesQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetProductsQueries
Represents the Queries record for the operation: GetProducts
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetProductsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- shippable? boolean - Only return products that can be shipped (i.e., physical, not digital products).
- created? created_27 - Only return products that were created during the given date interval.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- active? boolean - Only return products that are active or inactive (e.g., pass
falseto list all inactive products).
- ids? GetProductsQueriesIdsItemsString[] - Only return products with the given IDs. Cannot be used with starting_after or ending_before.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- url? string - Only return products with the given url.
stripe: GetProductsSearchQueries
Represents the Queries record for the operation: GetProductsSearch
Fields
- expand? GetProductsSearchQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- query string - The search query string. See search query language and the list of supported query fields for products.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- page? string - A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
stripe: GetPromotionCodesPromotionCodeQueries
Represents the Queries record for the operation: GetPromotionCodesPromotionCode
Fields
- expand? GetPromotionCodesPromotionCodeQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetPromotionCodesQueries
Represents the Queries record for the operation: GetPromotionCodes
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetPromotionCodesQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- code? string - Only return promotion codes that have this case-insensitive code.
- coupon? string - Only return promotion codes for this coupon.
- created? created_28 - A filter on the list, based on the object
createdfield. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- active? boolean - Filter promotion codes by whether they are active.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- customer? string - Only return promotion codes that are restricted to this customer.
stripe: GetQuotesQueries
Represents the Queries record for the operation: GetQuotes
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetQuotesQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- test_clock? string - Provides a list of quotes that are associated with the specified test clock. The response will not include quotes with test clocks if this and the customer parameter is not set.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- customer? string - The ID of the customer whose quotes will be retrieved.
- status? "accepted"|"canceled"|"draft"|"open" - The status of the quote.
stripe: GetQuotesQuoteComputedUpfrontLineItemsQueries
Represents the Queries record for the operation: GetQuotesQuoteComputedUpfrontLineItems
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetQuotesQuoteComputedUpfrontLineItemsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetQuotesQuoteLineItemsQueries
Represents the Queries record for the operation: GetQuotesQuoteLineItems
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetQuotesQuoteLineItemsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetQuotesQuotePdfQueries
Represents the Queries record for the operation: GetQuotesQuotePdf
Fields
- expand? GetQuotesQuotePdfQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetQuotesQuoteQueries
Represents the Queries record for the operation: GetQuotesQuote
Fields
- expand? GetQuotesQuoteQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetRadarEarlyFraudWarningsEarlyFraudWarningQueries
Represents the Queries record for the operation: GetRadarEarlyFraudWarningsEarlyFraudWarning
Fields
- expand? GetRadarEarlyFraudWarningsEarlyFraudWarningQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetRadarEarlyFraudWarningsQueries
Represents the Queries record for the operation: GetRadarEarlyFraudWarnings
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetRadarEarlyFraudWarningsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- charge? string - Only return early fraud warnings for the charge specified by this charge ID.
- created? created_29 - Only return early fraud warnings that were created during the given date interval.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- payment_intent? string - Only return early fraud warnings for charges that were created by the PaymentIntent specified by this PaymentIntent ID.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetRadarValueListItemsItemQueries
Represents the Queries record for the operation: GetRadarValueListItemsItem
Fields
- expand? GetRadarValueListItemsItemQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetRadarValueListItemsQueries
Represents the Queries record for the operation: GetRadarValueListItems
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetRadarValueListItemsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- created? created_30 - Only return items that were created during the given date interval.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- value_list string - Identifier for the parent value list this item belongs to.
- value? string - Return items belonging to the parent list whose value matches the specified value (using an "is like" match).
stripe: GetRadarValueListsQueries
Represents the Queries record for the operation: GetRadarValueLists
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- contains? string - A value contained within a value list - returns all value lists containing this value.
- expand? GetRadarValueListsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- created? created_31 - Only return value lists that were created during the given date interval.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- alias? string - The alias used to reference the value list when writing rules.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetRadarValueListsValueListQueries
Represents the Queries record for the operation: GetRadarValueListsValueList
Fields
- expand? GetRadarValueListsValueListQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetRefundsQueries
Represents the Queries record for the operation: GetRefunds
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetRefundsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- charge? string - Only return refunds for the charge specified by this charge ID.
- created? created_32 - Only return refunds that were created during the given date interval.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- payment_intent? string - Only return refunds for the PaymentIntent specified by this ID.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetRefundsRefundQueries
Represents the Queries record for the operation: GetRefundsRefund
Fields
- expand? GetRefundsRefundQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetReportingReportRunsQueries
Represents the Queries record for the operation: GetReportingReportRuns
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetReportingReportRunsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- created? created_33 - Only return Report Runs that were created during the given date interval.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetReportingReportRunsReportRunQueries
Represents the Queries record for the operation: GetReportingReportRunsReportRun
Fields
- expand? GetReportingReportRunsReportRunQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetReportingReportTypesQueries
Represents the Queries record for the operation: GetReportingReportTypes
Fields
- expand? GetReportingReportTypesQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetReportingReportTypesReportTypeQueries
Represents the Queries record for the operation: GetReportingReportTypesReportType
Fields
- expand? GetReportingReportTypesReportTypeQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetReviewsQueries
Represents the Queries record for the operation: GetReviews
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetReviewsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- created? created_34 - Only return reviews that were created during the given date interval.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetReviewsReviewQueries
Represents the Queries record for the operation: GetReviewsReview
Fields
- expand? GetReviewsReviewQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetSetupAttemptsQueries
Represents the Queries record for the operation: GetSetupAttempts
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetSetupAttemptsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- setup_intent string - Only return SetupAttempts created by the SetupIntent specified by this ID.
- created? created_35 - A filter on the list, based on the object
createdfield. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetSetupIntentsIntentQueries
Represents the Queries record for the operation: GetSetupIntentsIntent
Fields
- expand? GetSetupIntentsIntentQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- client_secret? string - The client secret of the SetupIntent. We require this string if you use a publishable key to retrieve the SetupIntent.
stripe: GetSetupIntentsQueries
Represents the Queries record for the operation: GetSetupIntents
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetSetupIntentsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- created? created_36 - A filter on the list, based on the object
createdfield. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- attach_to_self? boolean - If present, the SetupIntent's payment method will be attached to the in-context Stripe Account. It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- payment_method? string - Only return SetupIntents that associate with the specified payment method.
- customer? string - Only return SetupIntents for the customer specified by this customer ID.
stripe: GetShippingRatesQueries
Represents the Queries record for the operation: GetShippingRates
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetShippingRatesQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- created? created_37 - A filter on the list, based on the object
createdfield. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- active? boolean - Only return shipping rates that are active or inactive.
- currency? string - Only return shipping rates for the given currency.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetShippingRatesShippingRateTokenQueries
Represents the Queries record for the operation: GetShippingRatesShippingRateToken
Fields
- expand? GetShippingRatesShippingRateTokenQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetSigmaScheduledQueryRunsQueries
Represents the Queries record for the operation: GetSigmaScheduledQueryRuns
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetSigmaScheduledQueryRunsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetSigmaScheduledQueryRunsScheduledQueryRunQueries
Represents the Queries record for the operation: GetSigmaScheduledQueryRunsScheduledQueryRun
Fields
- expand? GetSigmaScheduledQueryRunsScheduledQueryRunQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetSourcesSourceMandateNotificationsMandateNotificationQueries
Represents the Queries record for the operation: GetSourcesSourceMandateNotificationsMandateNotification
Fields
- expand? GetSourcesSourceMandateNotificationsMandateNotificationQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetSourcesSourceQueries
Represents the Queries record for the operation: GetSourcesSource
Fields
- expand? GetSourcesSourceQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- client_secret? string - The client secret of the source. Required if a publishable key is used to retrieve the source.
stripe: GetSourcesSourceSourceTransactionsQueries
Represents the Queries record for the operation: GetSourcesSourceSourceTransactions
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetSourcesSourceSourceTransactionsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetSourcesSourceSourceTransactionsSourceTransactionQueries
Represents the Queries record for the operation: GetSourcesSourceSourceTransactionsSourceTransaction
Fields
- expand? GetSourcesSourceSourceTransactionsSourceTransactionQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetSubscriptionItemsItemQueries
Represents the Queries record for the operation: GetSubscriptionItemsItem
Fields
- expand? GetSubscriptionItemsItemQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetSubscriptionItemsQueries
Represents the Queries record for the operation: GetSubscriptionItems
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetSubscriptionItemsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- subscription string - The ID of the subscription whose items will be retrieved.
stripe: GetSubscriptionItemsSubscriptionItemUsageRecordSummariesQueries
Represents the Queries record for the operation: GetSubscriptionItemsSubscriptionItemUsageRecordSummaries
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetSubscriptionItemsSubscriptionItemUsageRecordSummariesQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetSubscriptionSchedulesQueries
Represents the Queries record for the operation: GetSubscriptionSchedules
Fields
- completed_at? completed_at - Only return subscription schedules that completed during the given date interval.
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetSubscriptionSchedulesQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- canceled_at? canceled_at - Only return subscription schedules that were created canceled the given date interval.
- created? created_38 - Only return subscription schedules that were created during the given date interval.
- scheduled? boolean - Only return subscription schedules that have not started yet.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- released_at? released_at - Only return subscription schedules that were released during the given date interval.
- customer? string - Only return subscription schedules for the given customer.
stripe: GetSubscriptionSchedulesScheduleQueries
Represents the Queries record for the operation: GetSubscriptionSchedulesSchedule
Fields
- expand? GetSubscriptionSchedulesScheduleQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetSubscriptionsQueries
Represents the Queries record for the operation: GetSubscriptions
Fields
- test_clock? string - Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set.
- created? created_39 - Only return subscriptions that were created during the given date interval.
- current_period_end? current_period_end -
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetSubscriptionsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- automatic_tax? automatic_tax_filter_params - Filter subscriptions by their automatic tax settings.
- price? string - Filter for subscriptions that contain this recurring price ID.
- collection_method? "charge_automatically"|"send_invoice" - The collection method of the subscriptions to retrieve. Either
charge_automaticallyorsend_invoice.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- current_period_start? current_period_start -
- customer? string - The ID of the customer whose subscriptions will be retrieved.
- status? "active"|"all"|"canceled"|"ended"|"incomplete"|"incomplete_expired"|"past_due"|"paused"|"trialing"|"unpaid" - The status of the subscriptions to retrieve. Passing in a value of
canceledwill return all canceled subscriptions, including those belonging to deleted customers. Passendedto find subscriptions that are canceled and subscriptions that are expired due to incomplete payment. Passing in a value ofallwill return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.
stripe: GetSubscriptionsSearchQueries
Represents the Queries record for the operation: GetSubscriptionsSearch
Fields
- expand? GetSubscriptionsSearchQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- query string - The search query string. See search query language and the list of supported query fields for subscriptions.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- page? string - A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
stripe: GetSubscriptionsSubscriptionExposedIdQueries
Represents the Queries record for the operation: GetSubscriptionsSubscriptionExposedId
Fields
- expand? GetSubscriptionsSubscriptionExposedIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetTaxCalculationsCalculationLineItemsQueries
Represents the Queries record for the operation: GetTaxCalculationsCalculationLineItems
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetTaxCalculationsCalculationLineItemsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetTaxCodesIdQueries
Represents the Queries record for the operation: GetTaxCodesId
Fields
- expand? GetTaxCodesIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetTaxCodesQueries
Represents the Queries record for the operation: GetTaxCodes
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetTaxCodesQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetTaxIdsIdQueries
Represents the Queries record for the operation: GetTaxIdsId
Fields
- expand? GetTaxIdsIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetTaxIdsQueries
Represents the Queries record for the operation: GetTaxIds
Fields
- owner? owner_params - The account or customer the tax ID belongs to. Defaults to
owner[type]=self.
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetTaxIdsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetTaxRatesQueries
Represents the Queries record for the operation: GetTaxRates
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- inclusive? boolean - Optional flag to filter by tax rates that are inclusive (or those that are not inclusive).
- expand? GetTaxRatesQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- created? created_40 - Optional range for filtering created date.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- active? boolean - Optional flag to filter by tax rates that are either active or inactive (archived).
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetTaxRatesTaxRateQueries
Represents the Queries record for the operation: GetTaxRatesTaxRate
Fields
- expand? GetTaxRatesTaxRateQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetTaxRegistrationsIdQueries
Represents the Queries record for the operation: GetTaxRegistrationsId
Fields
- expand? GetTaxRegistrationsIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetTaxRegistrationsQueries
Represents the Queries record for the operation: GetTaxRegistrations
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetTaxRegistrationsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- status? "active"|"all"|"expired"|"scheduled" - The status of the Tax Registration.
stripe: GetTaxSettingsQueries
Represents the Queries record for the operation: GetTaxSettings
Fields
- expand? GetTaxSettingsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetTaxTransactionsTransactionLineItemsQueries
Represents the Queries record for the operation: GetTaxTransactionsTransactionLineItems
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetTaxTransactionsTransactionLineItemsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetTaxTransactionsTransactionQueries
Represents the Queries record for the operation: GetTaxTransactionsTransaction
Fields
- expand? GetTaxTransactionsTransactionQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetTerminalConfigurationsConfigurationQueries
Represents the Queries record for the operation: GetTerminalConfigurationsConfiguration
Fields
- expand? GetTerminalConfigurationsConfigurationQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetTerminalConfigurationsQueries
Represents the Queries record for the operation: GetTerminalConfigurations
Fields
- is_account_default? boolean - if present, only return the account default or non-default configurations.
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetTerminalConfigurationsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetTerminalLocationsLocationQueries
Represents the Queries record for the operation: GetTerminalLocationsLocation
Fields
- expand? GetTerminalLocationsLocationQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetTerminalLocationsQueries
Represents the Queries record for the operation: GetTerminalLocations
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetTerminalLocationsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetTerminalReadersQueries
Represents the Queries record for the operation: GetTerminalReaders
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetTerminalReadersQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- device_type? "bbpos_chipper2x"|"bbpos_wisepad3"|"bbpos_wisepos_e"|"mobile_phone_reader"|"simulated_wisepos_e"|"stripe_m2"|"verifone_P400" - Filters readers by device type
- location? string - A location ID to filter the response list to only readers at the specific location
- serial_number? string - Filters readers by serial number
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- status? "offline"|"online" - A status filter to filter readers to only offline or online readers
stripe: GetTerminalReadersReaderQueries
Represents the Queries record for the operation: GetTerminalReadersReader
Fields
- expand? GetTerminalReadersReaderQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetTestHelpersTestClocksQueries
Represents the Queries record for the operation: GetTestHelpersTestClocks
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetTestHelpersTestClocksQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetTestHelpersTestClocksTestClockQueries
Represents the Queries record for the operation: GetTestHelpersTestClocksTestClock
Fields
- expand? GetTestHelpersTestClocksTestClockQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetTokensTokenQueries
Represents the Queries record for the operation: GetTokensToken
Fields
- expand? GetTokensTokenQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetTopupsQueries
Represents the Queries record for the operation: GetTopups
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- amount? amount - A positive integer representing how much to transfer.
- expand? GetTopupsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- created? created_41 - A filter on the list, based on the object
createdfield. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- status? "canceled"|"failed"|"pending"|"succeeded" - Only return top-ups that have the given status. One of
canceled,failed,pendingorsucceeded.
stripe: GetTopupsTopupQueries
Represents the Queries record for the operation: GetTopupsTopup
Fields
- expand? GetTopupsTopupQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetTransfersIdReversalsQueries
Represents the Queries record for the operation: GetTransfersIdReversals
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetTransfersIdReversalsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetTransfersQueries
Represents the Queries record for the operation: GetTransfers
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetTransfersQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- transfer_group? string - Only return transfers with the specified transfer group.
- created? created_42 - Only return transfers that were created during the given date interval.
- destination? string - Only return transfers for the destination specified by this account ID.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetTransfersTransferQueries
Represents the Queries record for the operation: GetTransfersTransfer
Fields
- expand? GetTransfersTransferQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetTransfersTransferReversalsIdQueries
Represents the Queries record for the operation: GetTransfersTransferReversalsId
Fields
- expand? GetTransfersTransferReversalsIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetTreasuryCreditReversalsCreditReversalQueries
Represents the Queries record for the operation: GetTreasuryCreditReversalsCreditReversal
Fields
- expand? GetTreasuryCreditReversalsCreditReversalQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetTreasuryCreditReversalsQueries
Represents the Queries record for the operation: GetTreasuryCreditReversals
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- financial_account string - Returns objects associated with this FinancialAccount.
- expand? GetTreasuryCreditReversalsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- received_credit? string - Only return CreditReversals for the ReceivedCredit ID.
- status? "canceled"|"posted"|"processing" - Only return CreditReversals for a given status.
stripe: GetTreasuryDebitReversalsDebitReversalQueries
Represents the Queries record for the operation: GetTreasuryDebitReversalsDebitReversal
Fields
- expand? GetTreasuryDebitReversalsDebitReversalQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetTreasuryDebitReversalsQueries
Represents the Queries record for the operation: GetTreasuryDebitReversals
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- financial_account string - Returns objects associated with this FinancialAccount.
- expand? GetTreasuryDebitReversalsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- resolution? "lost"|"won" - Only return DebitReversals for a given resolution.
- received_debit? string - Only return DebitReversals for the ReceivedDebit ID.
- status? "canceled"|"completed"|"processing" - Only return DebitReversals for a given status.
stripe: GetTreasuryFinancialAccountsFinancialAccountFeaturesQueries
Represents the Queries record for the operation: GetTreasuryFinancialAccountsFinancialAccountFeatures
Fields
- expand? GetTreasuryFinancialAccountsFinancialAccountFeaturesQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetTreasuryFinancialAccountsFinancialAccountQueries
Represents the Queries record for the operation: GetTreasuryFinancialAccountsFinancialAccount
Fields
- expand? GetTreasuryFinancialAccountsFinancialAccountQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetTreasuryFinancialAccountsQueries
Represents the Queries record for the operation: GetTreasuryFinancialAccounts
Fields
- ending_before? string - An object ID cursor for use in pagination.
- expand? GetTreasuryFinancialAccountsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- created? created_43 - Only return FinancialAccounts that were created during the given date interval.
- 'limit? int - A limit ranging from 1 to 100 (defaults to 10).
- starting_after? string - An object ID cursor for use in pagination.
stripe: GetTreasuryInboundTransfersIdQueries
Represents the Queries record for the operation: GetTreasuryInboundTransfersId
Fields
- expand? GetTreasuryInboundTransfersIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetTreasuryInboundTransfersQueries
Represents the Queries record for the operation: GetTreasuryInboundTransfers
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- financial_account string - Returns objects associated with this FinancialAccount.
- expand? GetTreasuryInboundTransfersQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- status? "canceled"|"failed"|"processing"|"succeeded" - Only return InboundTransfers that have the given status:
processing,succeeded,failedorcanceled.
stripe: GetTreasuryOutboundPaymentsIdQueries
Represents the Queries record for the operation: GetTreasuryOutboundPaymentsId
Fields
- expand? GetTreasuryOutboundPaymentsIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetTreasuryOutboundPaymentsQueries
Represents the Queries record for the operation: GetTreasuryOutboundPayments
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- financial_account string - Returns objects associated with this FinancialAccount.
- expand? GetTreasuryOutboundPaymentsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- created? created_44 - Only return OutboundPayments that were created during the given date interval.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- customer? string - Only return OutboundPayments sent to this customer.
- status? "canceled"|"failed"|"posted"|"processing"|"returned" - Only return OutboundPayments that have the given status:
processing,failed,posted,returned, orcanceled.
stripe: GetTreasuryOutboundTransfersOutboundTransferQueries
Represents the Queries record for the operation: GetTreasuryOutboundTransfersOutboundTransfer
Fields
- expand? GetTreasuryOutboundTransfersOutboundTransferQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetTreasuryOutboundTransfersQueries
Represents the Queries record for the operation: GetTreasuryOutboundTransfers
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- financial_account string - Returns objects associated with this FinancialAccount.
- expand? GetTreasuryOutboundTransfersQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- status? "canceled"|"failed"|"posted"|"processing"|"returned" - Only return OutboundTransfers that have the given status:
processing,canceled,failed,posted, orreturned.
stripe: GetTreasuryReceivedCreditsIdQueries
Represents the Queries record for the operation: GetTreasuryReceivedCreditsId
Fields
- expand? GetTreasuryReceivedCreditsIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetTreasuryReceivedCreditsQueries
Represents the Queries record for the operation: GetTreasuryReceivedCredits
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- financial_account string - The FinancialAccount that received the funds.
- expand? GetTreasuryReceivedCreditsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- linked_flows? linked_flows_param - Only return ReceivedCredits described by the flow.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- status? "failed"|"succeeded" - Only return ReceivedCredits that have the given status:
succeededorfailed.
stripe: GetTreasuryReceivedDebitsIdQueries
Represents the Queries record for the operation: GetTreasuryReceivedDebitsId
Fields
- expand? GetTreasuryReceivedDebitsIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetTreasuryReceivedDebitsQueries
Represents the Queries record for the operation: GetTreasuryReceivedDebits
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- financial_account string - The FinancialAccount that funds were pulled from.
- expand? GetTreasuryReceivedDebitsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- status? "failed"|"succeeded" - Only return ReceivedDebits that have the given status:
succeededorfailed.
stripe: GetTreasuryTransactionEntriesIdQueries
Represents the Queries record for the operation: GetTreasuryTransactionEntriesId
Fields
- expand? GetTreasuryTransactionEntriesIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetTreasuryTransactionEntriesQueries
Represents the Queries record for the operation: GetTreasuryTransactionEntries
Fields
- effective_at? effective_at -
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- financial_account string - Returns objects associated with this FinancialAccount.
- expand? GetTreasuryTransactionEntriesQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- created? created_45 - Only return TransactionEntries that were created during the given date interval.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- order_by? "created"|"effective_at" - The results are in reverse chronological order by
createdoreffective_at. The default iscreated.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- 'transaction? string - Only return TransactionEntries associated with this Transaction.
stripe: GetTreasuryTransactionsIdQueries
Represents the Queries record for the operation: GetTreasuryTransactionsId
Fields
- expand? GetTreasuryTransactionsIdQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: GetTreasuryTransactionsQueries
Represents the Queries record for the operation: GetTreasuryTransactions
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- financial_account string - Returns objects associated with this FinancialAccount.
- expand? GetTreasuryTransactionsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- created? created_46 - Only return Transactions that were created during the given date interval.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- order_by? "created"|"posted_at" - The results are in reverse chronological order by
createdorposted_at. The default iscreated.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
- status_transitions? status_transition_timestamp_specs - A filter for the
status_transitions.posted_attimestamp. When using this filter,status=postedandorder_by=posted_atmust also be specified.
- status? "open"|"posted"|"void" - Only return Transactions that have the given status:
open,posted, orvoid.
stripe: GetWebhookEndpointsQueries
Represents the Queries record for the operation: GetWebhookEndpoints
Fields
- ending_before? string - A cursor for use in pagination.
ending_beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withobj_bar, your subsequent call can includeending_before=obj_barin order to fetch the previous page of the list.
- expand? GetWebhookEndpointsQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
- 'limit? int - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after? string - A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
stripe: GetWebhookEndpointsWebhookEndpointQueries
Represents the Queries record for the operation: GetWebhookEndpointsWebhookEndpoint
Fields
- expand? GetWebhookEndpointsWebhookEndpointQueriesExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: head_office_param
The place where your business is located.
Fields
- address validated_country_address -
stripe: header_param
Fields
- name string -
- value string -
stripe: id_cancel_body
Closed record
Fields
- expand? id_cancel_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: id_deactivate_body
Closed record
Fields
- expand? id_deactivate_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: id_fail_body
Closed record
Fields
- expand? id_fail_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- failure_details? failure_details_params -
stripe: id_fail_body_1
Closed record
Fields
- expand? id_fail_body_1ExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: id_post_body
Closed record
Fields
- expand? id_post_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: id_reactivate_body
Closed record
Fields
- expand? id_reactivate_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: id_refund_body
Closed record
Fields
- amount? int -
- directive? string -
- expand? id_refund_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: id_refunds_body
Closed record
Fields
- amount? int - A positive integer, in cents (or local equivalent), representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee.
- expand? id_refunds_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- metadata? record { string... } - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
stripe: id_return_body
Closed record
Fields
- expand? id_return_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: id_return_body_1
Closed record
Fields
- expand? id_return_body_1ExpandItemsString[] - Specifies which fields in the response should be expanded.
- returned_details? returned_details_params -
stripe: id_reversals_body
Closed record
Fields
- amount? int - A positive integer in cents (or local equivalent) representing how much of this transfer to reverse. Can only reverse up to the unreversed amount remaining of the transfer. Partial transfer reversals are only allowed for transfers to Stripe Accounts. Defaults to the entire transfer amount.
- description? string - An arbitrary string which you can attach to a reversal object. This will be unset if you POST an empty value.
- expand? id_reversals_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- refund_application_fee? boolean - Boolean indicating whether the application fee should be refunded when reversing this transfer. If a full transfer reversal is given, the full application fee will be refunded. Otherwise, the application fee will be refunded with an amount proportional to the amount of the transfer reversed.
stripe: id_succeed_body
Closed record
Fields
- expand? id_succeed_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: id_verify_body
Closed record
Fields
- amounts? int[] - Two positive integers, in cents, equal to the values of the microdeposits sent to the bank account.
- expand? id_verify_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: id_verify_body_1
Closed record
Fields
- amounts? int[] - Two positive integers, in cents, equal to the values of the microdeposits sent to the bank account.
- expand? id_verify_body_1ExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: id_void_body
Closed record
Fields
- expand? id_void_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: Identity\.verification_report
Fields
- client_reference_id? string? -
- created int -
- document? Gelato_document_report -
- email? Gelato_email_report -
- id string -
- id_number? Gelato_id_number_report -
- livemode boolean -
- 'object "identity.verification_report" -
- options? Gelato_verification_report_options -
- phone? Gelato_phone_report -
- selfie? Gelato_selfie_report -
- 'type "document"|"id_number"|"verification_flow" -
- verification_flow? string -
- verification_session? string? -
stripe: Identity\.verification_session
Fields
- client_reference_id? string? -
- client_secret? string? -
- created int -
- id string -
- last_error? Gelato_session_last_error? -
- last_verification_report? string|Identity\.verification_report? -
- livemode boolean -
- metadata record { string... } -
- 'object "identity.verification_session" -
- options? Gelato_verification_session_options? -
- provided_details? Gelato_provided_details? -
- redaction? Verification_session_redaction? -
- status "canceled"|"processing"|"requires_input"|"verified" -
- 'type "document"|"id_number"|"verification_flow" -
- url? string? -
- verification_flow? string -
- verified_outputs? Gelato_verified_outputs? -
stripe: identity_verification_sessions_body
Closed record
Fields
- client_reference_id? string - A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
- expand? identity_verification_sessions_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- metadata? record { string... } - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- options? session_options_param -
- provided_details? provided_details_param -
- return_url? string - The URL that the user will be redirected to upon completing the verification flow.
- 'type? "document"|"id_number" - The type of verification check to be performed. You must provide a
typeif not passingverification_flow.
- verification_flow? string - The ID of a Verification Flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows.
stripe: inbound_transfer_cancel_body
Closed record
Fields
- expand? inbound_transfer_cancel_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: Inbound_transfers
Fields
- billing_details Treasury_shared_resource_billing_details -
- 'type "us_bank_account" - The type of the payment method used in the InboundTransfer.
- us_bank_account? Inbound_transfers_payment_method_details_us_bank_account -
stripe: inbound_transfers
Fields
- ach? access_with_ach_details -
stripe: inbound_transfers_1
Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.
Fields
- ach? access_with_ach_details -
stripe: Inbound_transfers_payment_method_details_us_bank_account
Fields
- account_holder_type? "company"|"individual"? - Account holder type: individual or company.
- account_type? "checking"|"savings"? - Account type: checkings or savings. Defaults to checking if omitted.
- bank_name? string? - Name of the bank associated with the bank account.
- fingerprint? string? - Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
- last4? string? - Last four digits of the bank account number.
- network "ach" - The network rails used. See the docs to learn more about money movement timelines for each network type.
- routing_number? string? - Routing number of the bank account.
stripe: individual_param
Additional information about an individual cardholder.
Fields
- card_issuing? card_issuing_param -
- dob? date_of_birth_specs -
- first_name? string -
- last_name? string -
- verification? person_verification_param -
stripe: individual_relationship_specs
Fields
- director? boolean -
- executive? boolean -
- owner? boolean -
- percent_ownership? decimal|"" -
- title? string -
stripe: individual_specs
Information about the person represented by the account. This field is null unless business_type is set to individual. Once you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is application, which includes Custom accounts.
Fields
- address? address_specs -
- address_kana? japan_address_kana_specs -
- address_kanji? japan_address_kanji_specs -
- email? string -
- first_name? string -
- first_name_kana? string -
- first_name_kanji? string -
- full_name_aliases? FullnamealiasesItemsString[]|"" -
- gender? string -
- id_number? string -
- id_number_secondary? string -
- last_name? string -
- last_name_kana? string -
- last_name_kanji? string -
- maiden_name? string -
- metadata? record { string... }|"" -
- phone? string -
- political_exposure? "existing"|"none" -
- registered_address? address_specs -
- relationship? individual_relationship_specs -
- ssn_last_4? string -
- verification? person_verification_specs -
stripe: individual_specs_1
Fields
- address? address_specs -
- address_kana? japan_address_kana_specs -
- address_kanji? japan_address_kanji_specs -
- email? string -
- first_name? string -
- first_name_kana? string -
- first_name_kanji? string -
- full_name_aliases? FullnamealiasesItemsString[]|"" -
- gender? string -
- id_number? string -
- id_number_secondary? string -
- last_name? string -
- last_name_kana? string -
- last_name_kanji? string -
- maiden_name? string -
- metadata? record { string... }|"" -
- phone? string -
- political_exposure? "existing"|"none" -
- registered_address? address_specs -
- relationship? individual_relationship_specs -
- ssn_last_4? string -
- verification? person_verification_specs -
stripe: inline_product_params
These fields can be used to create a new product that this price will belong to.
Fields
- active? boolean -
- id? string -
- metadata? record { string... } -
- name string -
- statement_descriptor? string -
- tax_code? string -
- unit_label? string -
stripe: installments_param
Fields
- enabled? boolean -
stripe: intent_apply_customer_balance_body
Closed record
Fields
- amount? int - Amount that you intend to apply to this PaymentIntent from the customer’s cash balance. A positive integer representing how much to charge in the smallest currency unit (for example, 100 cents to charge 1 USD or 100 to charge 100 JPY, a zero-decimal currency). The maximum amount is the amount of the PaymentIntent. When you omit the amount, it defaults to the remaining amount requested on the PaymentIntent.
- currency? string - Three-letter ISO currency code, in lowercase. Must be a supported currency.
- expand? intent_apply_customer_balance_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: intent_cancel_body
Closed record
Fields
- cancellation_reason? "abandoned"|"duplicate"|"fraudulent"|"requested_by_customer" - Reason for canceling this PaymentIntent. Possible values are:
duplicate,fraudulent,requested_by_customer, orabandoned
- expand? intent_cancel_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: intent_cancel_body_1
Closed record
Fields
- cancellation_reason? "abandoned"|"duplicate"|"requested_by_customer" - Reason for canceling this SetupIntent. Possible values are:
abandoned,requested_by_customer, orduplicate
- expand? intent_cancel_body_1ExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: intent_capture_body
Closed record
Fields
- amount_to_capture? int - The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Any additional amount is automatically refunded. Defaults to the full
amount_capturableif it's not provided.
- application_fee_amount? int - The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents use case for connected accounts.
- expand? intent_capture_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- final_capture? boolean - Defaults to
true. When capturing a PaymentIntent, settingfinal_capturetofalsenotifies Stripe to not release the remaining uncaptured funds to make sure that they're captured in future requests. You can only use this setting when multicapture is available for PaymentIntents.
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- statement_descriptor? string - For card charges, use statement_descriptor_suffix. Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long.
- statement_descriptor_suffix? string - Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. The concatenated descriptor must be 1-22 characters long.
- transfer_data? transfer_data_update_params_1 -
stripe: intent_confirm_body
Closed record
Fields
- capture_method? "automatic"|"automatic_async"|"manual" - Controls when the funds will be captured from the customer's account.
- client_secret? string - The client secret of the PaymentIntent.
- confirmation_token? string - ID of the ConfirmationToken used to confirm this PaymentIntent.
If the provided ConfirmationToken contains properties that are also being provided in this request, such as
payment_method, then the values in this request will take precedence.
- error_on_requires_action? boolean - Set to
trueto fail the payment attempt if the PaymentIntent transitions intorequires_action. This parameter is intended for simpler integrations that do not handle customer actions, like saving cards without authentication.
- expand? intent_confirm_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- mandate? string - ID of the mandate that's used for this payment.
- off_session? boolean|"one_off"|"recurring" - Set to
trueto indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and charge them later.
- payment_method? string - ID of the payment method (a PaymentMethod, Card, or compatible Source object) to attach to this PaymentIntent.
- payment_method_data? payment_method_data_params -
- payment_method_options? payment_method_options_param_14 -
- payment_method_types? intent_confirm_bodyPaymentmethodtypesItemsString[] - The list of payment method types (for example, a card) that this PaymentIntent can use. Use
automatic_payment_methodsto manage payment methods from the Stripe Dashboard.
- radar_options? radar_options_with_hidden_options_2 -
- receipt_email? string|"" - Email address that the receipt for the resulting payment will be sent to. If
receipt_emailis specified for a payment in live mode, a receipt will be sent regardless of your email settings.
- return_url? string - The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter is only used for cards and other redirect-based payment methods.
- setup_future_usage? ""|"off_session"|"on_session" - Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses
setup_future_usageto dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA. Ifsetup_future_usageis already set and you are performing a request using a publishable key, you may only update the value fromon_sessiontooff_session.
- use_stripe_sdk? boolean - Set to
truewhen confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
stripe: intent_confirm_body_1
Closed record
Fields
- client_secret? string - The client secret of the SetupIntent.
- confirmation_token? string - ID of the ConfirmationToken used to confirm this SetupIntent.
If the provided ConfirmationToken contains properties that are also being provided in this request, such as
payment_method, then the values in this request will take precedence.
- expand? intent_confirm_body_1ExpandItemsString[] - Specifies which fields in the response should be expanded.
- payment_method? string - ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.
- payment_method_data? payment_method_data_params_1 -
- payment_method_options? payment_method_options_param_16 -
- return_url? string - The URL to redirect your customer back to after they authenticate on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter is only used for cards and other redirect-based payment methods.
- use_stripe_sdk? boolean - Set to
truewhen confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
stripe: intent_increment_authorization_body
Closed record
Fields
- amount int - The updated total amount that you intend to collect from the cardholder. This amount must be greater than the currently authorized amount.
- application_fee_amount? int - The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents use case for connected accounts.
- description? string - An arbitrary string attached to the object. Often useful for displaying to users.
- expand? intent_increment_authorization_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- metadata? record { string... } - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- statement_descriptor? string - For card charges, use statement_descriptor_suffix. Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long.
- transfer_data? transfer_data_update_params_2 -
stripe: intent_verify_microdeposits_body
Closed record
Fields
- amounts? int[] - Two positive integers, in cents, equal to the values of the microdeposits sent to the bank account.
- client_secret? string - The client secret of the PaymentIntent.
- descriptor_code? string - A six-character code starting with SM present in the microdeposit sent to the bank account.
- expand? intent_verify_microdeposits_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: intent_verify_microdeposits_body_1
Closed record
Fields
- amounts? int[] - Two positive integers, in cents, equal to the values of the microdeposits sent to the bank account.
- client_secret? string - The client secret of the SetupIntent.
- descriptor_code? string - A six-character code starting with SM present in the microdeposit sent to the bank account.
- expand? intent_verify_microdeposits_body_1ExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: interac_present
Simulated data for the interac_present payment method.
Fields
- number? string -
stripe: Internal_card
Fields
- brand? string? - Brand of the card used in the transaction
- country? string? - Two-letter ISO code representing the country of the card
- exp_month? int? - Two digit number representing the card's expiration month
- exp_year? int? - Two digit number representing the card's expiration year
- last4? string? - The last 4 digits of the card
stripe: Invoice
Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription.
They contain invoice items, and proration adjustments that may be caused by subscription upgrades/downgrades (if necessary).
If your invoice is configured to be billed through automatic charges, Stripe automatically finalizes your invoice and attempts payment. Note that finalizing the invoice, when automatic, does not happen immediately as the invoice is created. Stripe waits until one hour after the last webhook was successfully sent (or the last webhook timed out after failing). If you (and the platforms you may have connected to) have no webhooks configured, Stripe waits one hour after creation to finalize the invoice.
If your invoice is configured to be billed by sending an email, then based on your email settings, Stripe will email the invoice to your customer and await payment. These emails can contain a link to a hosted page to pay the invoice.
Stripe applies any customer credit on the account before determining the amount due for the invoice (i.e., the amount that will be actually charged). If the amount due for the invoice is less than Stripe's minimum allowed charge per currency, the invoice is automatically marked paid, and we add the amount due to the customer's credit balance which is applied to the next invoice.
More details on the customer's credit balance are here.
Related guide: Send invoices to customers
Fields
- account_country? string? - The country of the business associated with this invoice, most often the business creating the invoice.
- account_name? string? - The public name of the business associated with this invoice, most often the business creating the invoice.
- account_tax_ids? (string|Tax_id|Deleted_tax_id)[]? - The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
- amount_due int - Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the
amount_duemay be 0. If there is a positivestarting_balancefor the invoice (the customer owes money), theamount_duewill also take that into account. The charge that gets generated for the invoice will be for the amount specified inamount_due.
- amount_paid int - The amount, in cents (or local equivalent), that was paid.
- amount_remaining int - The difference between amount_due and amount_paid, in cents (or local equivalent).
- amount_shipping int - This is the sum of all the shipping amounts.
- application? string|Application|Deleted_application? - ID of the Connect Application that created the invoice.
- application_fee_amount? int? - The fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid.
- attempt_count int - Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.
- attempted boolean - Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the
invoice.createdwebhook, for example, so you might not want to display that invoice as unpaid to your users.
- auto_advance? boolean - Controls whether Stripe performs automatic collection of the invoice. If
false, the invoice's state doesn't automatically advance without an explicit action.
- automatic_tax Automatic_tax -
- billing_reason? "automatic_pending_invoice_item_invoice"|"manual"|"quote_accept"|"subscription"|"subscription_create"|"subscription_cycle"|"subscription_threshold"|"subscription_update"|"upcoming"? - Indicates the reason why the invoice was created.
manual: Unrelated to a subscription, for example, created via the invoice editor.subscription: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.subscription_create: A new subscription was created.subscription_cycle: A subscription advanced into a new period.subscription_threshold: A subscription reached a billing threshold.subscription_update: A subscription was updated.upcoming: Reserved for simulated invoices, per the upcoming invoice endpoint.
- collection_method "charge_automatically"|"send_invoice" - Either
charge_automatically, orsend_invoice. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.
- created int - Time at which the object was created. Measured in seconds since the Unix epoch.
- currency string - Three-letter ISO currency code, in lowercase. Must be a supported currency.
- custom_fields? Invoice_setting_custom_field[]? - Custom fields displayed on the invoice.
- customer? string|Customer|Deleted_customer? - The ID of the customer who will be billed.
- customer_address? Address? - The customer's address. Until the invoice is finalized, this field will equal
customer.address. Once the invoice is finalized, this field will no longer be updated.
- customer_email? string? - The customer's email. Until the invoice is finalized, this field will equal
customer.email. Once the invoice is finalized, this field will no longer be updated.
- customer_name? string? - The customer's name. Until the invoice is finalized, this field will equal
customer.name. Once the invoice is finalized, this field will no longer be updated.
- customer_phone? string? - The customer's phone number. Until the invoice is finalized, this field will equal
customer.phone. Once the invoice is finalized, this field will no longer be updated.
- customer_shipping? Shipping? - The customer's shipping information. Until the invoice is finalized, this field will equal
customer.shipping. Once the invoice is finalized, this field will no longer be updated.
- customer_tax_exempt? "exempt"|"none"|"reverse"? - The customer's tax exempt status. Until the invoice is finalized, this field will equal
customer.tax_exempt. Once the invoice is finalized, this field will no longer be updated.
- customer_tax_ids? Invoices_resource_invoice_tax_id[]? - The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as
customer.tax_ids. Once the invoice is finalized, this field will no longer be updated.
- default_payment_method? string|Payment_method? - ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
- default_source? string|Bank_account|Card|Source? - ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
- default_tax_rates Tax_rate[] - The tax rates applied to this invoice, if any.
- description? string? - An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
- discount? Discount? - Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts.
- discounts (string|Discount|Deleted_discount)[] - The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use
expand[]=discountsto expand each discount.
- due_date? int? - The date on which payment for this invoice is due. This value will be
nullfor invoices wherecollection_method=charge_automatically.
- effective_at? int? - The date when this invoice is in effect. Same as
finalized_atunless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
- ending_balance? int? - Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.
- from_invoice? Invoices_resource_from_invoice? - Details of the invoice that was cloned. See the revision documentation for more details.
- hosted_invoice_url? string? - The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.
- id? string - Unique identifier for the object. This property is always present unless the invoice is an upcoming invoice. See Retrieve an upcoming invoice for more details.
- invoice_pdf? string? - The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.
- issuer Connect_account_reference -
- last_finalization_error? Api_errors? - The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.
- lines InvoiceLinesList_1 -
- livemode boolean - Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode.
- metadata? record { string... }? - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- next_payment_attempt? int? - The time at which payment will next be attempted. This value will be
nullfor invoices wherecollection_method=send_invoice.
- number? string? - A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.
- 'object "invoice" - String representing the object's type. Objects of the same type share the same value.
- on_behalf_of? string|Account? - The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details.
- paid boolean - Whether payment was successfully collected for this invoice. An invoice can be paid (most commonly) with a charge or with credit from the customer's account balance.
- paid_out_of_band boolean - Returns true if the invoice was manually marked paid, returns false if the invoice hasn't been paid yet or was paid on Stripe.
- payment_intent? string|Payment_intent? - The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent.
- payment_settings Invoices_payment_settings -
- period_end int - End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the line item period to get the service period for each price.
- period_start int - Start of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the line item period to get the service period for each price.
- post_payment_credit_notes_amount int - Total amount of all post-payment credit notes issued for this invoice.
- pre_payment_credit_notes_amount int - Total amount of all pre-payment credit notes issued for this invoice.
- receipt_number? string? - This is the transaction number that appears on email receipts sent for this invoice.
- rendering? Invoices_resource_invoice_rendering? - The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
- shipping_cost? Invoices_resource_shipping_cost? - The details of the cost of shipping, including the ShippingRate applied on the invoice.
- shipping_details? Shipping? - Shipping details for the invoice. The Invoice PDF will use the
shipping_detailsvalue if it is set, otherwise the PDF will render the shipping address from the customer.
- starting_balance int - Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.
- statement_descriptor? string? - Extra information about an invoice for the customer's credit card statement.
- status? "draft"|"open"|"paid"|"uncollectible"|"void"? - The status of the invoice, one of
draft,open,paid,uncollectible, orvoid. Learn more
- status_transitions Invoices_resource_status_transitions -
- subscription? string|Subscription? - The subscription that this invoice was prepared for, if any.
- subscription_details? Subscription_details_data? - Details about the subscription that created this invoice.
- subscription_proration_date? int - Only set for upcoming invoices that preview prorations. The time used to calculate prorations.
- subtotal int - Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated
- subtotal_excluding_tax? int? - The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated
- tax? int? - The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice.
- test_clock? string|Test_helpers\.test_clock? - ID of the test clock this invoice belongs to.
- threshold_reason? Invoice_threshold_reason -
- total int - Total after discounts and taxes.
- total_discount_amounts? Discounts_resource_discount_amount[]? - The aggregate amounts calculated per discount across all line items.
- total_excluding_tax? int? - The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
- total_tax_amounts Invoice_tax_amount[] - The aggregate amounts calculated per tax rate for all line items.
- transfer_data? Invoice_transfer_data? - The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to for the invoice.
- webhooks_delivered_at? int? - Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted. This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.
stripe: invoice_add_lines_body
Closed record
Fields
- expand? invoice_add_lines_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- invoice_metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- lines lines_data_param[] - The line items to add.
stripe: invoice_creation_create_params
Generate a post-purchase Invoice for one-time payments.
Fields
- enabled boolean -
- invoice_data? invoice_settings_params_1 -
stripe: invoice_creation_params
Generate a post-purchase Invoice for one-time payments.
Fields
- enabled boolean -
- invoice_data? invoice_data_params -
stripe: invoice_creation_update_params
Generate a post-purchase Invoice for one-time payments.
Fields
- enabled boolean -
- invoice_data? invoice_settings_params_1 -
stripe: invoice_data_params
Fields
- account_tax_ids? AccounttaxidsItemsString[]|"" -
- description? string -
- issuer? param -
- metadata? record { string... } -
- rendering_options? record { amount_tax_display ""|"exclude_tax"|"include_inclusive_tax" }|"" -
stripe: invoice_finalize_body
Closed record
Fields
- auto_advance? boolean - Controls whether Stripe performs automatic collection of the invoice. If
false, the invoice's state doesn't automatically advance without an explicit action.
- expand? invoice_finalize_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: Invoice_installments_card
Fields
- enabled? boolean? - Whether Installments are enabled for this Invoice.
stripe: invoice_item_preview_params
Fields
- amount? int -
- currency? string -
- description? string -
- discountable? boolean -
- invoiceitem? string -
- metadata? record { string... }|"" -
- period? period_1 -
- price? string -
- price_data? one_time_price_data_1 -
- quantity? int -
- tax_behavior? "exclusive"|"inclusive"|"unspecified" -
- tax_code? string|"" -
- tax_rates? TaxratesItemsString[]|"" -
- unit_amount? int -
- unit_amount_decimal? string -
stripe: Invoice_item_threshold_reason
Fields
- line_item_ids Invoice_item_threshold_reasonLineitemidsItemsString[] - The IDs of the line items that triggered the threshold invoice.
- usage_gte int - The quantity threshold boundary that applied to the given line item.
stripe: Invoice_line_item_period
Fields
- end int - The end of the period, which must be greater than or equal to the start. This value is inclusive.
- 'start int - The start of the period. This value is inclusive.
stripe: invoice_list_param
Fields
- enabled boolean -
stripe: Invoice_mandate_options_card
Fields
- amount? int? - Amount to be charged for future payments.
- amount_type? "fixed"|"maximum"? - One of
fixedormaximum. Iffixed, theamountparam refers to the exact amount to be charged in future payments. Ifmaximum, the amount charged can be up to the value passed for theamountparam.
- description? string? - A description of the mandate or subscription that is meant to be displayed to the customer.
stripe: invoice_mark_uncollectible_body
Closed record
Fields
- expand? invoice_mark_uncollectible_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: invoice_pay_body
Closed record
Fields
- expand? invoice_pay_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- forgive? boolean - In cases where the source used to pay the invoice has insufficient funds, passing
forgive=truecontrols whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due. Passingforgive=falsewill fail the charge if the source hasn't been pre-funded with the right amount. An example for this case is with ACH Credit Transfers and wires: if the amount wired is less than the amount due by a small amount, you might want to forgive the difference. Defaults tofalse.
- mandate? string|"" - ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the payment_method param or the invoice's default_payment_method or default_source, if set.
- off_session? boolean - Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to
true(off-session).
- paid_out_of_band? boolean - Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to
false.
- payment_method? string - A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid.
- 'source? string - A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid.
stripe: Invoice_payment_method_options_acss_debit
Fields
- mandate_options? Invoice_payment_method_options_acss_debit_mandate_options -
- verification_method? "automatic"|"instant"|"microdeposits" - Bank account verification method.
stripe: Invoice_payment_method_options_acss_debit_mandate_options
Fields
- transaction_type? "business"|"personal"? - Transaction type of the mandate.
stripe: Invoice_payment_method_options_bancontact
Fields
- preferred_language "de"|"en"|"fr"|"nl" - Preferred language of the Bancontact authorization page that the customer is redirected to.
stripe: Invoice_payment_method_options_card
Fields
- installments? Invoice_installments_card -
- request_three_d_secure? "any"|"automatic"|"challenge"? - We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine.
stripe: Invoice_payment_method_options_customer_balance
Fields
- bank_transfer? Invoice_payment_method_options_customer_balance_bank_transfer -
- funding_type? "bank_transfer"? - The funding method type to be used when there are not enough funds in the customer balance. Permitted values include:
bank_transfer.
stripe: Invoice_payment_method_options_customer_balance_bank_transfer
Fields
- eu_bank_transfer? Invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer -
- 'type? string? - The bank transfer type that can be used for funding. Permitted values include:
eu_bank_transfer,gb_bank_transfer,jp_bank_transfer,mx_bank_transfer, orus_bank_transfer.
stripe: Invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer
Fields
- country "BE"|"DE"|"ES"|"FR"|"IE"|"NL" - The desired country code of the bank account information. Permitted values include:
BE,DE,ES,FR,IE, orNL.
stripe: Invoice_payment_method_options_konbini
stripe: Invoice_payment_method_options_sepa_debit
stripe: Invoice_payment_method_options_us_bank_account
Fields
- financial_connections? Invoice_payment_method_options_us_bank_account_linked_account_options -
- verification_method? "automatic"|"instant"|"microdeposits" - Bank account verification method.
stripe: Invoice_payment_method_options_us_bank_account_linked_account_options
Fields
- permissions? ("balances"|"ownership"|"payment_method"|"transactions")[] - The list of permissions to request. The
payment_methodpermission must be included.
- prefetch? ("balances"|"ownership"|"transactions")[]? - Data features requested to be retrieved upon account creation.
stripe: Invoice_payment_method_options_us_bank_account_linked_account_options_filters
Fields
- account_subcategories? ("checking"|"savings")[] - The account subcategories to use to filter for possible accounts to link. Valid subcategories are
checkingandsavings.
stripe: invoice_remove_lines_body
Closed record
Fields
- expand? invoice_remove_lines_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- invoice_metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- lines lines_data_param_1[] - The line items to remove.
stripe: Invoice_rendering_pdf
Fields
- page_size? "a4"|"auto"|"letter"? - Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale.
stripe: invoice_send_body
Closed record
Fields
- expand? invoice_send_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: Invoice_setting_custom_field
Fields
- name string - The name of the custom field.
- value string - The value of the custom field.
stripe: Invoice_setting_customer_rendering_options
Fields
- amount_tax_display? string? - How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
stripe: Invoice_setting_customer_setting
Fields
- custom_fields? Invoice_setting_custom_field[]? - Default custom fields to be displayed on invoices for this customer.
- default_payment_method? string|Payment_method? - ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.
- rendering_options? Invoice_setting_customer_rendering_options? - Default options for invoice PDF rendering for this customer.
stripe: Invoice_setting_quote_setting
Fields
- days_until_due? int? - Number of days within which a customer must pay invoices generated by this quote. This value will be
nullfor quotes wherecollection_method=charge_automatically.
- issuer Connect_account_reference -
stripe: Invoice_setting_rendering_options
Fields
- amount_tax_display? string? - How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
stripe: Invoice_setting_subscription_schedule_phase_setting
Fields
- account_tax_ids? (string|Tax_id|Deleted_tax_id)[]? - The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
- days_until_due? int? - Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be
nullfor subscription schedules wherebilling=charge_automatically.
- issuer? Connect_account_reference? - The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
stripe: Invoice_setting_subscription_schedule_setting
Fields
- account_tax_ids? (string|Tax_id|Deleted_tax_id)[]? - The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.
- days_until_due? int? - Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be
nullfor subscription schedules wherebilling=charge_automatically.
- issuer Connect_account_reference -
stripe: invoice_settings
Fields
- account_tax_ids? AccounttaxidsItemsString[]|"" -
- days_until_due? int -
- issuer? param -
stripe: invoice_settings_1
Fields
- account_tax_ids? AccounttaxidsItemsString[]|"" -
- days_until_due? int -
- issuer? param_2 -
stripe: invoice_settings_2
Fields
- account_tax_ids? AccounttaxidsItemsString[]|"" -
- days_until_due? int -
- issuer? param_3 -
stripe: invoice_settings_param
All invoices will be billed using the specified settings.
Fields
- account_tax_ids? AccounttaxidsItemsString[]|"" -
- issuer? param -
stripe: invoice_settings_param_1
All invoices will be billed using the specified settings.
Fields
- account_tax_ids? AccounttaxidsItemsString[]|"" -
- issuer? param_3 -
stripe: invoice_settings_params
Fields
- issuer? param -
stripe: invoice_settings_params_1
Fields
- account_tax_ids? AccounttaxidsItemsString[]|"" -
- description? string -
- issuer? param_3 -
- metadata? record { string... }|"" -
- rendering_options? record { amount_tax_display ""|"exclude_tax"|"include_inclusive_tax" }|"" -
stripe: Invoice_tax_amount
Fields
- amount int - The amount, in cents (or local equivalent), of the tax.
- inclusive boolean - Whether this tax amount is inclusive or exclusive.
- taxability_reason? "customer_exempt"|"not_collecting"|"not_subject_to_tax"|"not_supported"|"portion_product_exempt"|"portion_reduced_rated"|"portion_standard_rated"|"product_exempt"|"product_exempt_holiday"|"proportionally_rated"|"reduced_rated"|"reverse_charge"|"standard_rated"|"taxable_basis_reduced"|"zero_rated"? - The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
- taxable_amount? int? - The amount on which tax is calculated, in cents (or local equivalent).
stripe: Invoice_threshold_reason
Fields
- amount_gte? int? - The total invoice amount threshold boundary if it triggered the threshold invoice.
- item_reasons Invoice_item_threshold_reason[] - Indicates which line items triggered a threshold invoice.
stripe: Invoice_transfer_data
Fields
- amount? int? - The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination.
stripe: invoice_update_lines_body
Closed record
Fields
- expand? invoice_update_lines_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- invoice_metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata. For type=subscription line items, the incoming metadata specified on the request is directly used to set this value, in contrast to type=invoiceitem line items, where any existing metadata on the invoice line is merged with the incoming data.
- lines lines_data_param_2[] - The line items to update.
stripe: invoice_void_body
Closed record
Fields
- expand? invoice_void_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
stripe: Invoiceitem
Invoice Items represent the component lines of an invoice. An invoice item is added to an
invoice by creating or updating it with an invoice field, at which point it will be included as
an invoice line item within
invoice.lines.
Invoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined with a subscription. Sometimes you want to add a charge or credit to a customer, but actually charge or credit the customer’s card only at the end of a regular billing cycle. This is useful for combining several charges (to minimize per-transaction fees), or for having Stripe tabulate your usage-based billing totals.
Related guides: Integrate with the Invoicing API, Subscription Invoices.
Fields
- amount int - Amount (in the
currencyspecified) of the invoice item. This should always be equal tounit_amount * quantity.
- currency string - Three-letter ISO currency code, in lowercase. Must be a supported currency.
- customer string|Customer|Deleted_customer - The ID of the customer who will be billed when this invoice item is billed.
- date int - Time at which the object was created. Measured in seconds since the Unix epoch.
- description? string? - An arbitrary string attached to the object. Often useful for displaying to users.
- discountable boolean - If true, discounts will apply to this invoice item. Always false for prorations.
- id string - Unique identifier for the object.
- livemode boolean - Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode.
- metadata? record { string... }? - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- 'object "invoiceitem" - String representing the object's type. Objects of the same type share the same value.
- period Invoice_line_item_period -
- price? Price? - The price of the invoice item.
- proration boolean - Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.
- quantity int - Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.
- subscription? string|Subscription? - The subscription that this invoice item has been created for, if any.
- subscription_item? string - The subscription item that this invoice item has been created for, if any.
- tax_rates? Tax_rate[]? - The tax rates which apply to the invoice item. When set, the
default_tax_rateson the invoice do not apply to this invoice item.
- test_clock? string|Test_helpers\.test_clock? - ID of the test clock this invoice item belongs to.
- unit_amount? int? - Unit amount (in the
currencyspecified) of the invoice item.
- unit_amount_decimal? string? - Same as
unit_amount, but contains a decimal value with at most 12 decimal places.
stripe: invoiceitems_body
Closed record
Fields
- amount? int - The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. Passing in a negative
amountwill reduce theamount_dueon the invoice.
- currency? string - Three-letter ISO currency code, in lowercase. Must be a supported currency.
- customer string - The ID of the customer who will be billed when this invoice item is billed.
- description? string - An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
- discountable? boolean - Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items.
- expand? invoiceitems_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- invoice? string - The ID of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming scheduled invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per invoice.
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- period? period -
- price? string - The ID of the price object. One of
priceorprice_datais required.
- price_data? one_time_price_data -
- quantity? int - Non-negative integer. The quantity of units for the invoice item.
- subscription? string - The ID of a subscription to add this invoice item to. When left blank, the invoice item is added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.
- tax_behavior? "exclusive"|"inclusive"|"unspecified" - Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of
inclusive,exclusive, orunspecified. Once specified as eitherinclusiveorexclusive, it cannot be changed.
- tax_rates? invoiceitems_bodyTaxratesItemsString[] - The tax rates which apply to the invoice item. When set, the
default_tax_rateson the invoice do not apply to this invoice item.
- unit_amount? int - The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This
unit_amountwill be multiplied by the quantity to get the full amount. Passing in a negativeunit_amountwill reduce theamount_dueon the invoice.
- unit_amount_decimal? string - Same as
unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one ofunit_amountandunit_amount_decimalcan be set.
stripe: invoiceitems_invoiceitem_body
Closed record
Fields
- amount? int - The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.
- description? string - An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
- discountable? boolean - Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. Cannot be set to true for prorations.
- discounts? record { coupon string, discount string, promotion_code string }[]|"" - The coupons, promotion codes & existing discounts which apply to the invoice item or invoice line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts.
- expand? invoiceitems_invoiceitem_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- period? period -
- price? string - The ID of the price object. One of
priceorprice_datais required.
- price_data? one_time_price_data -
- quantity? int - Non-negative integer. The quantity of units for the invoice item.
- tax_behavior? "exclusive"|"inclusive"|"unspecified" - Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of
inclusive,exclusive, orunspecified. Once specified as eitherinclusiveorexclusive, it cannot be changed.
- tax_rates? TaxratesItemsString[]|"" - The tax rates which apply to the invoice item. When set, the
default_tax_rateson the invoice do not apply to this invoice item. Pass an empty string to remove previously-defined tax rates.
- unit_amount? int - The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.
- unit_amount_decimal? string - Same as
unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one ofunit_amountandunit_amount_decimalcan be set.
stripe: InvoiceLinesList
Fields
- data Line_item[] - Details about each object.
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: InvoiceLinesList_1
The individual line items that make up the invoice. lines is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order.
Fields
- data Line_item[] - Details about each object.
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: invoices_body
Closed record
Fields
- account_tax_ids? AccounttaxidsItemsString[]|"" - The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
- application_fee_amount? int - A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.
- auto_advance? boolean - Controls whether Stripe performs automatic collection of the invoice. If
false, the invoice's state doesn't automatically advance without an explicit action.
- automatic_tax? automatic_tax_param -
- collection_method? "charge_automatically"|"send_invoice" - Either
charge_automatically, orsend_invoice. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. Defaults tocharge_automatically.
- currency? string - The currency to create this invoice in. Defaults to that of
customerif not specified.
- customer? string - The ID of the customer who will be billed.
- days_until_due? int - The number of days from when the invoice is created until it is due. Valid only for invoices where
collection_method=send_invoice.
- default_payment_method? string - ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
- default_source? string - ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
- default_tax_rates? invoices_bodyDefaulttaxratesItemsString[] - The tax rates that will apply to any line item that does not have
tax_ratesset.
- description? string - An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
- due_date? int - The date on which payment for this invoice is due. Valid only for invoices where
collection_method=send_invoice.
- effective_at? int - The date when this invoice is in effect. Same as
finalized_atunless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
- expand? invoices_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- from_invoice? from_invoice -
- issuer? param_1 -
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- number? string - Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically.
- on_behalf_of? string - The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details.
- payment_settings? payment_settings_1 -
- pending_invoice_items_behavior? "exclude"|"include" - How to handle pending invoice items on invoice creation. Defaults to
excludeif the parameter is omitted.
- rendering? rendering_param -
- shipping_cost? shipping_cost -
- shipping_details? recipient_shipping_with_optional_fields_address -
- statement_descriptor? string - Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default
statement_descriptorwill be set to the first subscription item's product'sstatement_descriptor.
- subscription? string - The ID of the subscription to invoice, if any. If set, the created invoice will only include pending invoice items for that subscription. The subscription's billing cycle and regular subscription events won't be affected.
- transfer_data? transfer_data_specs_4 -
stripe: invoices_create_preview_body
Closed record
Fields
- automatic_tax? automatic_tax_param_1 -
- coupon? string - The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use
discountsinstead.
- currency? string - The currency to preview this invoice in. Defaults to that of
customerif not specified.
- customer? string - The identifier of the customer whose upcoming invoice you'd like to retrieve. If
automatic_taxis enabled then one ofcustomer,customer_details,subscription, orschedulemust be set.
- customer_details? customer_details_param -
- discounts? record { coupon string, discount string, promotion_code string }[]|"" - The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.
- expand? invoices_create_preview_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- invoice_items? invoice_item_preview_params[] - List of invoice items to add or update in the upcoming invoice preview.
- issuer? param_1 -
- on_behalf_of? string|"" - The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details.
- preview_mode? "next"|"recurring" - Customizes the types of values to include when calculating the invoice. Defaults to
nextif unspecified.
- schedule? string - The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.
- schedule_details? schedule_details_params -
- subscription? string - The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a
subscription_details.itemsis provided, you will preview creating a subscription with those items. If neithersubscriptionnorsubscription_details.itemsis provided, you will retrieve the next upcoming invoice from among the customer's subscriptions.
- subscription_details? subscription_details_params -
stripe: invoices_invoice_body
Closed record
Fields
- account_tax_ids? AccounttaxidsItemsString[]|"" - The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
- application_fee_amount? int - A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.
- auto_advance? boolean - Controls whether Stripe performs automatic collection of the invoice.
- automatic_tax? automatic_tax_param_4 -
- collection_method? "charge_automatically"|"send_invoice" - Either
charge_automaticallyorsend_invoice. This field can be updated only ondraftinvoices.
- custom_fields? record { name string, value string }[]|"" - A list of up to 4 custom fields to be displayed on the invoice. If a value for
custom_fieldsis specified, the list specified will replace the existing custom field list on this invoice. Pass an empty string to remove previously-defined fields.
- days_until_due? int - The number of days from which the invoice is created until it is due. Only valid for invoices where
collection_method=send_invoice. This field can only be updated ondraftinvoices.
- default_payment_method? string - ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
- default_source? string|"" - ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
- default_tax_rates? DefaulttaxratesItemsString[]|"" - The tax rates that will apply to any line item that does not have
tax_ratesset. Pass an empty string to remove previously-defined tax rates.
- description? string - An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
- due_date? int - The date on which payment for this invoice is due. Only valid for invoices where
collection_method=send_invoice. This field can only be updated ondraftinvoices.
- effective_at? int|"" - The date when this invoice is in effect. Same as
finalized_atunless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
- expand? invoices_invoice_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- issuer? param_1 -
- metadata? record { string... }|"" - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- number? string|"" - Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically.
- on_behalf_of? string|"" - The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details.
- payment_settings? payment_settings_1 -
- rendering? rendering_param -
- shipping_cost? record { shipping_rate string, shipping_rate_data record { delivery_estimate record { maximum record { unit "business_day"|"day"|"hour"|"month"|"week" , value int }, minimum record { unit "business_day"|"day"|"hour"|"month"|"week" , value int } }, display_name string, fixed_amount record { amount int, currency string, currency_options record { record { amount int, tax_behavior "exclusive"|"inclusive"|"unspecified" }... } }, metadata record { string... }, tax_behavior "exclusive"|"inclusive"|"unspecified" , tax_code string, 'type "fixed_amount" } }|"" - Settings for the cost of shipping for this invoice.
- shipping_details? record { address record { city string, country string, line1 string, line2 string, postal_code string, state string }, name string, phone string|"" }|"" - Shipping details for the invoice. The Invoice PDF will use the
shipping_detailsvalue if it is set, otherwise the PDF will render the shipping address from the customer.
- statement_descriptor? string - Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default
statement_descriptorwill be set to the first subscription item's product'sstatement_descriptor.
stripe: Invoices_payment_method_options
Fields
- acss_debit? Invoice_payment_method_options_acss_debit? - If paying by
acss_debit, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
- bancontact? Invoice_payment_method_options_bancontact? - If paying by
bancontact, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
- card? Invoice_payment_method_options_card? - If paying by
card, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
- customer_balance? Invoice_payment_method_options_customer_balance? - If paying by
customer_balance, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
- konbini? Invoice_payment_method_options_konbini? - If paying by
konbini, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
- sepa_debit? Invoice_payment_method_options_sepa_debit? - If paying by
sepa_debit, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.
- us_bank_account? Invoice_payment_method_options_us_bank_account? - If paying by
us_bank_account, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
stripe: Invoices_payment_settings
Fields
- default_mandate? string? - ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set.
- payment_method_options? Invoices_payment_method_options? - Payment-method-specific configuration to provide to the invoice’s PaymentIntent.
- payment_method_types? ("ach_credit_transfer"|"ach_debit"|"acss_debit"|"amazon_pay"|"au_becs_debit"|"bacs_debit"|"bancontact"|"boleto"|"card"|"cashapp"|"customer_balance"|"eps"|"fpx"|"giropay"|"grabpay"|"ideal"|"konbini"|"link"|"p24"|"paynow"|"paypal"|"promptpay"|"revolut_pay"|"sepa_debit"|"sofort"|"swish"|"us_bank_account"|"wechat_pay")[]? - The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your invoice template settings.
stripe: Invoices_resource_from_invoice
Fields
- action string - The relation between this invoice and the cloned invoice
stripe: Invoices_resource_invoice_rendering
Fields
- amount_tax_display? string? - How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
- pdf? Invoice_rendering_pdf? - Invoice pdf rendering options
stripe: Invoices_resource_invoice_tax_id
Fields
- 'type "ad_nrt"|"ae_trn"|"ar_cuit"|"au_abn"|"au_arn"|"bg_uic"|"bh_vat"|"bo_tin"|"br_cnpj"|"br_cpf"|"ca_bn"|"ca_gst_hst"|"ca_pst_bc"|"ca_pst_mb"|"ca_pst_sk"|"ca_qst"|"ch_uid"|"ch_vat"|"cl_tin"|"cn_tin"|"co_nit"|"cr_tin"|"de_stn"|"do_rcn"|"ec_ruc"|"eg_tin"|"es_cif"|"eu_oss_vat"|"eu_vat"|"gb_vat"|"ge_vat"|"hk_br"|"hu_tin"|"id_npwp"|"il_vat"|"in_gst"|"is_vat"|"jp_cn"|"jp_rn"|"jp_trn"|"ke_pin"|"kr_brn"|"kz_bin"|"li_uid"|"mx_rfc"|"my_frp"|"my_itn"|"my_sst"|"ng_tin"|"no_vat"|"no_voec"|"nz_gst"|"om_vat"|"pe_ruc"|"ph_tin"|"ro_tin"|"rs_pib"|"ru_inn"|"ru_kpp"|"sa_vat"|"sg_gst"|"sg_uen"|"si_tin"|"sv_nit"|"th_vat"|"tr_tin"|"tw_vat"|"ua_vat"|"unknown"|"us_ein"|"uy_ruc"|"ve_rif"|"vn_tin"|"za_vat" - The type of the tax ID, one of
ad_nrt,ar_cuit,eu_vat,bo_tin,br_cnpj,br_cpf,cn_tin,co_nit,cr_tin,do_rcn,ec_ruc,eu_oss_vat,pe_ruc,ro_tin,rs_pib,sv_nit,uy_ruc,ve_rif,vn_tin,gb_vat,nz_gst,au_abn,au_arn,in_gst,no_vat,no_voec,za_vat,ch_vat,mx_rfc,sg_uen,ru_inn,ru_kpp,ca_bn,hk_br,es_cif,tw_vat,th_vat,jp_cn,jp_rn,jp_trn,li_uid,my_itn,us_ein,kr_brn,ca_qst,ca_gst_hst,ca_pst_bc,ca_pst_mb,ca_pst_sk,my_sst,sg_gst,ae_trn,cl_tin,sa_vat,id_npwp,my_frp,il_vat,ge_vat,ua_vat,is_vat,bg_uic,hu_tin,si_tin,ke_pin,tr_tin,eg_tin,ph_tin,bh_vat,kz_bin,ng_tin,om_vat,de_stn,ch_uid, orunknown
- value? string? - The value of the tax ID.
stripe: Invoices_resource_line_items_credited_items
Fields
- invoice string - Invoice containing the credited invoice line items
- invoice_line_items Invoices_resource_line_items_credited_itemsInvoicelineitemsItemsString[] - Credited invoice line items
stripe: Invoices_resource_line_items_proration_details
Fields
- credited_items? Invoices_resource_line_items_credited_items? - For a credit proration
line_item, the original debit line_items to which the credit proration applies.
stripe: Invoices_resource_shipping_cost
Fields
- amount_subtotal int - Total shipping cost before any taxes are applied.
- amount_tax int - Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
- amount_total int - Total shipping cost after taxes are applied.
- shipping_rate? string|Shipping_rate? - The ID of the ShippingRate for this invoice.
- taxes? Line_items_tax_amount[] - The taxes applied to the shipping rate.
stripe: Invoices_resource_status_transitions
Fields
- finalized_at? int? - The time that the invoice draft was finalized.
- marked_uncollectible_at? int? - The time that the invoice was marked uncollectible.
- paid_at? int? - The time that the invoice was paid.
- voided_at? int? - The time that the invoice was voided.
stripe: invoices_settings_specs
Fields
- default_account_tax_ids? DefaultaccounttaxidsItemsString[]|"" -
stripe: InvoicesItemsList
Fields
- data Invoiceitem[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: InvoicesResourceList
Fields
- data Invoice[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: Issuing\.authorization
Fields
- amount int -
- amount_details? Issuing_authorization_amount_details? -
- approved boolean -
- balance_transactions Balance_transaction[] -
- card Issuing\.card -
- cardholder? string|Issuing\.cardholder? -
- created int -
- currency string -
- fleet? Issuing_authorization_fleet_data? -
- fuel? Issuing_authorization_fuel_data? -
- id string -
- livemode boolean -
- merchant_amount int -
- merchant_currency string -
- merchant_data Issuing_authorization_merchant_data -
- metadata record { string... } -
- network_data? Issuing_authorization_network_data? -
- 'object "issuing.authorization" -
- pending_request? Issuing_authorization_pending_request? -
- request_history Issuing_authorization_request[] -
- status "closed"|"pending"|"reversed" -
- token? string|Issuing\.token? -
- transactions Issuing\.transaction[] -
- treasury? Issuing_authorization_treasury? -
- verification_data Issuing_authorization_verification_data -
- wallet? string? -
stripe: Issuing\.card
Fields
- brand string -
- cancellation_reason? "design_rejected"|"lost"|"stolen"? -
- cardholder Issuing\.cardholder -
- created int -
- currency string -
- cvc? string -
- exp_month int -
- exp_year int -
- financial_account? string? -
- id string -
- last4 string -
- livemode boolean -
- metadata record { string... } -
- number? string -
- 'object "issuing.card" -
- personalization_design? string|Issuing\.personalization_design? -
- replaced_by? string|Issuing\.card? -
- replacement_for? string|Issuing\.card? -
- replacement_reason? "damaged"|"expired"|"lost"|"stolen"? -
- shipping? Issuing_card_shipping? -
- spending_controls Issuing_card_authorization_controls -
- status "active"|"canceled"|"inactive" -
- 'type "physical"|"virtual" -
- wallets? Issuing_card_wallets? -
stripe: Issuing\.cardholder
Fields
- billing Issuing_cardholder_address -
- company? Issuing_cardholder_company? -
- created int -
- email? string? -
- id string -
- individual? Issuing_cardholder_individual? -
- livemode boolean -
- metadata record { string... } -
- name string -
- 'object "issuing.cardholder" -
- phone_number? string? -
- preferred_locales? ("de"|"en"|"es"|"fr"|"it")[]? -
- requirements Issuing_cardholder_requirements -
- spending_controls? Issuing_cardholder_authorization_controls? -
- status "active"|"blocked"|"inactive" -
- 'type "company"|"individual" -
stripe: Issuing\.dispute
Fields
- amount int -
- balance_transactions? Balance_transaction[]? -
- created int -
- currency string -
- evidence Issuing_dispute_evidence -
- id string -
- livemode boolean -
- loss_reason? "cardholder_authentication_issuer_liability"|"eci5_token_transaction_with_tavv"|"excess_disputes_in_timeframe"|"has_not_met_the_minimum_dispute_amount_requirements"|"invalid_duplicate_dispute"|"invalid_incorrect_amount_dispute"|"invalid_no_authorization"|"invalid_use_of_disputes"|"merchandise_delivered_or_shipped"|"merchandise_or_service_as_described"|"not_cancelled"|"other"|"refund_issued"|"submitted_beyond_allowable_time_limit"|"transaction_3ds_required"|"transaction_approved_after_prior_fraud_dispute"|"transaction_authorized"|"transaction_electronically_read"|"transaction_qualifies_for_visa_easy_payment_service"|"transaction_unattended" -
- metadata record { string... } -
- 'object "issuing.dispute" -
- status "expired"|"lost"|"submitted"|"unsubmitted"|"won" -
- 'transaction string|Issuing\.transaction -
- treasury? Issuing_dispute_treasury? -
stripe: Issuing\.personalization_design
Fields
- carrier_text? Issuing_personalization_design_carrier_text? -
- created int -
- id string -
- livemode boolean -
- lookup_key? string? -
- metadata record { string... } -
- name? string? -
- 'object "issuing.personalization_design" -
- physical_bundle string|Issuing\.physical_bundle -
- preferences Issuing_personalization_design_preferences -
- rejection_reasons Issuing_personalization_design_rejection_reasons -
- status "active"|"inactive"|"rejected"|"review" -
stripe: Issuing\.physical_bundle
Fields
- features Issuing_physical_bundle_features -
- id string -
- livemode boolean -
- name string -
- 'object "issuing.physical_bundle" -
- status "active"|"inactive"|"review" -
- 'type "custom"|"standard" -
stripe: Issuing\.settlement
Fields
- bin string -
- clearing_date int -
- created int -
- currency string -
- id string -
- interchange_fees int -
- livemode boolean -
- metadata record { string... } -
- net_total int -
- network "visa" -
- network_fees int -
- network_settlement_identifier string -
- 'object "issuing.settlement" -
- settlement_service string -
- transaction_count int -
- transaction_volume int -
stripe: Issuing\.token
Fields
- card string|Issuing\.card -
- created int -
- device_fingerprint? string? -
- id string -
- last4? string -
- livemode boolean -
- network "mastercard"|"visa" -
- network_data? Issuing_network_token_network_data -
- network_updated_at int -
- 'object "issuing.token" -
- status "active"|"deleted"|"requested"|"suspended" -
- wallet_provider? "apple_pay"|"google_pay"|"samsung_pay" -
stripe: Issuing\.transaction
Fields
- amount int -
- amount_details? Issuing_transaction_amount_details? -
- balance_transaction? string|Balance_transaction? -
- card string|Issuing\.card -
- cardholder? string|Issuing\.cardholder? -
- created int -
- currency string -
- dispute? string|Issuing\.dispute? -
- id string -
- livemode boolean -
- merchant_amount int -
- merchant_currency string -
- merchant_data Issuing_authorization_merchant_data -
- metadata record { string... } -
- network_data? Issuing_transaction_network_data? -
- 'object "issuing.transaction" -
- purchase_details? Issuing_transaction_purchase_details? -
- token? string|Issuing\.token? -
- treasury? Issuing_transaction_treasury? -
- 'type "capture"|"refund" -
- wallet? "apple_pay"|"google_pay"|"samsung_pay"? -
stripe: Issuing_authorization_amount_details
Fields
- atm_fee? int? - The fee charged by the ATM for the cash withdrawal.
- cashback_amount? int? - The amount of cash requested by the cardholder.
stripe: Issuing_authorization_authentication_exemption
Fields
- claimed_by "acquirer"|"issuer" - The entity that requested the exemption, either the acquiring merchant or the Issuing user.
- 'type "low_value_transaction"|"transaction_risk_analysis"|"unknown" - The specific exemption claimed for this authorization.
stripe: Issuing_authorization_fleet_cardholder_prompt_data
Fields
- alphanumeric_id? string? - [Deprecated] An alphanumeric ID, though typical point of sales only support numeric entry. The card program can be configured to prompt for a vehicle ID, driver ID, or generic ID.
- driver_id? string? - Driver ID.
- odometer? int? - Odometer reading.
- unspecified_id? string? - An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.
- user_id? string? - User ID.
- vehicle_number? string? - Vehicle number.
stripe: Issuing_authorization_fleet_data
Fields
- cardholder_prompt_data? Issuing_authorization_fleet_cardholder_prompt_data? - Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.
- purchase_type? "fuel_and_non_fuel_purchase"|"fuel_purchase"|"non_fuel_purchase"? - The type of purchase.
- reported_breakdown? Issuing_authorization_fleet_reported_breakdown? - More information about the total amount. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
- service_type? "full_service"|"non_fuel_transaction"|"self_service"? - The type of fuel service.
stripe: Issuing_authorization_fleet_fuel_price_data
Fields
- gross_amount_decimal? string? - Gross fuel amount that should equal Fuel Quantity multiplied by Fuel Unit Cost, inclusive of taxes.
stripe: Issuing_authorization_fleet_non_fuel_price_data
Fields
- gross_amount_decimal? string? - Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
stripe: Issuing_authorization_fleet_reported_breakdown
Fields
- fuel? Issuing_authorization_fleet_fuel_price_data? - Breakdown of fuel portion of the purchase.
- non_fuel? Issuing_authorization_fleet_non_fuel_price_data? - Breakdown of non-fuel portion of the purchase.
- tax? Issuing_authorization_fleet_tax_data? - Information about tax included in this transaction.
stripe: Issuing_authorization_fleet_tax_data
Fields
- local_amount_decimal? string? - Amount of state or provincial Sales Tax included in the transaction amount.
nullif not reported by merchant or not subject to tax.
- national_amount_decimal? string? - Amount of national Sales Tax or VAT included in the transaction amount.
nullif not reported by merchant or not subject to tax.
stripe: Issuing_authorization_fuel_data
Fields
- industry_product_code? string? - Conexxus Payment System Product Code identifying the primary fuel product purchased.
- quantity_decimal? string? - The quantity of
units of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
- 'type? "diesel"|"other"|"unleaded_plus"|"unleaded_regular"|"unleaded_super"? - The type of fuel that was purchased.
- unit? "charging_minute"|"imperial_gallon"|"kilogram"|"kilowatt_hour"|"liter"|"other"|"pound"|"us_gallon"? - The units for
quantity_decimal.
- unit_cost_decimal? string? - The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
stripe: Issuing_authorization_merchant_data
Fields
- category string - A categorization of the seller's type of business. See our merchant categories guide for a list of possible values.
- category_code string - The merchant category code for the seller’s business
- city? string? - City where the seller is located
- country? string? - Country where the seller is located
- name? string? - Name of the seller
- network_id string - Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.
- postal_code? string? - Postal code where the seller is located
- state? string? - State where the seller is located
- terminal_id? string? - An ID assigned by the seller to the location of the sale.
- url? string? - URL provided by the merchant on a 3DS request
stripe: Issuing_authorization_network_data
Fields
- acquiring_institution_id? string? - Identifier assigned to the acquirer by the card network. Sometimes this value is not provided by the network; in this case, the value will be
null.
- system_trace_audit_number? string? - The System Trace Audit Number (STAN) is a 6-digit identifier assigned by the acquirer. Prefer
network_data.transaction_idif present, unless you have special requirements.
- transaction_id? string? - Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.
stripe: Issuing_authorization_pending_request
Fields
- amount int - The additional amount Stripe will hold if the authorization is approved, in the card's currency and in the smallest currency unit.
- amount_details? Issuing_authorization_amount_details? - Detailed breakdown of amount components. These amounts are denominated in
currencyand in the smallest currency unit.
- currency string - Three-letter ISO currency code, in lowercase. Must be a supported currency.
- merchant_amount int - The amount the merchant is requesting to be authorized in the
merchant_currency. The amount is in the smallest currency unit.
- merchant_currency string - The local currency the merchant is requesting to authorize.
- network_risk_score? int? - The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99.
stripe: Issuing_authorization_request
Fields
- amount int - The
pending_request.amountat the time of the request, presented in your card's currency and in the smallest currency unit. Stripe held this amount from your account to fund the authorization if the request was approved.
- amount_details? Issuing_authorization_amount_details? - Detailed breakdown of amount components. These amounts are denominated in
currencyand in the smallest currency unit.
- approved boolean - Whether this request was approved.
- created int - Time at which the object was created. Measured in seconds since the Unix epoch.
- currency string - Three-letter ISO currency code, in lowercase. Must be a supported currency.
- merchant_amount int - The
pending_request.merchant_amountat the time of the request, presented in themerchant_currencyand in the smallest currency unit.
- merchant_currency string - The currency that was collected by the merchant and presented to the cardholder for the authorization. Three-letter ISO currency code, in lowercase. Must be a supported currency.
- network_risk_score? int? - The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99.
- reason "account_disabled"|"card_active"|"card_canceled"|"card_expired"|"card_inactive"|"cardholder_blocked"|"cardholder_inactive"|"cardholder_verification_required"|"insecure_authorization_method"|"insufficient_funds"|"not_allowed"|"pin_blocked"|"spending_controls"|"suspected_fraud"|"verification_failed"|"webhook_approved"|"webhook_declined"|"webhook_error"|"webhook_timeout" - When an authorization is approved or declined by you or by Stripe, this field provides additional detail on the reason for the outcome.
- reason_message? string? - If the
request_history.reasoniswebhook_errorbecause the direct webhook response is invalid (for example, parsing errors or missing parameters), we surface a more detailed error message via this field.
- requested_at? int? - Time when the card network received an authorization request from the acquirer in UTC. Referred to by networks as transmission time.
stripe: Issuing_authorization_three_d_secure
Fields
- result "attempt_acknowledged"|"authenticated"|"failed"|"required" - The outcome of the 3D Secure authentication request.
stripe: Issuing_authorization_treasury
Fields
- received_credits Issuing_authorization_treasuryReceivedcreditsItemsString[] - The array of ReceivedCredits associated with this authorization
- received_debits Issuing_authorization_treasuryReceiveddebitsItemsString[] - The array of ReceivedDebits associated with this authorization
- 'transaction? string? - The Treasury Transaction associated with this authorization
stripe: Issuing_authorization_verification_data
Fields
- address_line1_check "match"|"mismatch"|"not_provided" - Whether the cardholder provided an address first line and if it matched the cardholder’s
billing.address.line1.
- address_postal_code_check "match"|"mismatch"|"not_provided" - Whether the cardholder provided a postal code and if it matched the cardholder’s
billing.address.postal_code.
- authentication_exemption? Issuing_authorization_authentication_exemption? - The exemption applied to this authorization.
- cvc_check "match"|"mismatch"|"not_provided" - Whether the cardholder provided a CVC and if it matched Stripe’s record.
- expiry_check "match"|"mismatch"|"not_provided" - Whether the cardholder provided an expiry date and if it matched Stripe’s record.
- postal_code? string? - The postal code submitted as part of the authorization used for postal code verification.
- three_d_secure? Issuing_authorization_three_d_secure? - 3D Secure details.
stripe: issuing_authorizations_body
Closed record
Fields
- amount int - The total amount to attempt to authorize. This amount is in the provided currency, or defaults to the card's currency, and in the smallest currency unit.
- amount_details? amount_details_specs -
- card string - Card associated with this authorization.
- currency? string - The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter ISO currency code, in lowercase. Must be a supported currency.
- expand? issuing_authorizations_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- fleet? fleet_specs -
- fuel? fuel_specs -
- merchant_data? merchant_data_specs -
- network_data? network_data_specs -
- verification_data? verification_data_specs -
- wallet? "apple_pay"|"google_pay"|"samsung_pay" - The digital wallet used for this transaction. One of
apple_pay,google_pay, orsamsung_pay. Will populate asnullwhen no digital wallet was utilized.
stripe: Issuing_card_apple_pay
Fields
- eligible boolean - Apple Pay Eligibility
- ineligible_reason? "missing_agreement"|"missing_cardholder_contact"|"unsupported_region"? - Reason the card is ineligible for Apple Pay
stripe: Issuing_card_authorization_controls
Fields
- allowed_categories? ("ac_refrigeration_repair"|"accounting_bookkeeping_services"|"advertising_services"|"agricultural_cooperative"|"airlines_air_carriers"|"airports_flying_fields"|"ambulance_services"|"amusement_parks_carnivals"|"antique_reproductions"|"antique_shops"|"aquariums"|"architectural_surveying_services"|"art_dealers_and_galleries"|"artists_supply_and_craft_shops"|"auto_and_home_supply_stores"|"auto_body_repair_shops"|"auto_paint_shops"|"auto_service_shops"|"automated_cash_disburse"|"automated_fuel_dispensers"|"automobile_associations"|"automotive_parts_and_accessories_stores"|"automotive_tire_stores"|"bail_and_bond_payments"|"bakeries"|"bands_orchestras"|"barber_and_beauty_shops"|"betting_casino_gambling"|"bicycle_shops"|"billiard_pool_establishments"|"boat_dealers"|"boat_rentals_and_leases"|"book_stores"|"books_periodicals_and_newspapers"|"bowling_alleys"|"bus_lines"|"business_secretarial_schools"|"buying_shopping_services"|"cable_satellite_and_other_pay_television_and_radio"|"camera_and_photographic_supply_stores"|"candy_nut_and_confectionery_stores"|"car_and_truck_dealers_new_used"|"car_and_truck_dealers_used_only"|"car_rental_agencies"|"car_washes"|"carpentry_services"|"carpet_upholstery_cleaning"|"caterers"|"charitable_and_social_service_organizations_fundraising"|"chemicals_and_allied_products"|"child_care_services"|"childrens_and_infants_wear_stores"|"chiropodists_podiatrists"|"chiropractors"|"cigar_stores_and_stands"|"civic_social_fraternal_associations"|"cleaning_and_maintenance"|"clothing_rental"|"colleges_universities"|"commercial_equipment"|"commercial_footwear"|"commercial_photography_art_and_graphics"|"commuter_transport_and_ferries"|"computer_network_services"|"computer_programming"|"computer_repair"|"computer_software_stores"|"computers_peripherals_and_software"|"concrete_work_services"|"construction_materials"|"consulting_public_relations"|"correspondence_schools"|"cosmetic_stores"|"counseling_services"|"country_clubs"|"courier_services"|"court_costs"|"credit_reporting_agencies"|"cruise_lines"|"dairy_products_stores"|"dance_hall_studios_schools"|"dating_escort_services"|"dentists_orthodontists"|"department_stores"|"detective_agencies"|"digital_goods_applications"|"digital_goods_games"|"digital_goods_large_volume"|"digital_goods_media"|"direct_marketing_catalog_merchant"|"direct_marketing_combination_catalog_and_retail_merchant"|"direct_marketing_inbound_telemarketing"|"direct_marketing_insurance_services"|"direct_marketing_other"|"direct_marketing_outbound_telemarketing"|"direct_marketing_subscription"|"direct_marketing_travel"|"discount_stores"|"doctors"|"door_to_door_sales"|"drapery_window_covering_and_upholstery_stores"|"drinking_places"|"drug_stores_and_pharmacies"|"drugs_drug_proprietaries_and_druggist_sundries"|"dry_cleaners"|"durable_goods"|"duty_free_stores"|"eating_places_restaurants"|"educational_services"|"electric_razor_stores"|"electric_vehicle_charging"|"electrical_parts_and_equipment"|"electrical_services"|"electronics_repair_shops"|"electronics_stores"|"elementary_secondary_schools"|"emergency_services_gcas_visa_use_only"|"employment_temp_agencies"|"equipment_rental"|"exterminating_services"|"family_clothing_stores"|"fast_food_restaurants"|"financial_institutions"|"fines_government_administrative_entities"|"fireplace_fireplace_screens_and_accessories_stores"|"floor_covering_stores"|"florists"|"florists_supplies_nursery_stock_and_flowers"|"freezer_and_locker_meat_provisioners"|"fuel_dealers_non_automotive"|"funeral_services_crematories"|"furniture_home_furnishings_and_equipment_stores_except_appliances"|"furniture_repair_refinishing"|"furriers_and_fur_shops"|"general_services"|"gift_card_novelty_and_souvenir_shops"|"glass_paint_and_wallpaper_stores"|"glassware_crystal_stores"|"golf_courses_public"|"government_licensed_horse_dog_racing_us_region_only"|"government_licensed_online_casions_online_gambling_us_region_only"|"government_owned_lotteries_non_us_region"|"government_owned_lotteries_us_region_only"|"government_services"|"grocery_stores_supermarkets"|"hardware_equipment_and_supplies"|"hardware_stores"|"health_and_beauty_spas"|"hearing_aids_sales_and_supplies"|"heating_plumbing_a_c"|"hobby_toy_and_game_shops"|"home_supply_warehouse_stores"|"hospitals"|"hotels_motels_and_resorts"|"household_appliance_stores"|"industrial_supplies"|"information_retrieval_services"|"insurance_default"|"insurance_underwriting_premiums"|"intra_company_purchases"|"jewelry_stores_watches_clocks_and_silverware_stores"|"landscaping_services"|"laundries"|"laundry_cleaning_services"|"legal_services_attorneys"|"luggage_and_leather_goods_stores"|"lumber_building_materials_stores"|"manual_cash_disburse"|"marinas_service_and_supplies"|"marketplaces"|"masonry_stonework_and_plaster"|"massage_parlors"|"medical_and_dental_labs"|"medical_dental_ophthalmic_and_hospital_equipment_and_supplies"|"medical_services"|"membership_organizations"|"mens_and_boys_clothing_and_accessories_stores"|"mens_womens_clothing_stores"|"metal_service_centers"|"miscellaneous"|"miscellaneous_apparel_and_accessory_shops"|"miscellaneous_auto_dealers"|"miscellaneous_business_services"|"miscellaneous_food_stores"|"miscellaneous_general_merchandise"|"miscellaneous_general_services"|"miscellaneous_home_furnishing_specialty_stores"|"miscellaneous_publishing_and_printing"|"miscellaneous_recreation_services"|"miscellaneous_repair_shops"|"miscellaneous_specialty_retail"|"mobile_home_dealers"|"motion_picture_theaters"|"motor_freight_carriers_and_trucking"|"motor_homes_dealers"|"motor_vehicle_supplies_and_new_parts"|"motorcycle_shops_and_dealers"|"motorcycle_shops_dealers"|"music_stores_musical_instruments_pianos_and_sheet_music"|"news_dealers_and_newsstands"|"non_fi_money_orders"|"non_fi_stored_value_card_purchase_load"|"nondurable_goods"|"nurseries_lawn_and_garden_supply_stores"|"nursing_personal_care"|"office_and_commercial_furniture"|"opticians_eyeglasses"|"optometrists_ophthalmologist"|"orthopedic_goods_prosthetic_devices"|"osteopaths"|"package_stores_beer_wine_and_liquor"|"paints_varnishes_and_supplies"|"parking_lots_garages"|"passenger_railways"|"pawn_shops"|"pet_shops_pet_food_and_supplies"|"petroleum_and_petroleum_products"|"photo_developing"|"photographic_photocopy_microfilm_equipment_and_supplies"|"photographic_studios"|"picture_video_production"|"piece_goods_notions_and_other_dry_goods"|"plumbing_heating_equipment_and_supplies"|"political_organizations"|"postal_services_government_only"|"precious_stones_and_metals_watches_and_jewelry"|"professional_services"|"public_warehousing_and_storage"|"quick_copy_repro_and_blueprint"|"railroads"|"real_estate_agents_and_managers_rentals"|"record_stores"|"recreational_vehicle_rentals"|"religious_goods_stores"|"religious_organizations"|"roofing_siding_sheet_metal"|"secretarial_support_services"|"security_brokers_dealers"|"service_stations"|"sewing_needlework_fabric_and_piece_goods_stores"|"shoe_repair_hat_cleaning"|"shoe_stores"|"small_appliance_repair"|"snowmobile_dealers"|"special_trade_services"|"specialty_cleaning"|"sporting_goods_stores"|"sporting_recreation_camps"|"sports_and_riding_apparel_stores"|"sports_clubs_fields"|"stamp_and_coin_stores"|"stationary_office_supplies_printing_and_writing_paper"|"stationery_stores_office_and_school_supply_stores"|"swimming_pools_sales"|"t_ui_travel_germany"|"tailors_alterations"|"tax_payments_government_agencies"|"tax_preparation_services"|"taxicabs_limousines"|"telecommunication_equipment_and_telephone_sales"|"telecommunication_services"|"telegraph_services"|"tent_and_awning_shops"|"testing_laboratories"|"theatrical_ticket_agencies"|"timeshares"|"tire_retreading_and_repair"|"tolls_bridge_fees"|"tourist_attractions_and_exhibits"|"towing_services"|"trailer_parks_campgrounds"|"transportation_services"|"travel_agencies_tour_operators"|"truck_stop_iteration"|"truck_utility_trailer_rentals"|"typesetting_plate_making_and_related_services"|"typewriter_stores"|"u_s_federal_government_agencies_or_departments"|"uniforms_commercial_clothing"|"used_merchandise_and_secondhand_stores"|"utilities"|"variety_stores"|"veterinary_services"|"video_amusement_game_supplies"|"video_game_arcades"|"video_tape_rental_stores"|"vocational_trade_schools"|"watch_jewelry_repair"|"welding_repair"|"wholesale_clubs"|"wig_and_toupee_stores"|"wires_money_orders"|"womens_accessory_and_specialty_shops"|"womens_ready_to_wear_stores"|"wrecking_and_salvage_yards")[]? - Array of strings containing categories of authorizations to allow. All other categories will be blocked. Cannot be set with
blocked_categories.
- allowed_merchant_countries? Issuing_card_authorization_controlsAllowedmerchantcountriesItemsString[]? - Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g.
US). Cannot be set withblocked_merchant_countries. Provide an empty value to unset this control.
- blocked_categories? ("ac_refrigeration_repair"|"accounting_bookkeeping_services"|"advertising_services"|"agricultural_cooperative"|"airlines_air_carriers"|"airports_flying_fields"|"ambulance_services"|"amusement_parks_carnivals"|"antique_reproductions"|"antique_shops"|"aquariums"|"architectural_surveying_services"|"art_dealers_and_galleries"|"artists_supply_and_craft_shops"|"auto_and_home_supply_stores"|"auto_body_repair_shops"|"auto_paint_shops"|"auto_service_shops"|"automated_cash_disburse"|"automated_fuel_dispensers"|"automobile_associations"|"automotive_parts_and_accessories_stores"|"automotive_tire_stores"|"bail_and_bond_payments"|"bakeries"|"bands_orchestras"|"barber_and_beauty_shops"|"betting_casino_gambling"|"bicycle_shops"|"billiard_pool_establishments"|"boat_dealers"|"boat_rentals_and_leases"|"book_stores"|"books_periodicals_and_newspapers"|"bowling_alleys"|"bus_lines"|"business_secretarial_schools"|"buying_shopping_services"|"cable_satellite_and_other_pay_television_and_radio"|"camera_and_photographic_supply_stores"|"candy_nut_and_confectionery_stores"|"car_and_truck_dealers_new_used"|"car_and_truck_dealers_used_only"|"car_rental_agencies"|"car_washes"|"carpentry_services"|"carpet_upholstery_cleaning"|"caterers"|"charitable_and_social_service_organizations_fundraising"|"chemicals_and_allied_products"|"child_care_services"|"childrens_and_infants_wear_stores"|"chiropodists_podiatrists"|"chiropractors"|"cigar_stores_and_stands"|"civic_social_fraternal_associations"|"cleaning_and_maintenance"|"clothing_rental"|"colleges_universities"|"commercial_equipment"|"commercial_footwear"|"commercial_photography_art_and_graphics"|"commuter_transport_and_ferries"|"computer_network_services"|"computer_programming"|"computer_repair"|"computer_software_stores"|"computers_peripherals_and_software"|"concrete_work_services"|"construction_materials"|"consulting_public_relations"|"correspondence_schools"|"cosmetic_stores"|"counseling_services"|"country_clubs"|"courier_services"|"court_costs"|"credit_reporting_agencies"|"cruise_lines"|"dairy_products_stores"|"dance_hall_studios_schools"|"dating_escort_services"|"dentists_orthodontists"|"department_stores"|"detective_agencies"|"digital_goods_applications"|"digital_goods_games"|"digital_goods_large_volume"|"digital_goods_media"|"direct_marketing_catalog_merchant"|"direct_marketing_combination_catalog_and_retail_merchant"|"direct_marketing_inbound_telemarketing"|"direct_marketing_insurance_services"|"direct_marketing_other"|"direct_marketing_outbound_telemarketing"|"direct_marketing_subscription"|"direct_marketing_travel"|"discount_stores"|"doctors"|"door_to_door_sales"|"drapery_window_covering_and_upholstery_stores"|"drinking_places"|"drug_stores_and_pharmacies"|"drugs_drug_proprietaries_and_druggist_sundries"|"dry_cleaners"|"durable_goods"|"duty_free_stores"|"eating_places_restaurants"|"educational_services"|"electric_razor_stores"|"electric_vehicle_charging"|"electrical_parts_and_equipment"|"electrical_services"|"electronics_repair_shops"|"electronics_stores"|"elementary_secondary_schools"|"emergency_services_gcas_visa_use_only"|"employment_temp_agencies"|"equipment_rental"|"exterminating_services"|"family_clothing_stores"|"fast_food_restaurants"|"financial_institutions"|"fines_government_administrative_entities"|"fireplace_fireplace_screens_and_accessories_stores"|"floor_covering_stores"|"florists"|"florists_supplies_nursery_stock_and_flowers"|"freezer_and_locker_meat_provisioners"|"fuel_dealers_non_automotive"|"funeral_services_crematories"|"furniture_home_furnishings_and_equipment_stores_except_appliances"|"furniture_repair_refinishing"|"furriers_and_fur_shops"|"general_services"|"gift_card_novelty_and_souvenir_shops"|"glass_paint_and_wallpaper_stores"|"glassware_crystal_stores"|"golf_courses_public"|"government_licensed_horse_dog_racing_us_region_only"|"government_licensed_online_casions_online_gambling_us_region_only"|"government_owned_lotteries_non_us_region"|"government_owned_lotteries_us_region_only"|"government_services"|"grocery_stores_supermarkets"|"hardware_equipment_and_supplies"|"hardware_stores"|"health_and_beauty_spas"|"hearing_aids_sales_and_supplies"|"heating_plumbing_a_c"|"hobby_toy_and_game_shops"|"home_supply_warehouse_stores"|"hospitals"|"hotels_motels_and_resorts"|"household_appliance_stores"|"industrial_supplies"|"information_retrieval_services"|"insurance_default"|"insurance_underwriting_premiums"|"intra_company_purchases"|"jewelry_stores_watches_clocks_and_silverware_stores"|"landscaping_services"|"laundries"|"laundry_cleaning_services"|"legal_services_attorneys"|"luggage_and_leather_goods_stores"|"lumber_building_materials_stores"|"manual_cash_disburse"|"marinas_service_and_supplies"|"marketplaces"|"masonry_stonework_and_plaster"|"massage_parlors"|"medical_and_dental_labs"|"medical_dental_ophthalmic_and_hospital_equipment_and_supplies"|"medical_services"|"membership_organizations"|"mens_and_boys_clothing_and_accessories_stores"|"mens_womens_clothing_stores"|"metal_service_centers"|"miscellaneous"|"miscellaneous_apparel_and_accessory_shops"|"miscellaneous_auto_dealers"|"miscellaneous_business_services"|"miscellaneous_food_stores"|"miscellaneous_general_merchandise"|"miscellaneous_general_services"|"miscellaneous_home_furnishing_specialty_stores"|"miscellaneous_publishing_and_printing"|"miscellaneous_recreation_services"|"miscellaneous_repair_shops"|"miscellaneous_specialty_retail"|"mobile_home_dealers"|"motion_picture_theaters"|"motor_freight_carriers_and_trucking"|"motor_homes_dealers"|"motor_vehicle_supplies_and_new_parts"|"motorcycle_shops_and_dealers"|"motorcycle_shops_dealers"|"music_stores_musical_instruments_pianos_and_sheet_music"|"news_dealers_and_newsstands"|"non_fi_money_orders"|"non_fi_stored_value_card_purchase_load"|"nondurable_goods"|"nurseries_lawn_and_garden_supply_stores"|"nursing_personal_care"|"office_and_commercial_furniture"|"opticians_eyeglasses"|"optometrists_ophthalmologist"|"orthopedic_goods_prosthetic_devices"|"osteopaths"|"package_stores_beer_wine_and_liquor"|"paints_varnishes_and_supplies"|"parking_lots_garages"|"passenger_railways"|"pawn_shops"|"pet_shops_pet_food_and_supplies"|"petroleum_and_petroleum_products"|"photo_developing"|"photographic_photocopy_microfilm_equipment_and_supplies"|"photographic_studios"|"picture_video_production"|"piece_goods_notions_and_other_dry_goods"|"plumbing_heating_equipment_and_supplies"|"political_organizations"|"postal_services_government_only"|"precious_stones_and_metals_watches_and_jewelry"|"professional_services"|"public_warehousing_and_storage"|"quick_copy_repro_and_blueprint"|"railroads"|"real_estate_agents_and_managers_rentals"|"record_stores"|"recreational_vehicle_rentals"|"religious_goods_stores"|"religious_organizations"|"roofing_siding_sheet_metal"|"secretarial_support_services"|"security_brokers_dealers"|"service_stations"|"sewing_needlework_fabric_and_piece_goods_stores"|"shoe_repair_hat_cleaning"|"shoe_stores"|"small_appliance_repair"|"snowmobile_dealers"|"special_trade_services"|"specialty_cleaning"|"sporting_goods_stores"|"sporting_recreation_camps"|"sports_and_riding_apparel_stores"|"sports_clubs_fields"|"stamp_and_coin_stores"|"stationary_office_supplies_printing_and_writing_paper"|"stationery_stores_office_and_school_supply_stores"|"swimming_pools_sales"|"t_ui_travel_germany"|"tailors_alterations"|"tax_payments_government_agencies"|"tax_preparation_services"|"taxicabs_limousines"|"telecommunication_equipment_and_telephone_sales"|"telecommunication_services"|"telegraph_services"|"tent_and_awning_shops"|"testing_laboratories"|"theatrical_ticket_agencies"|"timeshares"|"tire_retreading_and_repair"|"tolls_bridge_fees"|"tourist_attractions_and_exhibits"|"towing_services"|"trailer_parks_campgrounds"|"transportation_services"|"travel_agencies_tour_operators"|"truck_stop_iteration"|"truck_utility_trailer_rentals"|"typesetting_plate_making_and_related_services"|"typewriter_stores"|"u_s_federal_government_agencies_or_departments"|"uniforms_commercial_clothing"|"used_merchandise_and_secondhand_stores"|"utilities"|"variety_stores"|"veterinary_services"|"video_amusement_game_supplies"|"video_game_arcades"|"video_tape_rental_stores"|"vocational_trade_schools"|"watch_jewelry_repair"|"welding_repair"|"wholesale_clubs"|"wig_and_toupee_stores"|"wires_money_orders"|"womens_accessory_and_specialty_shops"|"womens_ready_to_wear_stores"|"wrecking_and_salvage_yards")[]? - Array of strings containing categories of authorizations to decline. All other categories will be allowed. Cannot be set with
allowed_categories.
- blocked_merchant_countries? Issuing_card_authorization_controlsBlockedmerchantcountriesItemsString[]? - Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g.
US). Cannot be set withallowed_merchant_countries. Provide an empty value to unset this control.
- spending_limits? Issuing_card_spending_limit[]? - Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its
replacement_forcard and that card'sreplacement_forcard, up the chain).
- spending_limits_currency? string? - Currency of the amounts within
spending_limits. Always the same as the currency of the card.
stripe: Issuing_card_google_pay
Fields
- eligible boolean - Google Pay Eligibility
- ineligible_reason? "missing_agreement"|"missing_cardholder_contact"|"unsupported_region"? - Reason the card is ineligible for Google Pay
stripe: Issuing_card_shipping
Fields
- address Address -
- address_validation? Issuing_card_shipping_address_validation? - Address validation details for the shipment.
- carrier? "dhl"|"fedex"|"royal_mail"|"usps"? - The delivery company that shipped a card.
- customs? Issuing_card_shipping_customs? - Additional information that may be required for clearing customs.
- eta? int? - A unix timestamp representing a best estimate of when the card will be delivered.
- name string - Recipient name.
- phone_number? string? - The phone number of the receiver of the shipment. Our courier partners will use this number to contact you in the event of card delivery issues. For individual shipments to the EU/UK, if this field is empty, we will provide them with the phone number provided when the cardholder was initially created.
- require_signature? boolean? - Whether a signature is required for card delivery. This feature is only supported for US users. Standard shipping service does not support signature on delivery. The default value for standard shipping service is false and for express and priority services is true.
- 'service "express"|"priority"|"standard" - Shipment service, such as
standardorexpress.
- status? "canceled"|"delivered"|"failure"|"pending"|"returned"|"shipped"? - The delivery status of the card.
- tracking_number? string? - A tracking number for a card shipment.
- tracking_url? string? - A link to the shipping carrier's site where you can view detailed information about a card shipment.
- 'type "bulk"|"individual" - Packaging options.
stripe: Issuing_card_shipping_address_validation
Fields
- mode "disabled"|"normalization_only"|"validation_and_normalization" - The address validation capabilities to use.
- normalized_address? Address? - The normalized shipping address.
- result? "indeterminate"|"likely_deliverable"|"likely_undeliverable"? - The validation result for the shipping address.
stripe: Issuing_card_shipping_customs
Fields
- eori_number? string? - A registration number used for customs in Europe. See https://www.gov.uk/eori for the UK and https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en for the EU.
stripe: Issuing_card_spending_limit
Fields
- amount int - Maximum amount allowed to spend per interval. This amount is in the card's currency and in the smallest currency unit.
- categories? ("ac_refrigeration_repair"|"accounting_bookkeeping_services"|"advertising_services"|"agricultural_cooperative"|"airlines_air_carriers"|"airports_flying_fields"|"ambulance_services"|"amusement_parks_carnivals"|"antique_reproductions"|"antique_shops"|"aquariums"|"architectural_surveying_services"|"art_dealers_and_galleries"|"artists_supply_and_craft_shops"|"auto_and_home_supply_stores"|"auto_body_repair_shops"|"auto_paint_shops"|"auto_service_shops"|"automated_cash_disburse"|"automated_fuel_dispensers"|"automobile_associations"|"automotive_parts_and_accessories_stores"|"automotive_tire_stores"|"bail_and_bond_payments"|"bakeries"|"bands_orchestras"|"barber_and_beauty_shops"|"betting_casino_gambling"|"bicycle_shops"|"billiard_pool_establishments"|"boat_dealers"|"boat_rentals_and_leases"|"book_stores"|"books_periodicals_and_newspapers"|"bowling_alleys"|"bus_lines"|"business_secretarial_schools"|"buying_shopping_services"|"cable_satellite_and_other_pay_television_and_radio"|"camera_and_photographic_supply_stores"|"candy_nut_and_confectionery_stores"|"car_and_truck_dealers_new_used"|"car_and_truck_dealers_used_only"|"car_rental_agencies"|"car_washes"|"carpentry_services"|"carpet_upholstery_cleaning"|"caterers"|"charitable_and_social_service_organizations_fundraising"|"chemicals_and_allied_products"|"child_care_services"|"childrens_and_infants_wear_stores"|"chiropodists_podiatrists"|"chiropractors"|"cigar_stores_and_stands"|"civic_social_fraternal_associations"|"cleaning_and_maintenance"|"clothing_rental"|"colleges_universities"|"commercial_equipment"|"commercial_footwear"|"commercial_photography_art_and_graphics"|"commuter_transport_and_ferries"|"computer_network_services"|"computer_programming"|"computer_repair"|"computer_software_stores"|"computers_peripherals_and_software"|"concrete_work_services"|"construction_materials"|"consulting_public_relations"|"correspondence_schools"|"cosmetic_stores"|"counseling_services"|"country_clubs"|"courier_services"|"court_costs"|"credit_reporting_agencies"|"cruise_lines"|"dairy_products_stores"|"dance_hall_studios_schools"|"dating_escort_services"|"dentists_orthodontists"|"department_stores"|"detective_agencies"|"digital_goods_applications"|"digital_goods_games"|"digital_goods_large_volume"|"digital_goods_media"|"direct_marketing_catalog_merchant"|"direct_marketing_combination_catalog_and_retail_merchant"|"direct_marketing_inbound_telemarketing"|"direct_marketing_insurance_services"|"direct_marketing_other"|"direct_marketing_outbound_telemarketing"|"direct_marketing_subscription"|"direct_marketing_travel"|"discount_stores"|"doctors"|"door_to_door_sales"|"drapery_window_covering_and_upholstery_stores"|"drinking_places"|"drug_stores_and_pharmacies"|"drugs_drug_proprietaries_and_druggist_sundries"|"dry_cleaners"|"durable_goods"|"duty_free_stores"|"eating_places_restaurants"|"educational_services"|"electric_razor_stores"|"electric_vehicle_charging"|"electrical_parts_and_equipment"|"electrical_services"|"electronics_repair_shops"|"electronics_stores"|"elementary_secondary_schools"|"emergency_services_gcas_visa_use_only"|"employment_temp_agencies"|"equipment_rental"|"exterminating_services"|"family_clothing_stores"|"fast_food_restaurants"|"financial_institutions"|"fines_government_administrative_entities"|"fireplace_fireplace_screens_and_accessories_stores"|"floor_covering_stores"|"florists"|"florists_supplies_nursery_stock_and_flowers"|"freezer_and_locker_meat_provisioners"|"fuel_dealers_non_automotive"|"funeral_services_crematories"|"furniture_home_furnishings_and_equipment_stores_except_appliances"|"furniture_repair_refinishing"|"furriers_and_fur_shops"|"general_services"|"gift_card_novelty_and_souvenir_shops"|"glass_paint_and_wallpaper_stores"|"glassware_crystal_stores"|"golf_courses_public"|"government_licensed_horse_dog_racing_us_region_only"|"government_licensed_online_casions_online_gambling_us_region_only"|"government_owned_lotteries_non_us_region"|"government_owned_lotteries_us_region_only"|"government_services"|"grocery_stores_supermarkets"|"hardware_equipment_and_supplies"|"hardware_stores"|"health_and_beauty_spas"|"hearing_aids_sales_and_supplies"|"heating_plumbing_a_c"|"hobby_toy_and_game_shops"|"home_supply_warehouse_stores"|"hospitals"|"hotels_motels_and_resorts"|"household_appliance_stores"|"industrial_supplies"|"information_retrieval_services"|"insurance_default"|"insurance_underwriting_premiums"|"intra_company_purchases"|"jewelry_stores_watches_clocks_and_silverware_stores"|"landscaping_services"|"laundries"|"laundry_cleaning_services"|"legal_services_attorneys"|"luggage_and_leather_goods_stores"|"lumber_building_materials_stores"|"manual_cash_disburse"|"marinas_service_and_supplies"|"marketplaces"|"masonry_stonework_and_plaster"|"massage_parlors"|"medical_and_dental_labs"|"medical_dental_ophthalmic_and_hospital_equipment_and_supplies"|"medical_services"|"membership_organizations"|"mens_and_boys_clothing_and_accessories_stores"|"mens_womens_clothing_stores"|"metal_service_centers"|"miscellaneous"|"miscellaneous_apparel_and_accessory_shops"|"miscellaneous_auto_dealers"|"miscellaneous_business_services"|"miscellaneous_food_stores"|"miscellaneous_general_merchandise"|"miscellaneous_general_services"|"miscellaneous_home_furnishing_specialty_stores"|"miscellaneous_publishing_and_printing"|"miscellaneous_recreation_services"|"miscellaneous_repair_shops"|"miscellaneous_specialty_retail"|"mobile_home_dealers"|"motion_picture_theaters"|"motor_freight_carriers_and_trucking"|"motor_homes_dealers"|"motor_vehicle_supplies_and_new_parts"|"motorcycle_shops_and_dealers"|"motorcycle_shops_dealers"|"music_stores_musical_instruments_pianos_and_sheet_music"|"news_dealers_and_newsstands"|"non_fi_money_orders"|"non_fi_stored_value_card_purchase_load"|"nondurable_goods"|"nurseries_lawn_and_garden_supply_stores"|"nursing_personal_care"|"office_and_commercial_furniture"|"opticians_eyeglasses"|"optometrists_ophthalmologist"|"orthopedic_goods_prosthetic_devices"|"osteopaths"|"package_stores_beer_wine_and_liquor"|"paints_varnishes_and_supplies"|"parking_lots_garages"|"passenger_railways"|"pawn_shops"|"pet_shops_pet_food_and_supplies"|"petroleum_and_petroleum_products"|"photo_developing"|"photographic_photocopy_microfilm_equipment_and_supplies"|"photographic_studios"|"picture_video_production"|"piece_goods_notions_and_other_dry_goods"|"plumbing_heating_equipment_and_supplies"|"political_organizations"|"postal_services_government_only"|"precious_stones_and_metals_watches_and_jewelry"|"professional_services"|"public_warehousing_and_storage"|"quick_copy_repro_and_blueprint"|"railroads"|"real_estate_agents_and_managers_rentals"|"record_stores"|"recreational_vehicle_rentals"|"religious_goods_stores"|"religious_organizations"|"roofing_siding_sheet_metal"|"secretarial_support_services"|"security_brokers_dealers"|"service_stations"|"sewing_needlework_fabric_and_piece_goods_stores"|"shoe_repair_hat_cleaning"|"shoe_stores"|"small_appliance_repair"|"snowmobile_dealers"|"special_trade_services"|"specialty_cleaning"|"sporting_goods_stores"|"sporting_recreation_camps"|"sports_and_riding_apparel_stores"|"sports_clubs_fields"|"stamp_and_coin_stores"|"stationary_office_supplies_printing_and_writing_paper"|"stationery_stores_office_and_school_supply_stores"|"swimming_pools_sales"|"t_ui_travel_germany"|"tailors_alterations"|"tax_payments_government_agencies"|"tax_preparation_services"|"taxicabs_limousines"|"telecommunication_equipment_and_telephone_sales"|"telecommunication_services"|"telegraph_services"|"tent_and_awning_shops"|"testing_laboratories"|"theatrical_ticket_agencies"|"timeshares"|"tire_retreading_and_repair"|"tolls_bridge_fees"|"tourist_attractions_and_exhibits"|"towing_services"|"trailer_parks_campgrounds"|"transportation_services"|"travel_agencies_tour_operators"|"truck_stop_iteration"|"truck_utility_trailer_rentals"|"typesetting_plate_making_and_related_services"|"typewriter_stores"|"u_s_federal_government_agencies_or_departments"|"uniforms_commercial_clothing"|"used_merchandise_and_secondhand_stores"|"utilities"|"variety_stores"|"veterinary_services"|"video_amusement_game_supplies"|"video_game_arcades"|"video_tape_rental_stores"|"vocational_trade_schools"|"watch_jewelry_repair"|"welding_repair"|"wholesale_clubs"|"wig_and_toupee_stores"|"wires_money_orders"|"womens_accessory_and_specialty_shops"|"womens_ready_to_wear_stores"|"wrecking_and_salvage_yards")[]? - Array of strings containing categories this limit applies to. Omitting this field will apply the limit to all categories.
- interval "all_time"|"daily"|"monthly"|"per_authorization"|"weekly"|"yearly" - Interval (or event) to which the amount applies.
stripe: Issuing_card_wallets
Fields
- apple_pay Issuing_card_apple_pay -
- google_pay Issuing_card_google_pay -
- primary_account_identifier? string? - Unique identifier for a card used with digital wallets
stripe: Issuing_cardholder_address
Fields
- address Address -
stripe: Issuing_cardholder_authorization_controls
Fields
- allowed_categories? ("ac_refrigeration_repair"|"accounting_bookkeeping_services"|"advertising_services"|"agricultural_cooperative"|"airlines_air_carriers"|"airports_flying_fields"|"ambulance_services"|"amusement_parks_carnivals"|"antique_reproductions"|"antique_shops"|"aquariums"|"architectural_surveying_services"|"art_dealers_and_galleries"|"artists_supply_and_craft_shops"|"auto_and_home_supply_stores"|"auto_body_repair_shops"|"auto_paint_shops"|"auto_service_shops"|"automated_cash_disburse"|"automated_fuel_dispensers"|"automobile_associations"|"automotive_parts_and_accessories_stores"|"automotive_tire_stores"|"bail_and_bond_payments"|"bakeries"|"bands_orchestras"|"barber_and_beauty_shops"|"betting_casino_gambling"|"bicycle_shops"|"billiard_pool_establishments"|"boat_dealers"|"boat_rentals_and_leases"|"book_stores"|"books_periodicals_and_newspapers"|"bowling_alleys"|"bus_lines"|"business_secretarial_schools"|"buying_shopping_services"|"cable_satellite_and_other_pay_television_and_radio"|"camera_and_photographic_supply_stores"|"candy_nut_and_confectionery_stores"|"car_and_truck_dealers_new_used"|"car_and_truck_dealers_used_only"|"car_rental_agencies"|"car_washes"|"carpentry_services"|"carpet_upholstery_cleaning"|"caterers"|"charitable_and_social_service_organizations_fundraising"|"chemicals_and_allied_products"|"child_care_services"|"childrens_and_infants_wear_stores"|"chiropodists_podiatrists"|"chiropractors"|"cigar_stores_and_stands"|"civic_social_fraternal_associations"|"cleaning_and_maintenance"|"clothing_rental"|"colleges_universities"|"commercial_equipment"|"commercial_footwear"|"commercial_photography_art_and_graphics"|"commuter_transport_and_ferries"|"computer_network_services"|"computer_programming"|"computer_repair"|"computer_software_stores"|"computers_peripherals_and_software"|"concrete_work_services"|"construction_materials"|"consulting_public_relations"|"correspondence_schools"|"cosmetic_stores"|"counseling_services"|"country_clubs"|"courier_services"|"court_costs"|"credit_reporting_agencies"|"cruise_lines"|"dairy_products_stores"|"dance_hall_studios_schools"|"dating_escort_services"|"dentists_orthodontists"|"department_stores"|"detective_agencies"|"digital_goods_applications"|"digital_goods_games"|"digital_goods_large_volume"|"digital_goods_media"|"direct_marketing_catalog_merchant"|"direct_marketing_combination_catalog_and_retail_merchant"|"direct_marketing_inbound_telemarketing"|"direct_marketing_insurance_services"|"direct_marketing_other"|"direct_marketing_outbound_telemarketing"|"direct_marketing_subscription"|"direct_marketing_travel"|"discount_stores"|"doctors"|"door_to_door_sales"|"drapery_window_covering_and_upholstery_stores"|"drinking_places"|"drug_stores_and_pharmacies"|"drugs_drug_proprietaries_and_druggist_sundries"|"dry_cleaners"|"durable_goods"|"duty_free_stores"|"eating_places_restaurants"|"educational_services"|"electric_razor_stores"|"electric_vehicle_charging"|"electrical_parts_and_equipment"|"electrical_services"|"electronics_repair_shops"|"electronics_stores"|"elementary_secondary_schools"|"emergency_services_gcas_visa_use_only"|"employment_temp_agencies"|"equipment_rental"|"exterminating_services"|"family_clothing_stores"|"fast_food_restaurants"|"financial_institutions"|"fines_government_administrative_entities"|"fireplace_fireplace_screens_and_accessories_stores"|"floor_covering_stores"|"florists"|"florists_supplies_nursery_stock_and_flowers"|"freezer_and_locker_meat_provisioners"|"fuel_dealers_non_automotive"|"funeral_services_crematories"|"furniture_home_furnishings_and_equipment_stores_except_appliances"|"furniture_repair_refinishing"|"furriers_and_fur_shops"|"general_services"|"gift_card_novelty_and_souvenir_shops"|"glass_paint_and_wallpaper_stores"|"glassware_crystal_stores"|"golf_courses_public"|"government_licensed_horse_dog_racing_us_region_only"|"government_licensed_online_casions_online_gambling_us_region_only"|"government_owned_lotteries_non_us_region"|"government_owned_lotteries_us_region_only"|"government_services"|"grocery_stores_supermarkets"|"hardware_equipment_and_supplies"|"hardware_stores"|"health_and_beauty_spas"|"hearing_aids_sales_and_supplies"|"heating_plumbing_a_c"|"hobby_toy_and_game_shops"|"home_supply_warehouse_stores"|"hospitals"|"hotels_motels_and_resorts"|"household_appliance_stores"|"industrial_supplies"|"information_retrieval_services"|"insurance_default"|"insurance_underwriting_premiums"|"intra_company_purchases"|"jewelry_stores_watches_clocks_and_silverware_stores"|"landscaping_services"|"laundries"|"laundry_cleaning_services"|"legal_services_attorneys"|"luggage_and_leather_goods_stores"|"lumber_building_materials_stores"|"manual_cash_disburse"|"marinas_service_and_supplies"|"marketplaces"|"masonry_stonework_and_plaster"|"massage_parlors"|"medical_and_dental_labs"|"medical_dental_ophthalmic_and_hospital_equipment_and_supplies"|"medical_services"|"membership_organizations"|"mens_and_boys_clothing_and_accessories_stores"|"mens_womens_clothing_stores"|"metal_service_centers"|"miscellaneous"|"miscellaneous_apparel_and_accessory_shops"|"miscellaneous_auto_dealers"|"miscellaneous_business_services"|"miscellaneous_food_stores"|"miscellaneous_general_merchandise"|"miscellaneous_general_services"|"miscellaneous_home_furnishing_specialty_stores"|"miscellaneous_publishing_and_printing"|"miscellaneous_recreation_services"|"miscellaneous_repair_shops"|"miscellaneous_specialty_retail"|"mobile_home_dealers"|"motion_picture_theaters"|"motor_freight_carriers_and_trucking"|"motor_homes_dealers"|"motor_vehicle_supplies_and_new_parts"|"motorcycle_shops_and_dealers"|"motorcycle_shops_dealers"|"music_stores_musical_instruments_pianos_and_sheet_music"|"news_dealers_and_newsstands"|"non_fi_money_orders"|"non_fi_stored_value_card_purchase_load"|"nondurable_goods"|"nurseries_lawn_and_garden_supply_stores"|"nursing_personal_care"|"office_and_commercial_furniture"|"opticians_eyeglasses"|"optometrists_ophthalmologist"|"orthopedic_goods_prosthetic_devices"|"osteopaths"|"package_stores_beer_wine_and_liquor"|"paints_varnishes_and_supplies"|"parking_lots_garages"|"passenger_railways"|"pawn_shops"|"pet_shops_pet_food_and_supplies"|"petroleum_and_petroleum_products"|"photo_developing"|"photographic_photocopy_microfilm_equipment_and_supplies"|"photographic_studios"|"picture_video_production"|"piece_goods_notions_and_other_dry_goods"|"plumbing_heating_equipment_and_supplies"|"political_organizations"|"postal_services_government_only"|"precious_stones_and_metals_watches_and_jewelry"|"professional_services"|"public_warehousing_and_storage"|"quick_copy_repro_and_blueprint"|"railroads"|"real_estate_agents_and_managers_rentals"|"record_stores"|"recreational_vehicle_rentals"|"religious_goods_stores"|"religious_organizations"|"roofing_siding_sheet_metal"|"secretarial_support_services"|"security_brokers_dealers"|"service_stations"|"sewing_needlework_fabric_and_piece_goods_stores"|"shoe_repair_hat_cleaning"|"shoe_stores"|"small_appliance_repair"|"snowmobile_dealers"|"special_trade_services"|"specialty_cleaning"|"sporting_goods_stores"|"sporting_recreation_camps"|"sports_and_riding_apparel_stores"|"sports_clubs_fields"|"stamp_and_coin_stores"|"stationary_office_supplies_printing_and_writing_paper"|"stationery_stores_office_and_school_supply_stores"|"swimming_pools_sales"|"t_ui_travel_germany"|"tailors_alterations"|"tax_payments_government_agencies"|"tax_preparation_services"|"taxicabs_limousines"|"telecommunication_equipment_and_telephone_sales"|"telecommunication_services"|"telegraph_services"|"tent_and_awning_shops"|"testing_laboratories"|"theatrical_ticket_agencies"|"timeshares"|"tire_retreading_and_repair"|"tolls_bridge_fees"|"tourist_attractions_and_exhibits"|"towing_services"|"trailer_parks_campgrounds"|"transportation_services"|"travel_agencies_tour_operators"|"truck_stop_iteration"|"truck_utility_trailer_rentals"|"typesetting_plate_making_and_related_services"|"typewriter_stores"|"u_s_federal_government_agencies_or_departments"|"uniforms_commercial_clothing"|"used_merchandise_and_secondhand_stores"|"utilities"|"variety_stores"|"veterinary_services"|"video_amusement_game_supplies"|"video_game_arcades"|"video_tape_rental_stores"|"vocational_trade_schools"|"watch_jewelry_repair"|"welding_repair"|"wholesale_clubs"|"wig_and_toupee_stores"|"wires_money_orders"|"womens_accessory_and_specialty_shops"|"womens_ready_to_wear_stores"|"wrecking_and_salvage_yards")[]? - Array of strings containing categories of authorizations to allow. All other categories will be blocked. Cannot be set with
blocked_categories.
- allowed_merchant_countries? Issuing_cardholder_authorization_controlsAllowedmerchantcountriesItemsString[]? - Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g.
US). Cannot be set withblocked_merchant_countries. Provide an empty value to unset this control.
- blocked_categories? ("ac_refrigeration_repair"|"accounting_bookkeeping_services"|"advertising_services"|"agricultural_cooperative"|"airlines_air_carriers"|"airports_flying_fields"|"ambulance_services"|"amusement_parks_carnivals"|"antique_reproductions"|"antique_shops"|"aquariums"|"architectural_surveying_services"|"art_dealers_and_galleries"|"artists_supply_and_craft_shops"|"auto_and_home_supply_stores"|"auto_body_repair_shops"|"auto_paint_shops"|"auto_service_shops"|"automated_cash_disburse"|"automated_fuel_dispensers"|"automobile_associations"|"automotive_parts_and_accessories_stores"|"automotive_tire_stores"|"bail_and_bond_payments"|"bakeries"|"bands_orchestras"|"barber_and_beauty_shops"|"betting_casino_gambling"|"bicycle_shops"|"billiard_pool_establishments"|"boat_dealers"|"boat_rentals_and_leases"|"book_stores"|"books_periodicals_and_newspapers"|"bowling_alleys"|"bus_lines"|"business_secretarial_schools"|"buying_shopping_services"|"cable_satellite_and_other_pay_television_and_radio"|"camera_and_photographic_supply_stores"|"candy_nut_and_confectionery_stores"|"car_and_truck_dealers_new_used"|"car_and_truck_dealers_used_only"|"car_rental_agencies"|"car_washes"|"carpentry_services"|"carpet_upholstery_cleaning"|"caterers"|"charitable_and_social_service_organizations_fundraising"|"chemicals_and_allied_products"|"child_care_services"|"childrens_and_infants_wear_stores"|"chiropodists_podiatrists"|"chiropractors"|"cigar_stores_and_stands"|"civic_social_fraternal_associations"|"cleaning_and_maintenance"|"clothing_rental"|"colleges_universities"|"commercial_equipment"|"commercial_footwear"|"commercial_photography_art_and_graphics"|"commuter_transport_and_ferries"|"computer_network_services"|"computer_programming"|"computer_repair"|"computer_software_stores"|"computers_peripherals_and_software"|"concrete_work_services"|"construction_materials"|"consulting_public_relations"|"correspondence_schools"|"cosmetic_stores"|"counseling_services"|"country_clubs"|"courier_services"|"court_costs"|"credit_reporting_agencies"|"cruise_lines"|"dairy_products_stores"|"dance_hall_studios_schools"|"dating_escort_services"|"dentists_orthodontists"|"department_stores"|"detective_agencies"|"digital_goods_applications"|"digital_goods_games"|"digital_goods_large_volume"|"digital_goods_media"|"direct_marketing_catalog_merchant"|"direct_marketing_combination_catalog_and_retail_merchant"|"direct_marketing_inbound_telemarketing"|"direct_marketing_insurance_services"|"direct_marketing_other"|"direct_marketing_outbound_telemarketing"|"direct_marketing_subscription"|"direct_marketing_travel"|"discount_stores"|"doctors"|"door_to_door_sales"|"drapery_window_covering_and_upholstery_stores"|"drinking_places"|"drug_stores_and_pharmacies"|"drugs_drug_proprietaries_and_druggist_sundries"|"dry_cleaners"|"durable_goods"|"duty_free_stores"|"eating_places_restaurants"|"educational_services"|"electric_razor_stores"|"electric_vehicle_charging"|"electrical_parts_and_equipment"|"electrical_services"|"electronics_repair_shops"|"electronics_stores"|"elementary_secondary_schools"|"emergency_services_gcas_visa_use_only"|"employment_temp_agencies"|"equipment_rental"|"exterminating_services"|"family_clothing_stores"|"fast_food_restaurants"|"financial_institutions"|"fines_government_administrative_entities"|"fireplace_fireplace_screens_and_accessories_stores"|"floor_covering_stores"|"florists"|"florists_supplies_nursery_stock_and_flowers"|"freezer_and_locker_meat_provisioners"|"fuel_dealers_non_automotive"|"funeral_services_crematories"|"furniture_home_furnishings_and_equipment_stores_except_appliances"|"furniture_repair_refinishing"|"furriers_and_fur_shops"|"general_services"|"gift_card_novelty_and_souvenir_shops"|"glass_paint_and_wallpaper_stores"|"glassware_crystal_stores"|"golf_courses_public"|"government_licensed_horse_dog_racing_us_region_only"|"government_licensed_online_casions_online_gambling_us_region_only"|"government_owned_lotteries_non_us_region"|"government_owned_lotteries_us_region_only"|"government_services"|"grocery_stores_supermarkets"|"hardware_equipment_and_supplies"|"hardware_stores"|"health_and_beauty_spas"|"hearing_aids_sales_and_supplies"|"heating_plumbing_a_c"|"hobby_toy_and_game_shops"|"home_supply_warehouse_stores"|"hospitals"|"hotels_motels_and_resorts"|"household_appliance_stores"|"industrial_supplies"|"information_retrieval_services"|"insurance_default"|"insurance_underwriting_premiums"|"intra_company_purchases"|"jewelry_stores_watches_clocks_and_silverware_stores"|"landscaping_services"|"laundries"|"laundry_cleaning_services"|"legal_services_attorneys"|"luggage_and_leather_goods_stores"|"lumber_building_materials_stores"|"manual_cash_disburse"|"marinas_service_and_supplies"|"marketplaces"|"masonry_stonework_and_plaster"|"massage_parlors"|"medical_and_dental_labs"|"medical_dental_ophthalmic_and_hospital_equipment_and_supplies"|"medical_services"|"membership_organizations"|"mens_and_boys_clothing_and_accessories_stores"|"mens_womens_clothing_stores"|"metal_service_centers"|"miscellaneous"|"miscellaneous_apparel_and_accessory_shops"|"miscellaneous_auto_dealers"|"miscellaneous_business_services"|"miscellaneous_food_stores"|"miscellaneous_general_merchandise"|"miscellaneous_general_services"|"miscellaneous_home_furnishing_specialty_stores"|"miscellaneous_publishing_and_printing"|"miscellaneous_recreation_services"|"miscellaneous_repair_shops"|"miscellaneous_specialty_retail"|"mobile_home_dealers"|"motion_picture_theaters"|"motor_freight_carriers_and_trucking"|"motor_homes_dealers"|"motor_vehicle_supplies_and_new_parts"|"motorcycle_shops_and_dealers"|"motorcycle_shops_dealers"|"music_stores_musical_instruments_pianos_and_sheet_music"|"news_dealers_and_newsstands"|"non_fi_money_orders"|"non_fi_stored_value_card_purchase_load"|"nondurable_goods"|"nurseries_lawn_and_garden_supply_stores"|"nursing_personal_care"|"office_and_commercial_furniture"|"opticians_eyeglasses"|"optometrists_ophthalmologist"|"orthopedic_goods_prosthetic_devices"|"osteopaths"|"package_stores_beer_wine_and_liquor"|"paints_varnishes_and_supplies"|"parking_lots_garages"|"passenger_railways"|"pawn_shops"|"pet_shops_pet_food_and_supplies"|"petroleum_and_petroleum_products"|"photo_developing"|"photographic_photocopy_microfilm_equipment_and_supplies"|"photographic_studios"|"picture_video_production"|"piece_goods_notions_and_other_dry_goods"|"plumbing_heating_equipment_and_supplies"|"political_organizations"|"postal_services_government_only"|"precious_stones_and_metals_watches_and_jewelry"|"professional_services"|"public_warehousing_and_storage"|"quick_copy_repro_and_blueprint"|"railroads"|"real_estate_agents_and_managers_rentals"|"record_stores"|"recreational_vehicle_rentals"|"religious_goods_stores"|"religious_organizations"|"roofing_siding_sheet_metal"|"secretarial_support_services"|"security_brokers_dealers"|"service_stations"|"sewing_needlework_fabric_and_piece_goods_stores"|"shoe_repair_hat_cleaning"|"shoe_stores"|"small_appliance_repair"|"snowmobile_dealers"|"special_trade_services"|"specialty_cleaning"|"sporting_goods_stores"|"sporting_recreation_camps"|"sports_and_riding_apparel_stores"|"sports_clubs_fields"|"stamp_and_coin_stores"|"stationary_office_supplies_printing_and_writing_paper"|"stationery_stores_office_and_school_supply_stores"|"swimming_pools_sales"|"t_ui_travel_germany"|"tailors_alterations"|"tax_payments_government_agencies"|"tax_preparation_services"|"taxicabs_limousines"|"telecommunication_equipment_and_telephone_sales"|"telecommunication_services"|"telegraph_services"|"tent_and_awning_shops"|"testing_laboratories"|"theatrical_ticket_agencies"|"timeshares"|"tire_retreading_and_repair"|"tolls_bridge_fees"|"tourist_attractions_and_exhibits"|"towing_services"|"trailer_parks_campgrounds"|"transportation_services"|"travel_agencies_tour_operators"|"truck_stop_iteration"|"truck_utility_trailer_rentals"|"typesetting_plate_making_and_related_services"|"typewriter_stores"|"u_s_federal_government_agencies_or_departments"|"uniforms_commercial_clothing"|"used_merchandise_and_secondhand_stores"|"utilities"|"variety_stores"|"veterinary_services"|"video_amusement_game_supplies"|"video_game_arcades"|"video_tape_rental_stores"|"vocational_trade_schools"|"watch_jewelry_repair"|"welding_repair"|"wholesale_clubs"|"wig_and_toupee_stores"|"wires_money_orders"|"womens_accessory_and_specialty_shops"|"womens_ready_to_wear_stores"|"wrecking_and_salvage_yards")[]? - Array of strings containing categories of authorizations to decline. All other categories will be allowed. Cannot be set with
allowed_categories.
- blocked_merchant_countries? Issuing_cardholder_authorization_controlsBlockedmerchantcountriesItemsString[]? - Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g.
US). Cannot be set withallowed_merchant_countries. Provide an empty value to unset this control.
- spending_limits? Issuing_cardholder_spending_limit[]? - Limit spending with amount-based rules that apply across this cardholder's cards.
- spending_limits_currency? string? - Currency of the amounts within
spending_limits.
stripe: Issuing_cardholder_card_issuing
Fields
- user_terms_acceptance? Issuing_cardholder_user_terms_acceptance? - Information about cardholder acceptance of Celtic Authorized User Terms. Required for cards backed by a Celtic program.
stripe: Issuing_cardholder_company
Fields
- tax_id_provided boolean - Whether the company's business ID number was provided.
stripe: Issuing_cardholder_id_document
Fields
- back? string|File? - The back of a document returned by a file upload with a
purposevalue ofidentity_document.
- front? string|File? - The front of a document returned by a file upload with a
purposevalue ofidentity_document.
stripe: Issuing_cardholder_individual
Fields
- card_issuing? Issuing_cardholder_card_issuing? - Information related to the card_issuing program for this cardholder.
- dob? Issuing_cardholder_individual_dob? - The date of birth of this cardholder.
- first_name? string? - The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.
- last_name? string? - The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.
- verification? Issuing_cardholder_verification? - Government-issued ID document for this cardholder.
stripe: Issuing_cardholder_individual_dob
Fields
- day? int? - The day of birth, between 1 and 31.
- month? int? - The month of birth, between 1 and 12.
- year? int? - The four-digit year of birth.
stripe: Issuing_cardholder_requirements
Fields
- disabled_reason? "listed"|"rejected.listed"|"requirements.past_due"|"under_review"? - If
disabled_reasonis present, all cards will decline authorizations withcardholder_verification_requiredreason.
- past_due? ("company.tax_id"|"individual.card_issuing.user_terms_acceptance.date"|"individual.card_issuing.user_terms_acceptance.ip"|"individual.dob.day"|"individual.dob.month"|"individual.dob.year"|"individual.first_name"|"individual.last_name"|"individual.verification.document")[]? - Array of fields that need to be collected in order to verify and re-enable the cardholder.
stripe: Issuing_cardholder_spending_limit
Fields
- amount int - Maximum amount allowed to spend per interval. This amount is in the card's currency and in the smallest currency unit.
- categories? ("ac_refrigeration_repair"|"accounting_bookkeeping_services"|"advertising_services"|"agricultural_cooperative"|"airlines_air_carriers"|"airports_flying_fields"|"ambulance_services"|"amusement_parks_carnivals"|"antique_reproductions"|"antique_shops"|"aquariums"|"architectural_surveying_services"|"art_dealers_and_galleries"|"artists_supply_and_craft_shops"|"auto_and_home_supply_stores"|"auto_body_repair_shops"|"auto_paint_shops"|"auto_service_shops"|"automated_cash_disburse"|"automated_fuel_dispensers"|"automobile_associations"|"automotive_parts_and_accessories_stores"|"automotive_tire_stores"|"bail_and_bond_payments"|"bakeries"|"bands_orchestras"|"barber_and_beauty_shops"|"betting_casino_gambling"|"bicycle_shops"|"billiard_pool_establishments"|"boat_dealers"|"boat_rentals_and_leases"|"book_stores"|"books_periodicals_and_newspapers"|"bowling_alleys"|"bus_lines"|"business_secretarial_schools"|"buying_shopping_services"|"cable_satellite_and_other_pay_television_and_radio"|"camera_and_photographic_supply_stores"|"candy_nut_and_confectionery_stores"|"car_and_truck_dealers_new_used"|"car_and_truck_dealers_used_only"|"car_rental_agencies"|"car_washes"|"carpentry_services"|"carpet_upholstery_cleaning"|"caterers"|"charitable_and_social_service_organizations_fundraising"|"chemicals_and_allied_products"|"child_care_services"|"childrens_and_infants_wear_stores"|"chiropodists_podiatrists"|"chiropractors"|"cigar_stores_and_stands"|"civic_social_fraternal_associations"|"cleaning_and_maintenance"|"clothing_rental"|"colleges_universities"|"commercial_equipment"|"commercial_footwear"|"commercial_photography_art_and_graphics"|"commuter_transport_and_ferries"|"computer_network_services"|"computer_programming"|"computer_repair"|"computer_software_stores"|"computers_peripherals_and_software"|"concrete_work_services"|"construction_materials"|"consulting_public_relations"|"correspondence_schools"|"cosmetic_stores"|"counseling_services"|"country_clubs"|"courier_services"|"court_costs"|"credit_reporting_agencies"|"cruise_lines"|"dairy_products_stores"|"dance_hall_studios_schools"|"dating_escort_services"|"dentists_orthodontists"|"department_stores"|"detective_agencies"|"digital_goods_applications"|"digital_goods_games"|"digital_goods_large_volume"|"digital_goods_media"|"direct_marketing_catalog_merchant"|"direct_marketing_combination_catalog_and_retail_merchant"|"direct_marketing_inbound_telemarketing"|"direct_marketing_insurance_services"|"direct_marketing_other"|"direct_marketing_outbound_telemarketing"|"direct_marketing_subscription"|"direct_marketing_travel"|"discount_stores"|"doctors"|"door_to_door_sales"|"drapery_window_covering_and_upholstery_stores"|"drinking_places"|"drug_stores_and_pharmacies"|"drugs_drug_proprietaries_and_druggist_sundries"|"dry_cleaners"|"durable_goods"|"duty_free_stores"|"eating_places_restaurants"|"educational_services"|"electric_razor_stores"|"electric_vehicle_charging"|"electrical_parts_and_equipment"|"electrical_services"|"electronics_repair_shops"|"electronics_stores"|"elementary_secondary_schools"|"emergency_services_gcas_visa_use_only"|"employment_temp_agencies"|"equipment_rental"|"exterminating_services"|"family_clothing_stores"|"fast_food_restaurants"|"financial_institutions"|"fines_government_administrative_entities"|"fireplace_fireplace_screens_and_accessories_stores"|"floor_covering_stores"|"florists"|"florists_supplies_nursery_stock_and_flowers"|"freezer_and_locker_meat_provisioners"|"fuel_dealers_non_automotive"|"funeral_services_crematories"|"furniture_home_furnishings_and_equipment_stores_except_appliances"|"furniture_repair_refinishing"|"furriers_and_fur_shops"|"general_services"|"gift_card_novelty_and_souvenir_shops"|"glass_paint_and_wallpaper_stores"|"glassware_crystal_stores"|"golf_courses_public"|"government_licensed_horse_dog_racing_us_region_only"|"government_licensed_online_casions_online_gambling_us_region_only"|"government_owned_lotteries_non_us_region"|"government_owned_lotteries_us_region_only"|"government_services"|"grocery_stores_supermarkets"|"hardware_equipment_and_supplies"|"hardware_stores"|"health_and_beauty_spas"|"hearing_aids_sales_and_supplies"|"heating_plumbing_a_c"|"hobby_toy_and_game_shops"|"home_supply_warehouse_stores"|"hospitals"|"hotels_motels_and_resorts"|"household_appliance_stores"|"industrial_supplies"|"information_retrieval_services"|"insurance_default"|"insurance_underwriting_premiums"|"intra_company_purchases"|"jewelry_stores_watches_clocks_and_silverware_stores"|"landscaping_services"|"laundries"|"laundry_cleaning_services"|"legal_services_attorneys"|"luggage_and_leather_goods_stores"|"lumber_building_materials_stores"|"manual_cash_disburse"|"marinas_service_and_supplies"|"marketplaces"|"masonry_stonework_and_plaster"|"massage_parlors"|"medical_and_dental_labs"|"medical_dental_ophthalmic_and_hospital_equipment_and_supplies"|"medical_services"|"membership_organizations"|"mens_and_boys_clothing_and_accessories_stores"|"mens_womens_clothing_stores"|"metal_service_centers"|"miscellaneous"|"miscellaneous_apparel_and_accessory_shops"|"miscellaneous_auto_dealers"|"miscellaneous_business_services"|"miscellaneous_food_stores"|"miscellaneous_general_merchandise"|"miscellaneous_general_services"|"miscellaneous_home_furnishing_specialty_stores"|"miscellaneous_publishing_and_printing"|"miscellaneous_recreation_services"|"miscellaneous_repair_shops"|"miscellaneous_specialty_retail"|"mobile_home_dealers"|"motion_picture_theaters"|"motor_freight_carriers_and_trucking"|"motor_homes_dealers"|"motor_vehicle_supplies_and_new_parts"|"motorcycle_shops_and_dealers"|"motorcycle_shops_dealers"|"music_stores_musical_instruments_pianos_and_sheet_music"|"news_dealers_and_newsstands"|"non_fi_money_orders"|"non_fi_stored_value_card_purchase_load"|"nondurable_goods"|"nurseries_lawn_and_garden_supply_stores"|"nursing_personal_care"|"office_and_commercial_furniture"|"opticians_eyeglasses"|"optometrists_ophthalmologist"|"orthopedic_goods_prosthetic_devices"|"osteopaths"|"package_stores_beer_wine_and_liquor"|"paints_varnishes_and_supplies"|"parking_lots_garages"|"passenger_railways"|"pawn_shops"|"pet_shops_pet_food_and_supplies"|"petroleum_and_petroleum_products"|"photo_developing"|"photographic_photocopy_microfilm_equipment_and_supplies"|"photographic_studios"|"picture_video_production"|"piece_goods_notions_and_other_dry_goods"|"plumbing_heating_equipment_and_supplies"|"political_organizations"|"postal_services_government_only"|"precious_stones_and_metals_watches_and_jewelry"|"professional_services"|"public_warehousing_and_storage"|"quick_copy_repro_and_blueprint"|"railroads"|"real_estate_agents_and_managers_rentals"|"record_stores"|"recreational_vehicle_rentals"|"religious_goods_stores"|"religious_organizations"|"roofing_siding_sheet_metal"|"secretarial_support_services"|"security_brokers_dealers"|"service_stations"|"sewing_needlework_fabric_and_piece_goods_stores"|"shoe_repair_hat_cleaning"|"shoe_stores"|"small_appliance_repair"|"snowmobile_dealers"|"special_trade_services"|"specialty_cleaning"|"sporting_goods_stores"|"sporting_recreation_camps"|"sports_and_riding_apparel_stores"|"sports_clubs_fields"|"stamp_and_coin_stores"|"stationary_office_supplies_printing_and_writing_paper"|"stationery_stores_office_and_school_supply_stores"|"swimming_pools_sales"|"t_ui_travel_germany"|"tailors_alterations"|"tax_payments_government_agencies"|"tax_preparation_services"|"taxicabs_limousines"|"telecommunication_equipment_and_telephone_sales"|"telecommunication_services"|"telegraph_services"|"tent_and_awning_shops"|"testing_laboratories"|"theatrical_ticket_agencies"|"timeshares"|"tire_retreading_and_repair"|"tolls_bridge_fees"|"tourist_attractions_and_exhibits"|"towing_services"|"trailer_parks_campgrounds"|"transportation_services"|"travel_agencies_tour_operators"|"truck_stop_iteration"|"truck_utility_trailer_rentals"|"typesetting_plate_making_and_related_services"|"typewriter_stores"|"u_s_federal_government_agencies_or_departments"|"uniforms_commercial_clothing"|"used_merchandise_and_secondhand_stores"|"utilities"|"variety_stores"|"veterinary_services"|"video_amusement_game_supplies"|"video_game_arcades"|"video_tape_rental_stores"|"vocational_trade_schools"|"watch_jewelry_repair"|"welding_repair"|"wholesale_clubs"|"wig_and_toupee_stores"|"wires_money_orders"|"womens_accessory_and_specialty_shops"|"womens_ready_to_wear_stores"|"wrecking_and_salvage_yards")[]? - Array of strings containing categories this limit applies to. Omitting this field will apply the limit to all categories.
- interval "all_time"|"daily"|"monthly"|"per_authorization"|"weekly"|"yearly" - Interval (or event) to which the amount applies.
stripe: Issuing_cardholder_user_terms_acceptance
Fields
- date? int? - The Unix timestamp marking when the cardholder accepted the Authorized User Terms.
- ip? string? - The IP address from which the cardholder accepted the Authorized User Terms.
- user_agent? string? - The user agent of the browser from which the cardholder accepted the Authorized User Terms.
stripe: Issuing_cardholder_verification
Fields
- document? Issuing_cardholder_id_document? - An identifying document, either a passport or local ID card.
stripe: issuing_cardholders_body
Closed record
Fields
- billing billing_specs -
- company? company_param -
- email? string - The cardholder's email address.
- expand? issuing_cardholders_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- individual? individual_param -
- metadata? record { string... } - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- name string - The cardholder's name. This will be printed on cards issued to them. The maximum length of this field is 24 characters. This field cannot contain any special characters or numbers.
- phone_number? string - The cardholder's phone number. This will be transformed to E.164 if it is not provided in that format already. This is required for all cardholders who will be creating EU cards. See the 3D Secure documentation for more details.
- preferred_locales? ("de"|"en"|"es"|"fr"|"it")[] - The cardholder’s preferred locales (languages), ordered by preference. Locales can be
de,en,es,fr, orit. This changes the language of the 3D Secure flow and one-time password messages sent to the cardholder.
- spending_controls? authorization_controls_param_v2 -
- status? "active"|"inactive" - Specifies whether to permit authorizations on this cardholder's cards. Defaults to
active.
- 'type? "company"|"individual" - One of
individualorcompany. See Choose a cardholder type for more details.
stripe: issuing_cards_body
Closed record
Fields
- cardholder? string - The Cardholder object with which the card will be associated.
- currency string - The currency for the card.
- expand? issuing_cards_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- financial_account? string -
- metadata? record { string... } - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- personalization_design? string - The personalization design object belonging to this card.
- pin? encrypted_pin_param -
- replacement_for? string - The card this is meant to be a replacement for (if any).
- replacement_reason? "damaged"|"expired"|"lost"|"stolen" - If
replacement_foris specified, this should indicate why that card is being replaced.
- second_line? string|"" - The second line to print on the card.
- shipping? shipping_specs -
- spending_controls? authorization_controls_param -
- status? "active"|"inactive" - Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to
inactive.
- 'type "physical"|"virtual" - The type of card to issue. Possible values are
physicalorvirtual.
stripe: Issuing_dispute_canceled_evidence
Fields
- additional_documentation? string|File? - (ID of a file upload) Additional documentation supporting the dispute.
- canceled_at? int? - Date when order was canceled.
- cancellation_policy_provided? boolean? - Whether the cardholder was provided with a cancellation policy.
- cancellation_reason? string? - Reason for canceling the order.
- expected_at? int? - Date when the cardholder expected to receive the product.
- explanation? string? - Explanation of why the cardholder is disputing this transaction.
- product_description? string? - Description of the merchandise or service that was purchased.
- product_type? "merchandise"|"service"? - Whether the product was a merchandise or service.
- return_status? "merchant_rejected"|"successful"? - Result of cardholder's attempt to return the product.
- returned_at? int? - Date when the product was returned or attempted to be returned.
stripe: Issuing_dispute_duplicate_evidence
Fields
- additional_documentation? string|File? - (ID of a file upload) Additional documentation supporting the dispute.
- card_statement? string|File? - (ID of a file upload) Copy of the card statement showing that the product had already been paid for.
- cash_receipt? string|File? - (ID of a file upload) Copy of the receipt showing that the product had been paid for in cash.
- check_image? string|File? - (ID of a file upload) Image of the front and back of the check that was used to pay for the product.
- explanation? string? - Explanation of why the cardholder is disputing this transaction.
- original_transaction? string? - Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one.
stripe: Issuing_dispute_evidence
Fields
- canceled? Issuing_dispute_canceled_evidence -
- duplicate? Issuing_dispute_duplicate_evidence -
- fraudulent? Issuing_dispute_fraudulent_evidence -
- merchandise_not_as_described? Issuing_dispute_merchandise_not_as_described_evidence -
- not_received? Issuing_dispute_not_received_evidence -
- other? Issuing_dispute_other_evidence -
- reason "canceled"|"duplicate"|"fraudulent"|"merchandise_not_as_described"|"no_valid_authorization"|"not_received"|"other"|"service_not_as_described" - The reason for filing the dispute. Its value will match the field containing the evidence.
- service_not_as_described? Issuing_dispute_service_not_as_described_evidence -
stripe: Issuing_dispute_fraudulent_evidence
Fields
- additional_documentation? string|File? - (ID of a file upload) Additional documentation supporting the dispute.
- explanation? string? - Explanation of why the cardholder is disputing this transaction.
stripe: Issuing_dispute_merchandise_not_as_described_evidence
Fields
- additional_documentation? string|File? - (ID of a file upload) Additional documentation supporting the dispute.
- explanation? string? - Explanation of why the cardholder is disputing this transaction.
- received_at? int? - Date when the product was received.
- return_description? string? - Description of the cardholder's attempt to return the product.
- return_status? "merchant_rejected"|"successful"? - Result of cardholder's attempt to return the product.
- returned_at? int? - Date when the product was returned or attempted to be returned.
stripe: Issuing_dispute_no_valid_authorization_evidence
Fields
- additional_documentation? string|File? - (ID of a file upload) Additional documentation supporting the dispute.
- explanation? string? - Explanation of why the cardholder is disputing this transaction.
stripe: Issuing_dispute_not_received_evidence
Fields
- additional_documentation? string|File? - (ID of a file upload) Additional documentation supporting the dispute.
- expected_at? int? - Date when the cardholder expected to receive the product.
- explanation? string? - Explanation of why the cardholder is disputing this transaction.
- product_description? string? - Description of the merchandise or service that was purchased.
- product_type? "merchandise"|"service"? - Whether the product was a merchandise or service.
stripe: Issuing_dispute_other_evidence
Fields
- additional_documentation? string|File? - (ID of a file upload) Additional documentation supporting the dispute.
- explanation? string? - Explanation of why the cardholder is disputing this transaction.
- product_description? string? - Description of the merchandise or service that was purchased.
- product_type? "merchandise"|"service"? - Whether the product was a merchandise or service.
stripe: Issuing_dispute_service_not_as_described_evidence
Fields
- additional_documentation? string|File? - (ID of a file upload) Additional documentation supporting the dispute.
- canceled_at? int? - Date when order was canceled.
- cancellation_reason? string? - Reason for canceling the order.
- explanation? string? - Explanation of why the cardholder is disputing this transaction.
- received_at? int? - Date when the product was received.
stripe: Issuing_dispute_treasury
Fields
- debit_reversal? string? - The Treasury DebitReversal representing this Issuing dispute
- received_debit string - The Treasury ReceivedDebit that is being disputed.
stripe: issuing_disputes_body
Closed record
Fields
- amount? int - The dispute amount in the card's currency and in the smallest currency unit. If not set, defaults to the full transaction amount.
- evidence? evidence_param -
- expand? issuing_disputes_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- metadata? record { string... } - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- 'transaction? string - The ID of the issuing transaction to create a dispute for. For transaction on Treasury FinancialAccounts, use
treasury.received_debit.
- treasury? treasury_param -
stripe: Issuing_network_token_address
Fields
- line1 string - The street address of the cardholder tokenizing the card.
- postal_code string - The postal code of the cardholder tokenizing the card.
stripe: Issuing_network_token_device
Fields
- device_fingerprint? string - An obfuscated ID derived from the device ID.
- ip_address? string - The IP address of the device at provisioning time.
- location? string - The geographic latitude/longitude coordinates of the device at provisioning time. The format is [+-]decimal/[+-]decimal.
- name? string - The name of the device used for tokenization.
- phone_number? string - The phone number of the device used for tokenization.
- 'type? "other"|"phone"|"watch" - The type of device used for tokenization.
stripe: Issuing_network_token_mastercard
Fields
- card_reference_id? string - A unique reference ID from MasterCard to represent the card account number.
- token_reference_id string - The network-unique identifier for the token.
- token_requestor_id string - The ID of the entity requesting tokenization, specific to MasterCard.
- token_requestor_name? string - The name of the entity requesting tokenization, if known. This is directly provided from MasterCard.
stripe: Issuing_network_token_network_data
Fields
- device? Issuing_network_token_device -
- mastercard? Issuing_network_token_mastercard -
- 'type "mastercard"|"visa" - The network that the token is associated with. An additional hash is included with a name matching this value, containing tokenization data specific to the card network.
- visa? Issuing_network_token_visa -
- wallet_provider? Issuing_network_token_wallet_provider -
stripe: Issuing_network_token_visa
Fields
- card_reference_id string - A unique reference ID from Visa to represent the card account number.
- token_reference_id string - The network-unique identifier for the token.
- token_requestor_id string - The ID of the entity requesting tokenization, specific to Visa.
- token_risk_score? string - Degree of risk associated with the token between
01and99, with higher number indicating higher risk. A00value indicates the token was not scored by Visa.
stripe: Issuing_network_token_wallet_provider
Fields
- account_id? string - The wallet provider-given account ID of the digital wallet the token belongs to.
- account_trust_score? int - An evaluation on the trustworthiness of the wallet account between 1 and 5. A higher score indicates more trustworthy.
- card_number_source? "app"|"manual"|"on_file"|"other" - The method used for tokenizing a card.
- cardholder_address? Issuing_network_token_address -
- cardholder_name? string - The name of the cardholder tokenizing the card.
- device_trust_score? int - An evaluation on the trustworthiness of the device. A higher score indicates more trustworthy.
- hashed_account_email_address? string - The hashed email address of the cardholder's account with the wallet provider.
- reason_codes? ("account_card_too_new"|"account_recently_changed"|"account_too_new"|"account_too_new_since_launch"|"additional_device"|"data_expired"|"defer_id_v_decision"|"device_recently_lost"|"good_activity_history"|"has_suspended_tokens"|"high_risk"|"inactive_account"|"long_account_tenure"|"low_account_score"|"low_device_score"|"low_phone_number_score"|"network_service_error"|"outside_home_territory"|"provisioning_cardholder_mismatch"|"provisioning_device_and_cardholder_mismatch"|"provisioning_device_mismatch"|"same_device_no_prior_authentication"|"same_device_successful_prior_authentication"|"software_update"|"suspicious_activity"|"too_many_different_cardholders"|"too_many_recent_attempts"|"too_many_recent_tokens")[] - The reasons for suggested tokenization given by the card network.
- suggested_decision? "approve"|"decline"|"require_auth" - The recommendation on responding to the tokenization request.
- suggested_decision_version? string - The version of the standard for mapping reason codes followed by the wallet provider.
stripe: Issuing_personalization_design_carrier_text
Fields
- header_body? string? - The header body text of the carrier letter.
- header_title? string? - The header title text of the carrier letter.
stripe: Issuing_personalization_design_preferences
Fields
- is_default boolean - Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.
- is_platform_default? boolean? - Whether this personalization design is used to create cards when one is not specified and a default for this connected account does not exist.
stripe: Issuing_personalization_design_rejection_reasons
Fields
- card_logo? ("geographic_location"|"inappropriate"|"network_name"|"non_binary_image"|"non_fiat_currency"|"other"|"other_entity"|"promotional_material")[]? - The reason(s) the card logo was rejected.
- carrier_text? ("geographic_location"|"inappropriate"|"network_name"|"non_fiat_currency"|"other"|"other_entity"|"promotional_material")[]? - The reason(s) the carrier text was rejected.
stripe: issuing_personalization_designs_body
Closed record
Fields
- card_logo? string - The file for the card logo, for use with physical bundles that support card logos. Must have a
purposevalue ofissuing_logo.
- carrier_text? carrier_text_param -
- expand? issuing_personalization_designs_bodyExpandItemsString[] - Specifies which fields in the response should be expanded.
- lookup_key? string - A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
- metadata? record { string... } - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
- name? string - Friendly display name.
- physical_bundle string - The physical bundle object belonging to this personalization design.
- preferences? preferences_param -
- transfer_lookup_key? boolean - If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.
stripe: Issuing_physical_bundle_features
Fields
- card_logo "optional"|"required"|"unsupported" - The policy for how to use card logo images in a card design with this physical bundle.
- carrier_text "optional"|"required"|"unsupported" - The policy for how to use carrier letter text in a card design with this physical bundle.
- second_line "optional"|"required"|"unsupported" - The policy for how to use a second line on a card with this physical bundle.
stripe: Issuing_transaction_amount_details
Fields
- atm_fee? int? - The fee charged by the ATM for the cash withdrawal.
- cashback_amount? int? - The amount of cash requested by the cardholder.
stripe: Issuing_transaction_fleet_cardholder_prompt_data
Fields
- driver_id? string? - Driver ID.
- odometer? int? - Odometer reading.
- unspecified_id? string? - An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.
- user_id? string? - User ID.
- vehicle_number? string? - Vehicle number.
stripe: Issuing_transaction_fleet_data
Fields
- cardholder_prompt_data? Issuing_transaction_fleet_cardholder_prompt_data? - Answers to prompts presented to cardholder at point of sale.
- purchase_type? string? - The type of purchase. One of
fuel_purchase,non_fuel_purchase, orfuel_and_non_fuel_purchase.
- reported_breakdown? Issuing_transaction_fleet_reported_breakdown? - More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
- service_type? string? - The type of fuel service. One of
non_fuel_transaction,full_service, orself_service.
stripe: Issuing_transaction_fleet_fuel_price_data
Fields
- gross_amount_decimal? string? - Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
stripe: Issuing_transaction_fleet_non_fuel_price_data
Fields
- gross_amount_decimal? string? - Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
stripe: Issuing_transaction_fleet_reported_breakdown
Fields
- fuel? Issuing_transaction_fleet_fuel_price_data? - Breakdown of fuel portion of the purchase.
- non_fuel? Issuing_transaction_fleet_non_fuel_price_data? - Breakdown of non-fuel portion of the purchase.
- tax? Issuing_transaction_fleet_tax_data? - Information about tax included in this transaction.
stripe: Issuing_transaction_fleet_tax_data
Fields
- local_amount_decimal? string? - Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.
- national_amount_decimal? string? - Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.
stripe: Issuing_transaction_flight_data
Fields
- departure_at? int? - The time that the flight departed.
- passenger_name? string? - The name of the passenger.
- refundable? boolean? - Whether the ticket is refundable.
- segments? Issuing_transaction_flight_data_leg[]? - The legs of the trip.
- travel_agency? string? - The travel agency that issued the ticket.
stripe: Issuing_transaction_flight_data_leg
Fields
- arrival_airport_code? string? - The three-letter IATA airport code of the flight's destination.
- carrier? string? - The airline carrier code.
- departure_airport_code? string? - The three-letter IATA airport code that the flight departed from.
- flight_number? string? - The flight number.
- service_class? string? - The flight's service class.
- stopover_allowed? boolean? - Whether a stopover is allowed on this flight.
stripe: Issuing_transaction_fuel_data
Fields
- industry_product_code? string? - Conexxus Payment System Product Code identifying the primary fuel product purchased.
- quantity_decimal? string? - The quantity of
units of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
- 'type string - The type of fuel that was purchased. One of
diesel,unleaded_plus,unleaded_regular,unleaded_super, orother.
- unit string - The units for
quantity_decimal. One ofcharging_minute,imperial_gallon,kilogram,kilowatt_hour,liter,pound,us_gallon, orother.
- unit_cost_decimal string - The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
stripe: Issuing_transaction_lodging_data
Fields
- check_in_at? int? - The time of checking into the lodging.
- nights? int? - The number of nights stayed at the lodging.
stripe: Issuing_transaction_network_data
Fields
- processing_date? string? - The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network.
- transaction_id? string? - Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.
stripe: Issuing_transaction_purchase_details
Fields
- fleet? Issuing_transaction_fleet_data? - Fleet-specific information for transactions using Fleet cards.
- flight? Issuing_transaction_flight_data? - Information about the flight that was purchased with this transaction.
- fuel? Issuing_transaction_fuel_data? - Information about fuel that was purchased with this transaction.
- lodging? Issuing_transaction_lodging_data? - Information about lodging that was purchased with this transaction.
- receipt? Issuing_transaction_receipt_data[]? - The line items in the purchase.
- reference? string? - A merchant-specific order number.
stripe: Issuing_transaction_receipt_data
Fields
- description? string? - The description of the item. The maximum length of this field is 26 characters.
- quantity? decimal? - The quantity of the item.
- total? int? - The total for this line item in cents.
- unit_cost? int? - The unit cost of the item in cents.
stripe: Issuing_transaction_treasury
Fields
- received_credit? string? - The Treasury ReceivedCredit representing this Issuing transaction if it is a refund
- received_debit? string? - The Treasury ReceivedDebit representing this Issuing transaction if it is a capture
stripe: IssuingAuthorizationList
Fields
- data Issuing\.authorization[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: IssuingCardholderList
Fields
- data Issuing\.cardholder[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: IssuingCardList
Fields
- data Issuing\.card[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: IssuingDisputeList
Fields
- data Issuing\.dispute[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: IssuingNetworkTokenList
Fields
- data Issuing\.token[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: IssuingPersonalizationDesignList
Fields
- data Issuing\.personalization_design[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: IssuingPhysicalBundleList
Fields
- data Issuing\.physical_bundle[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: IssuingTransactionList
Fields
- data Issuing\.transaction[] -
- has_more boolean - True if this list has another page of items after this one that can be fetched.
- 'object "list" - String representing the object's type. Objects of the same type share the same value. Always has the value
list.
- url string - The URL where this list can be accessed.
stripe: Item
A line item.
Fields
- amount_discount int - Total discount amount applied. If no discounts were applied, defaults to 0.
- amount_subtotal int - Total before any discounts or taxes are applied.
- amount_tax int - Total tax amount applied. If no tax was applied, defaults to 0.
- amount_total int - Total after discounts and taxes.
- currency string - Three-letter ISO currency code, in lowercase. Must be a supported currency.
- description string - An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.
- discounts? Line_items_discount_amount[] - The discounts applied to the line item.
- id string - Unique identifier for the object.
- 'object "item" - String representing the object's type. Objects of the same type share the same value.
- price? Price? - The price used to generate the line item.
- quantity? int? - The quantity of products being purchased.
- taxes? Line_items_tax_amount[] - The taxes applied to the line item.
stripe: japan_address_kana_specs
Fields
- city? string -
- country? string -
- line1? string -
- line2? string -
- postal_code? string -
- state? string -
- town? string -
stripe: japan_address_kana_specs_1
The Kana variation of the person's address (Japan only).
Fields
- city? string -
- country? string -
- line1? string -
- line2? string -
- postal_code? string -
- state? string -
- town? string -
stripe: japan_address_kanji_specs
Fields
- city? string -
- country? string -
- line1? string -
- line2? string -
- postal_code? string -
- state? string -
- town? string -
stripe: japan_address_kanji_specs_1
The Kanji variation of the person's address (Japan only).
Fields
- city? string -
- country? string -
- line1? string -
- line2? string -
- postal_code? string -
- state? string -
- town? string -
stripe: legal_entity_and_kyc_address_specs
Fields
- city? string -
- country? string -
- line1? string -
- line2? string -
- postal_code? string -
- state? string -
stripe: legal_entity_and_kyc_address_specs_1
The person's address.
Fields
- city? string -
- country? string -
- line1? string -
- line2? string -
- postal_code? string -
- state? string -
stripe: Legal_entity_company
Fields
- address? Address -
- address_kana? Legal_entity_japan_address? - The Kana variation of the company's primary address (Japan only).
- address_kanji? Legal_entity_japan_address? - The Kanji variation of the company's primary address (Japan only).
- directors_provided? boolean - Whether the company's directors have been provided. This Boolean will be
trueif you've manually indicated that all directors are provided via thedirectors_providedparameter.
- executives_provided? boolean - Whether the company's executives have been provided. This Boolean will be
trueif you've manually indicated that all executives are provided via theexecutives_providedparameter, or if Stripe determined that sufficient executives were provided.
- export_license_id? string - The export license ID number of the company, also referred as Import Export Code (India only).
- export_purpose_code? string - The purpose code to use for export transactions (India only).
- name? string? - The company's legal name.
- name_kana? string? - The Kana variation of the company's legal name (Japan only).
- name_kanji? string? - The Kanji variation of the company's legal name (Japan only).
- owners_provided? boolean - Whether the company's owners have been provided. This Boolean will be
trueif you've manually indicated that all owners are provided via theowners_providedparameter, or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding thepercent_ownershipof each owner together).
- ownership_declaration? Legal_entity_ubo_declaration? - This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.
- phone? string? - The company's phone number (used for verification).
- structure? "free_zone_establishment"|"free_zone_llc"|"government_instrumentality"|"governmental_unit"|"incorporated_non_profit"|"incorporated_partnership"|"limited_liability_partnership"|"llc"|"multi_member_llc"|"private_company"|"private_corporation"|"private_partnership"|"public_company"|"public_corporation"|"public_partnership"|"registered_charity"|"single_member_llc"|"sole_establishment"|"sole_proprietorship"|"tax_exempt_government_instrumentality"|"unincorporated_association"|"unincorporated_non_profit"|"unincorporated_partnership" - The category identifying the legal structure of the company or legal entity. See Business structure for more details.
- tax_id_provided? boolean - Whether the company's business ID number was provided.
- tax_id_registrar? string - The jurisdiction in which the
tax_idis registered (Germany-based companies only).
- vat_id_provided? boolean - Whether the company's business VAT number was provided.
- verification? Legal_entity_company_verification? - Information on the verification state of the company.
stripe: Legal_entity_company_verification
Fields
- document Legal_entity_company_verification_document -
stripe: Legal_entity_company_verification_document
Fields
- back? string|File? - The back of a document returned by a file upload with a
purposevalue ofadditional_verification.
- details? string? - A user-displayable string describing the verification state of this document.
- details_code? string? - One of
document_corrupt,document_expired,document_failed_copy,document_failed_greyscale,document_failed_other,document_failed_test_mode,document_fraudulent,document_incomplete,document_invalid,document_manipulated,document_not_readable,document_not_uploaded,document_type_not_supported, ordocument_too_large. A machine-readable code specifying the verification state for this document.
- front? string|File? - The front of a document returned by a file upload with a
purposevalue ofadditional_verification.
stripe: Legal_entity_dob
Fields
- day? int? - The day of birth, between 1 and 31.
- month? int? - The month of birth, between 1 and 12.
- year? int? - The four-digit year of birth.
stripe: Legal_entity_japan_address
Fields
- city? string? - City/Ward.
- country? string? - Two-letter country code (ISO 3166-1 alpha-2).
- line1? string? - Block/Building number.
- line2? string? - Building details.
- postal_code? string? - ZIP or postal code.
- state? string? - Prefecture.
- town? string? - Town/cho-me.
stripe: Legal_entity_person_verification
Fields
- additional_document? Legal_entity_person_verification_document? - A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
- details? string? - A user-displayable string describing the verification state for the person. For example, this may say "Provided identity information could not be verified".
- details_code? string? - One of
document_address_mismatch,document_dob_mismatch,document_duplicate_type,document_id_number_mismatch,document_name_mismatch,document_nationality_mismatch,failed_keyed_identity, orfailed_other. A machine-readable code specifying the verification state for the person.
- document? Legal_entity_person_verification_document -
- status string - The state of verification for the person. Possible values are
unverified,pending, orverified.
stripe: Legal_entity_person_verification_document
Fields
- back? string|File? - The back of an ID returned by a file upload with a
purposevalue ofidentity_document.
- details? string? - A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read".
- details_code? string? - One of
document_corrupt,document_country_not_supported,document_expired,document_failed_copy,document_failed_other,document_failed_test_mode,document_fraudulent,document_failed_greyscale,document_incomplete,document_invalid,document_manipulated,document_missing_back,document_missing_front,document_not_readable,document_not_uploaded,document_photo_mismatch,document_too_large, ordocument_type_not_supported. A machine-readable code specifying the verification state for this document.
- front? string|File? - The front of an ID returned by a file upload with a
purposevalue ofidentity_document.
stripe: Legal_entity_ubo_declaration
Fields
- date? int? - The Unix timestamp marking when the beneficial owner attestation was made.
- ip? string? - The IP address from which the beneficial owner attestation was made.
- user_agent? string? - The user-agent string from the browser where the beneficial owner attestation was made.
stripe: line_item
Fields
- amount int -
- description string -
- quantity int -
stripe: Line_item
Fields
- amount int - The amount, in cents (or local equivalent).
- amount_excluding_tax? int? - The integer amount in cents (or local equivalent) representing the amount for this line item, excluding all tax and discounts.
- currency string - Three-letter ISO currency code, in lowercase. Must be a supported currency.
- description? string? - An arbitrary string attached to the object. Often useful for displaying to users.
- discount_amounts? Discounts_resource_discount_amount[]? - The amount of discount calculated per discount for this line item.
- discountable boolean - If true, discounts will apply to this line item. Always false for prorations.
- id string - Unique identifier for the object.
- invoice? string? - The ID of the invoice that contains this line item.
- invoice_item? string|Invoiceitem - The ID of the invoice item associated with this line item if any.
- livemode boolean - Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode.
- metadata record { string... } - Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Note that for line items with
type=subscription,metadatareflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.
- 'object "line_item" - String representing the object's type. Objects of the same type share the same value.
- period Invoice_line_item_period -
- price? Price? - The price of the line item.
- proration boolean - Whether this is a proration.
- proration_details? Invoices_resource_line_items_proration_details? - Additional details for proration line items
- quantity? int? - The quantity of the subscription, if the line item is a subscription or a proration.
- subscription? string|Subscription? - The subscription that the invoice item pertains to, if any.
- subscription_item? string|Subscription_item - The subscription item that generated this line item. Left empty if the line item is not an explicit result of a subscription.
- tax_amounts? Invoice_tax_amount[] - The amount of tax calculated per tax rate for this line item
- tax_rates? Tax_rate[] - The tax rates which apply to the line item.
- 'type "invoiceitem"|"subscription" - A string identifying the type of the source of this line item, either an
invoiceitemor asubscription.
- unit_amount_excluding_tax? string? - The amount in cents (or local equivalent) representing the unit amount for this line item, excluding all tax and discounts.
stripe: line_item_create_params
Fields
- price? string -
- price_data? price_data -
- quantity? int -
- tax_rates? TaxratesItemsString[]|"" -
stripe: line_item_params
Fields
- adjustable_quantity? adjustable_quantity_params -
- dynamic_tax_rates? line_item_paramsDynamictaxratesItemsString[] -
- price? string -
- price_data? price_data_with_product_data -
- quantity? int -
- tax_rates? line_item_paramsTaxratesItemsString[] -
stripe: line_item_update_params
Fields
- id? string -
- price? string -
- price_data? price_data -
- quantity? int -
- tax_rates? TaxratesItemsString[]|"" -
stripe: line_items_create_params
Fields
- adjustable_quantity? adjustable_quantity_params -
- price string -
- quantity int -
stripe: Line_items_discount_amount
Fields
- amount int - The amount discounted.
- discount Discount -
stripe: Line_items_tax_amount
Fields
- amount int - Amount of tax applied for this rate.
- rate Tax_rate -
- taxability_reason? "customer_exempt"|"not_collecting"|"not_subject_to_tax"|"not_supported"|"portion_product_exempt"|"portion_reduced_rated"|"portion_standard_rated"|"product_exempt"|"product_exempt_holiday"|"proportionally_rated"|"reduced_rated"|"reverse_charge"|"standard_rated"|"taxable_basis_reduced"|"zero_rated"? - The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
- taxable_amount? int? - The amount on which tax is calculated, in cents (or local equivalent).
stripe: line_items_update_params
Fields
- adjustable_quantity? adjustable_quantity_params -
- id string -
- quantity? int -
stripe: lines_data_param
Fields
- amount? int -
- description? string -
- discountable? boolean -
- invoice_item? string -
- metadata? record { string... }|"" -
- period? period_1 -
- price? string -
- price_data? one_time_price_data_with_product_data -
- quantity? int -