Skip to content

Instantly share code, notes, and snippets.

@zcourts

zcourts/stripe.openapi.yaml

Created June 14, 2021 15:24
Show Gist options
  • Save zcourts/548ba0f00c6351a2e4a81981fcb7f938 to your computer and use it in GitHub Desktop.
Save zcourts/548ba0f00c6351a2e4a81981fcb7f938 to your computer and use it in GitHub Desktop.
Download ZIP
Some OpenAPI specs for testing with
Raw
stripe.openapi.yaml
This file has been truncated, but you can view the full file.
---
components:
schemas:
account:
description: |-
This is an object representing a Stripe account. You can retrieve it to see
properties on the account like its current e-mail address or if the account is
enabled yet to make live charges.
Some properties, marked below, are available only to platforms that want to
[create and manage Express or Custom accounts](https://stripe.com/docs/connect/accounts).
properties:
business_profile:
anyOf:
- "$ref": "#/components/schemas/account_business_profile"
description: Business information about the account.
nullable: true
business_type:
description: The business type.
enum:
- company
- government_entity
- individual
- non_profit
nullable: true
type: string
x-stripeBypassValidation: true
capabilities:
"$ref": "#/components/schemas/account_capabilities"
charges_enabled:
description: Whether the account can create live charges.
type: boolean
company:
"$ref": "#/components/schemas/legal_entity_company"
country:
description: The account's country.
maxLength: 5000
type: string
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
default_currency:
description: 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](https://stripe.com/docs/payouts).
maxLength: 5000
type: string
details_submitted:
description: Whether account details have been submitted. Standard accounts
cannot receive payouts before this is true.
type: boolean
email:
description: The primary user's email address.
maxLength: 5000
nullable: true
type: string
external_accounts:
description: External accounts (bank accounts and debit cards) currently
attached to this account
properties:
data:
description: The list contains all external accounts that have been
attached to the Stripe account. These may be bank accounts or cards.
items:
anyOf:
- "$ref": "#/components/schemas/bank_account"
- "$ref": "#/components/schemas/card"
title: Polymorphic
type: array
has_more:
description: True if this list has another page of items after this
one that can be fetched.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value. Always has the value `list`.
enum:
- list
type: string
url:
description: The URL where this list can be accessed.
maxLength: 5000
type: string
required:
- data
- has_more
- object
- url
title: ExternalAccountList
type: object
x-expandableFields:
- data
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
individual:
"$ref": "#/components/schemas/person"
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- account
type: string
payouts_enabled:
description: Whether Stripe can send payouts to this account.
type: boolean
requirements:
"$ref": "#/components/schemas/account_requirements"
settings:
anyOf:
- "$ref": "#/components/schemas/account_settings"
description: Options for customizing how the account functions within Stripe.
nullable: true
tos_acceptance:
"$ref": "#/components/schemas/account_tos_acceptance"
type:
description: The Stripe account type. Can be `standard`, `express`, or `custom`.
enum:
- custom
- express
- standard
type: string
required:
- id
- object
title: Account
type: object
x-expandableFields:
- business_profile
- capabilities
- company
- external_accounts
- individual
- requirements
- settings
- tos_acceptance
x-resourceId: account
account_bacs_debit_payments_settings:
description: ''
properties:
display_name:
description: The Bacs Direct Debit Display Name for this account. For payments
made with Bacs Direct Debit, this will appear on the mandate, and as the
statement descriptor.
maxLength: 5000
type: string
title: AccountBacsDebitPaymentsSettings
type: object
x-expandableFields: []
account_branding_settings:
description: ''
properties:
icon:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/file"
description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload))
An icon for the account. Must be square and at least 128px x 128px."
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/file"
logo:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/file"
description: "(ID of a [file upload](https://stripe.com/docs/guides/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."
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/file"
primary_color:
description: A CSS hex color value representing the primary branding color
for this account
maxLength: 5000
nullable: true
type: string
secondary_color:
description: A CSS hex color value representing the secondary branding color
for this account
maxLength: 5000
nullable: true
type: string
title: AccountBrandingSettings
type: object
x-expandableFields:
- icon
- logo
account_business_profile:
description: ''
properties:
mcc:
description: "[The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc).
MCCs are used to classify businesses based on the goods or services they
provide."
maxLength: 5000
nullable: true
type: string
name:
description: The customer-facing business name.
maxLength: 5000
nullable: true
type: string
product_description:
description: Internal-only description of the product sold or service provided
by the business. It's used by Stripe for risk and underwriting purposes.
maxLength: 40000
nullable: true
type: string
support_address:
anyOf:
- "$ref": "#/components/schemas/address"
description: A publicly available mailing address for sending support issues
to.
nullable: true
support_email:
description: A publicly available email address for sending support issues
to.
maxLength: 5000
nullable: true
type: string
support_phone:
description: A publicly available phone number to call with support issues.
maxLength: 5000
nullable: true
type: string
support_url:
description: A publicly available website for handling support issues.
maxLength: 5000
nullable: true
type: string
url:
description: The business's publicly available website.
maxLength: 5000
nullable: true
type: string
title: AccountBusinessProfile
type: object
x-expandableFields:
- support_address
account_capabilities:
description: ''
properties:
au_becs_debit_payments:
description: 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.
enum:
- active
- inactive
- pending
type: string
bacs_debit_payments:
description: The status of the Bacs Direct Debits payments capability of
the account, or whether the account can directly process Bacs Direct Debits
charges.
enum:
- active
- inactive
- pending
type: string
card_issuing:
description: The status of the card issuing capability of the account, or
whether you can use Issuing to distribute funds on cards
enum:
- active
- inactive
- pending
type: string
card_payments:
description: The status of the card payments capability of the account,
or whether the account can directly process credit and debit card charges.
enum:
- active
- inactive
- pending
type: string
jcb_payments:
description: 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.
enum:
- active
- inactive
- pending
type: string
legacy_payments:
description: The status of the legacy payments capability of the account.
enum:
- active
- inactive
- pending
type: string
tax_reporting_us_1099_k:
description: The status of the tax reporting 1099-K (US) capability of the
account.
enum:
- active
- inactive
- pending
type: string
tax_reporting_us_1099_misc:
description: The status of the tax reporting 1099-MISC (US) capability of
the account.
enum:
- active
- inactive
- pending
type: string
transfers:
description: The status of the transfers capability of the account, or whether
your platform can transfer funds to the account.
enum:
- active
- inactive
- pending
type: string
title: AccountCapabilities
type: object
x-expandableFields: []
account_capability_requirements:
description: ''
properties:
current_deadline:
description: The date the fields in `currently_due` must be collected by
to keep the capability enabled for the account.
format: unix-time
nullable: true
type: integer
currently_due:
description: The fields that need to be collected to keep the capability
enabled. If not collected by the `current_deadline`, these fields appear
in `past_due` as well, and the capability is disabled.
items:
maxLength: 5000
type: string
type: array
disabled_reason:
description: If the capability is disabled, this string describes why. Possible
values are `requirement.fields_needed`, `pending.onboarding`, `pending.review`,
`rejected_fraud`, or `rejected.other`.
maxLength: 5000
nullable: true
type: string
errors:
description: The fields that need to be collected again because validation
or verification failed for some reason.
items:
"$ref": "#/components/schemas/account_requirements_error"
type: array
eventually_due:
description: The fields that need to be collected assuming all volume thresholds
are reached. As they become required, these fields appear in `currently_due`
as well, and the `current_deadline` is set.
items:
maxLength: 5000
type: string
type: array
past_due:
description: The fields that weren't collected by the `current_deadline`.
These fields need to be collected to enable the capability for the account.
items:
maxLength: 5000
type: string
type: array
pending_verification:
description: Fields that may become required depending on the results of
verification or review. An empty array unless an asynchronous verification
is pending. If verification fails, the fields in this array become required
and move to `currently_due` or `past_due`.
items:
maxLength: 5000
type: string
type: array
required:
- currently_due
- errors
- eventually_due
- past_due
- pending_verification
title: AccountCapabilityRequirements
type: object
x-expandableFields:
- errors
account_card_payments_settings:
description: ''
properties:
decline_on:
"$ref": "#/components/schemas/account_decline_charge_on"
statement_descriptor_prefix:
description: The default text that appears on credit card statements when
a charge is made. This field prefixes any dynamic `statement_descriptor`
specified on the charge. `statement_descriptor_prefix` is useful for maximizing
descriptor space for the dynamic portion.
maxLength: 5000
nullable: true
type: string
title: AccountCardPaymentsSettings
type: object
x-expandableFields:
- decline_on
account_dashboard_settings:
description: ''
properties:
display_name:
description: The display name for this account. This is used on the Stripe
Dashboard to differentiate between accounts.
maxLength: 5000
nullable: true
type: string
timezone:
description: 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](http://www.iana.org/time-zones).
maxLength: 5000
nullable: true
type: string
title: AccountDashboardSettings
type: object
x-expandableFields: []
account_decline_charge_on:
description: ''
properties:
avs_failure:
description: 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.
type: boolean
cvc_failure:
description: Whether Stripe automatically declines charges with an incorrect
CVC. This setting only applies when a CVC is provided and it fails bank
verification.
type: boolean
required:
- avs_failure
- cvc_failure
title: AccountDeclineChargeOn
type: object
x-expandableFields: []
account_link:
description: |-
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](https://stripe.com/docs/connect/connect-onboarding).
properties:
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
expires_at:
description: The timestamp at which this account link will expire.
format: unix-time
type: integer
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- account_link
type: string
url:
description: The URL for the account link.
maxLength: 5000
type: string
required:
- created
- expires_at
- object
- url
title: AccountLink
type: object
x-expandableFields: []
x-resourceId: account_link
account_payments_settings:
description: ''
properties:
statement_descriptor:
description: The default text that appears on credit card statements when
a charge is made. This field prefixes any dynamic `statement_descriptor`
specified on the charge.
maxLength: 5000
nullable: true
type: string
statement_descriptor_kana:
description: The Kana variation of the default text that appears on credit
card statements when a charge is made (Japan only)
maxLength: 5000
nullable: true
type: string
statement_descriptor_kanji:
description: The Kanji variation of the default text that appears on credit
card statements when a charge is made (Japan only)
maxLength: 5000
nullable: true
type: string
title: AccountPaymentsSettings
type: object
x-expandableFields: []
account_payout_settings:
description: ''
properties:
debit_negative_balances:
description: A Boolean indicating if Stripe should try to reclaim negative
balances from an attached bank account. See our [Understanding Connect
Account Balances](https://stripe.com/docs/connect/account-balances) documentation
for details. Default value is `true` for Express accounts and `false`
for Custom accounts.
type: boolean
schedule:
"$ref": "#/components/schemas/transfer_schedule"
statement_descriptor:
description: 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.
maxLength: 5000
nullable: true
type: string
required:
- debit_negative_balances
- schedule
title: AccountPayoutSettings
type: object
x-expandableFields:
- schedule
account_requirements:
description: ''
properties:
current_deadline:
description: The date the fields in `currently_due` must be collected by
to keep payouts enabled for the account. These fields might block payouts
sooner if the next threshold is reached before these fields are collected.
format: unix-time
nullable: true
type: integer
currently_due:
description: The fields that need to be collected to keep the account enabled.
If not collected by the `current_deadline`, these fields appear in `past_due`
as well, and the account is disabled.
items:
maxLength: 5000
type: string
nullable: true
type: array
disabled_reason:
description: If the account is disabled, this string describes why the account
can’t create charges or receive payouts. Can be `requirements.past_due`,
`requirements.pending_verification`, `rejected.fraud`, `rejected.terms_of_service`,
`rejected.listed`, `rejected.other`, `listed`, `under_review`, or `other`.
maxLength: 5000
nullable: true
type: string
errors:
description: The fields that need to be collected again because validation
or verification failed for some reason.
items:
"$ref": "#/components/schemas/account_requirements_error"
nullable: true
type: array
eventually_due:
description: The fields that need to be collected assuming all volume thresholds
are reached. As they become required, these fields appear in `currently_due`
as well, and the `current_deadline` is set.
items:
maxLength: 5000
type: string
nullable: true
type: array
past_due:
description: The fields that weren't collected by the `current_deadline`.
These fields need to be collected to re-enable the account.
items:
maxLength: 5000
type: string
nullable: true
type: array
pending_verification:
description: Fields that may become required depending on the results of
verification or review. An empty array unless an asynchronous verification
is pending. If verification fails, the fields in this array become required
and move to `currently_due` or `past_due`.
items:
maxLength: 5000
type: string
nullable: true
type: array
title: AccountRequirements
type: object
x-expandableFields:
- errors
account_requirements_error:
description: ''
properties:
code:
description: The code for the type of error.
enum:
- invalid_address_city_state_postal_code
- invalid_street_address
- invalid_value_other
- verification_document_address_mismatch
- verification_document_address_missing
- verification_document_corrupt
- verification_document_country_not_supported
- 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_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_uploaded
- verification_document_photo_mismatch
- verification_document_too_large
- verification_document_type_not_supported
- 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
type: string
x-stripeBypassValidation: true
reason:
description: An informative message that indicates the error type and provides
additional details about the error.
maxLength: 5000
type: string
requirement:
description: The specific user onboarding requirement field (in the requirements
hash) that needs to be resolved.
maxLength: 5000
type: string
required:
- code
- reason
- requirement
title: AccountRequirementsError
type: object
x-expandableFields: []
account_sepa_debit_payments_settings:
description: ''
properties:
creditor_id:
description: SEPA creditor identifier that identifies the company making
the payment.
maxLength: 5000
type: string
title: AccountSepaDebitPaymentsSettings
type: object
x-expandableFields: []
account_settings:
description: ''
properties:
bacs_debit_payments:
"$ref": "#/components/schemas/account_bacs_debit_payments_settings"
branding:
"$ref": "#/components/schemas/account_branding_settings"
card_payments:
"$ref": "#/components/schemas/account_card_payments_settings"
dashboard:
"$ref": "#/components/schemas/account_dashboard_settings"
payments:
"$ref": "#/components/schemas/account_payments_settings"
payouts:
"$ref": "#/components/schemas/account_payout_settings"
sepa_debit_payments:
"$ref": "#/components/schemas/account_sepa_debit_payments_settings"
required:
- branding
- card_payments
- dashboard
- payments
title: AccountSettings
type: object
x-expandableFields:
- bacs_debit_payments
- branding
- card_payments
- dashboard
- payments
- payouts
- sepa_debit_payments
account_tos_acceptance:
description: ''
properties:
date:
description: The Unix timestamp marking when the Stripe Services Agreement
was accepted by the account representative
format: unix-time
nullable: true
type: integer
ip:
description: The IP address from which the Stripe Services Agreement was
accepted by the account representative
maxLength: 5000
nullable: true
type: string
user_agent:
description: The user agent of the browser from which the Stripe Services
Agreement was accepted by the account representative
maxLength: 5000
nullable: true
type: string
title: AccountTOSAcceptance
type: object
x-expandableFields: []
address:
description: ''
properties:
city:
description: City, district, suburb, town, or village.
maxLength: 5000
nullable: true
type: string
country:
description: Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
maxLength: 5000
nullable: true
type: string
line1:
description: Address line 1 (e.g., street, PO Box, or company name).
maxLength: 5000
nullable: true
type: string
line2:
description: Address line 2 (e.g., apartment, suite, unit, or building).
maxLength: 5000
nullable: true
type: string
postal_code:
description: ZIP or postal code.
maxLength: 5000
nullable: true
type: string
state:
description: State, county, province, or region.
maxLength: 5000
nullable: true
type: string
title: Address
type: object
x-expandableFields: []
alipay_account:
description: ''
properties:
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
customer:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/customer"
- "$ref": "#/components/schemas/deleted_customer"
description: The ID of the customer associated with this Alipay Account.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/customer"
- "$ref": "#/components/schemas/deleted_customer"
fingerprint:
description: Uniquely identifies the account and will be the same across
all Alipay account objects that are linked to the same Alipay account.
maxLength: 5000
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- alipay_account
type: string
payment_amount:
description: If the Alipay account object is not reusable, the exact amount
that you can create a charge for.
nullable: true
type: integer
payment_currency:
description: If the Alipay account object is not reusable, the exact currency
that you can create a charge for.
nullable: true
type: string
reusable:
description: True if you can create multiple payments using this account.
If the account is reusable, then you can freely choose the amount of each
payment.
type: boolean
used:
description: Whether this Alipay account object has ever been used for a
payment.
type: boolean
username:
description: The username for the Alipay account.
maxLength: 5000
type: string
required:
- created
- fingerprint
- id
- livemode
- object
- reusable
- used
- username
title: AlipayAccount
type: object
x-expandableFields:
- customer
x-resourceId: alipay_account
api_errors:
description: ''
properties:
charge:
description: For card errors, the ID of the failed charge.
maxLength: 5000
type: string
code:
description: For some errors that could be handled programmatically, a short
string indicating the [error code](https://stripe.com/docs/error-codes)
reported.
maxLength: 5000
type: string
decline_code:
description: For card errors resulting from a card issuer decline, a short
string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines)
if they provide one.
maxLength: 5000
type: string
doc_url:
description: A URL to more information about the [error code](https://stripe.com/docs/error-codes)
reported.
maxLength: 5000
type: string
message:
description: A human-readable message providing more details about the error.
For card errors, these messages can be shown to your users.
maxLength: 40000
type: string
param:
description: 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.
maxLength: 5000
type: string
payment_intent:
"$ref": "#/components/schemas/payment_intent"
payment_method:
"$ref": "#/components/schemas/payment_method"
setup_intent:
"$ref": "#/components/schemas/setup_intent"
source:
anyOf:
- "$ref": "#/components/schemas/bank_account"
- "$ref": "#/components/schemas/card"
- "$ref": "#/components/schemas/source"
description: The source object for errors returned on a request involving
a source.
type:
description: The type of error returned. One of `api_connection_error`,
`api_error`, `authentication_error`, `card_error`, `idempotency_error`,
`invalid_request_error`, or `rate_limit_error`
enum:
- api_connection_error
- api_error
- authentication_error
- card_error
- idempotency_error
- invalid_request_error
- rate_limit_error
type: string
required:
- type
title: APIErrors
type: object
x-expandableFields:
- payment_intent
- payment_method
- setup_intent
- source
apple_pay_domain:
description: ''
properties:
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
domain_name:
maxLength: 5000
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- apple_pay_domain
type: string
required:
- created
- domain_name
- id
- livemode
- object
title: ApplePayDomain
type: object
x-expandableFields: []
x-resourceId: apple_pay_domain
application:
description: ''
properties:
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
name:
description: The name of the application.
maxLength: 5000
nullable: true
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- application
type: string
required:
- id
- object
title: Application
type: object
x-expandableFields: []
application_fee:
description: ''
properties:
account:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/account"
description: ID of the Stripe account this fee was taken from.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/account"
amount:
description: Amount earned, in %s.
type: integer
amount_refunded:
description: Amount in %s refunded (can be less than the amount attribute
on the fee if a partial refund was issued)
type: integer
application:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/application"
description: ID of the Connect application that earned the fee.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/application"
balance_transaction:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/balance_transaction"
description: Balance transaction that describes the impact of this collected
application fee on your account balance (not including refunds).
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/balance_transaction"
charge:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/charge"
description: ID of the charge that the application fee was taken from.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/charge"
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- application_fee
type: string
originating_transaction:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/charge"
description: ID of the corresponding charge on the platform account, if
this fee was the result of a charge using the `destination` parameter.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/charge"
refunded:
description: Whether the fee has been fully refunded. If the fee is only
partially refunded, this attribute will still be false.
type: boolean
refunds:
description: A list of refunds that have been applied to the fee.
properties:
data:
description: Details about each object.
items:
"$ref": "#/components/schemas/fee_refund"
type: array
has_more:
description: True if this list has another page of items after this
one that can be fetched.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value. Always has the value `list`.
enum:
- list
type: string
url:
description: The URL where this list can be accessed.
maxLength: 5000
type: string
required:
- data
- has_more
- object
- url
title: FeeRefundList
type: object
x-expandableFields:
- data
required:
- account
- amount
- amount_refunded
- application
- charge
- created
- currency
- id
- livemode
- object
- refunded
- refunds
title: PlatformFee
type: object
x-expandableFields:
- account
- application
- balance_transaction
- charge
- originating_transaction
- refunds
x-resourceId: application_fee
balance:
description: |-
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](https://stripe.com/docs/reporting/balance-transaction-types) 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](https://stripe.com/docs/connect/account-balances).
properties:
available:
description: Funds that are available to be transferred or paid out, whether
automatically by Stripe or explicitly via the [Transfers API](https://stripe.com/docs/api#transfers)
or [Payouts API](https://stripe.com/docs/api#payouts). The available balance
for each currency and payment type can be found in the `source_types`
property.
items:
"$ref": "#/components/schemas/balance_amount"
type: array
connect_reserved:
description: Funds held due to negative balances on connected Custom accounts.
The connect reserve balance for each currency and payment type can be
found in the `source_types` property.
items:
"$ref": "#/components/schemas/balance_amount"
type: array
issuing:
"$ref": "#/components/schemas/balance_detail"
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- balance
type: string
pending:
description: Funds that are not yet available in the balance, due to the
7-day rolling pay cycle. The pending balance for each currency, and for
each payment type, can be found in the `source_types` property.
items:
"$ref": "#/components/schemas/balance_amount"
type: array
required:
- available
- livemode
- object
- pending
title: Balance
type: object
x-expandableFields:
- available
- connect_reserved
- issuing
- pending
x-resourceId: balance
balance_amount:
description: ''
properties:
amount:
description: Balance amount.
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
source_types:
"$ref": "#/components/schemas/balance_amount_by_source_type"
required:
- amount
- currency
title: BalanceAmount
type: object
x-expandableFields:
- source_types
balance_amount_by_source_type:
description: ''
properties:
bank_account:
description: Amount for bank account.
type: integer
card:
description: Amount for card.
type: integer
fpx:
description: Amount for FPX.
type: integer
title: BalanceAmountBySourceType
type: object
x-expandableFields: []
balance_detail:
description: ''
properties:
available:
description: Funds that are available for use.
items:
"$ref": "#/components/schemas/balance_amount"
type: array
required:
- available
title: BalanceDetail
type: object
x-expandableFields:
- available
balance_transaction:
description: |-
Balance transactions represent funds moving through your Stripe account.
They're created for every type of transaction that comes into or flows out of your Stripe account balance.
Related guide: [Balance Transaction Types](https://stripe.com/docs/reports/balance-transaction-types).
properties:
amount:
description: Gross amount of the transaction, in %s.
type: integer
available_on:
description: The date the transaction's net funds will become available
in the Stripe balance.
format: unix-time
type: integer
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
description:
description: An arbitrary string attached to the object. Often useful for
displaying to users.
maxLength: 5000
nullable: true
type: string
exchange_rate:
description: The exchange rate used, if applicable, for this transaction.
Specifically, if money was converted from currency A to currency B, then
the `amount` in currency A, times `exchange_rate`, would be the `amount`
in currency B. For example, suppose you charged a customer 10.00 EUR.
Then the PaymentIntent's `amount` would be `1000` and `currency` would
be `eur`. Suppose this was converted into 12.34 USD in your Stripe account.
Then the BalanceTransaction's `amount` would be `1234`, `currency` would
be `usd`, and `exchange_rate` would be `1.234`.
nullable: true
type: number
fee:
description: Fees (in %s) paid for this transaction.
type: integer
fee_details:
description: Detailed breakdown of fees (in %s) paid for this transaction.
items:
"$ref": "#/components/schemas/fee"
type: array
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
net:
description: Net amount of the transaction, in %s.
type: integer
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- balance_transaction
type: string
reporting_category:
description: "[Learn more](https://stripe.com/docs/reports/reporting-categories)
about how reporting categories can help you understand balance transactions
from an accounting perspective."
maxLength: 5000
type: string
source:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/application_fee"
- "$ref": "#/components/schemas/charge"
- "$ref": "#/components/schemas/connect_collection_transfer"
- "$ref": "#/components/schemas/dispute"
- "$ref": "#/components/schemas/fee_refund"
- "$ref": "#/components/schemas/issuing.authorization"
- "$ref": "#/components/schemas/issuing.transaction"
- "$ref": "#/components/schemas/payout"
- "$ref": "#/components/schemas/platform_tax_fee"
- "$ref": "#/components/schemas/refund"
- "$ref": "#/components/schemas/reserve_transaction"
- "$ref": "#/components/schemas/tax_deducted_at_source"
- "$ref": "#/components/schemas/topup"
- "$ref": "#/components/schemas/transfer"
- "$ref": "#/components/schemas/transfer_reversal"
description: The Stripe object to which this transaction is related.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/application_fee"
- "$ref": "#/components/schemas/charge"
- "$ref": "#/components/schemas/connect_collection_transfer"
- "$ref": "#/components/schemas/dispute"
- "$ref": "#/components/schemas/fee_refund"
- "$ref": "#/components/schemas/issuing.authorization"
- "$ref": "#/components/schemas/issuing.transaction"
- "$ref": "#/components/schemas/payout"
- "$ref": "#/components/schemas/platform_tax_fee"
- "$ref": "#/components/schemas/refund"
- "$ref": "#/components/schemas/reserve_transaction"
- "$ref": "#/components/schemas/tax_deducted_at_source"
- "$ref": "#/components/schemas/topup"
- "$ref": "#/components/schemas/transfer"
- "$ref": "#/components/schemas/transfer_reversal"
status:
description: If the transaction's net funds are available in the Stripe
balance yet. Either `available` or `pending`.
maxLength: 5000
type: string
type:
description: 'Transaction type: `adjustment`, `advance`, `advance_funding`,
`anticipation_repayment`, `application_fee`, `application_fee_refund`,
`charge`, `connect_collection_transfer`, `issuing_authorization_hold`,
`issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`,
`payment`, `payment_failure_refund`, `payment_refund`, `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`, or `transfer_refund`. [Learn more](https://stripe.com/docs/reports/balance-transaction-types)
about balance transaction types and what they represent. If you are looking
to classify transactions for accounting purposes, you might want to consider
`reporting_category` instead.'
enum:
- adjustment
- advance
- advance_funding
- anticipation_repayment
- application_fee
- application_fee_refund
- charge
- connect_collection_transfer
- issuing_authorization_hold
- issuing_authorization_release
- issuing_dispute
- issuing_transaction
- payment
- payment_failure_refund
- payment_refund
- 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
type: string
required:
- amount
- available_on
- created
- currency
- fee
- fee_details
- id
- net
- object
- reporting_category
- status
- type
title: BalanceTransaction
type: object
x-expandableFields:
- fee_details
- source
x-resourceId: balance_transaction
bank_account:
description: |-
These bank accounts are payment methods on `Customer` objects.
On the other hand [External Accounts](https://stripe.com/docs/api#external_accounts) are transfer
destinations on `Account` objects for [Custom accounts](https://stripe.com/docs/connect/custom-accounts).
They can be bank accounts or debit cards as well, and are documented in the links above.
Related guide: [Processing ACH & Bank Transfers](https://stripe.com/docs/payments/ach-bank-transfers).
properties:
account:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/account"
description: The ID of the account that the bank account is associated with.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/account"
account_holder_name:
description: The name of the person or business that owns the bank account.
maxLength: 5000
nullable: true
type: string
account_holder_type:
description: The type of entity that holds the account. This can be either
`individual` or `company`.
maxLength: 5000
nullable: true
type: string
bank_name:
description: Name of the bank associated with the routing number (e.g.,
`WELLS FARGO`).
maxLength: 5000
nullable: true
type: string
country:
description: Two-letter ISO code representing the country the bank account
is located in.
maxLength: 5000
type: string
currency:
description: Three-letter [ISO code for the currency](https://stripe.com/docs/payouts)
paid out to the bank account.
type: string
customer:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/customer"
- "$ref": "#/components/schemas/deleted_customer"
description: The ID of the customer that the bank account is associated
with.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/customer"
- "$ref": "#/components/schemas/deleted_customer"
default_for_currency:
description: Whether this bank account is the default external account for
its currency.
nullable: true
type: boolean
fingerprint:
description: Uniquely identifies this particular bank account. You can use
this attribute to check whether two bank accounts are the same.
maxLength: 5000
nullable: true
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
last4:
description: The last four digits of the bank account number.
maxLength: 5000
type: string
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
nullable: true
type: object
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- bank_account
type: string
routing_number:
description: The routing transit number for the bank account.
maxLength: 5000
nullable: true
type: string
status:
description: |-
For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. 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 be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated.
For external accounts, possible values are `new` and `errored`. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated.
maxLength: 5000
type: string
required:
- country
- currency
- id
- last4
- object
- status
title: BankAccount
type: object
x-expandableFields:
- account
- customer
x-resourceId: bank_account
billing_details:
description: ''
properties:
address:
anyOf:
- "$ref": "#/components/schemas/address"
description: Billing address.
nullable: true
email:
description: Email address.
maxLength: 5000
nullable: true
type: string
name:
description: Full name.
maxLength: 5000
nullable: true
type: string
phone:
description: Billing phone number (including extension).
maxLength: 5000
nullable: true
type: string
title: billing_details
type: object
x-expandableFields:
- address
billing_portal.session:
description: |-
A session describes the instantiation of the customer portal for
a particular customer. By visiting the session's URL, the customer
can manage their subscriptions and billing details. For security reasons,
sessions are short-lived and will expire if the customer does not visit the URL.
Create sessions on-demand when customers intend to manage their subscriptions and billing details.
Integration guide: [Billing customer portal](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal).
properties:
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
customer:
description: The ID of the customer for this session.
maxLength: 5000
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- billing_portal.session
type: string
return_url:
description: The URL to which Stripe should send customers when they click
on the link to return to your website.
maxLength: 5000
type: string
url:
description: The short-lived URL of the session giving customers access
to the customer portal.
maxLength: 5000
type: string
required:
- created
- customer
- id
- livemode
- object
- return_url
- url
title: PortalSession
type: object
x-expandableFields: []
x-resourceId: billing_portal.session
bitcoin_receiver:
description: ''
properties:
active:
description: True when this bitcoin receiver has received a non-zero amount
of bitcoin.
type: boolean
amount:
description: The amount of `currency` that you are collecting as payment.
type: integer
amount_received:
description: The amount of `currency` to which `bitcoin_amount_received`
has been converted.
type: integer
bitcoin_amount:
description: 'The amount of bitcoin that the customer should send to fill
the receiver. The `bitcoin_amount` is denominated in Satoshi: there are
10^8 Satoshi in one bitcoin.'
type: integer
bitcoin_amount_received:
description: The amount of bitcoin that has been sent by the customer to
this receiver.
type: integer
bitcoin_uri:
description: This URI can be displayed to the customer as a clickable link
(to activate their bitcoin client) or as a QR code (for mobile wallets).
maxLength: 5000
type: string
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
currency:
description: Three-letter [ISO code for the currency](https://stripe.com/docs/currencies)
to which the bitcoin will be converted.
type: string
customer:
description: The customer ID of the bitcoin receiver.
maxLength: 5000
nullable: true
type: string
description:
description: An arbitrary string attached to the object. Often useful for
displaying to users.
maxLength: 5000
nullable: true
type: string
email:
description: The customer's email address, set by the API call that creates
the receiver.
maxLength: 5000
nullable: true
type: string
filled:
description: This flag is initially false and updates to true when the customer
sends the `bitcoin_amount` to this receiver.
type: boolean
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
inbound_address:
description: A bitcoin address that is specific to this receiver. The customer
can send bitcoin to this address to fill the receiver.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- bitcoin_receiver
type: string
payment:
description: The ID of the payment created from the receiver, if any. Hidden
when viewing the receiver with a publishable key.
maxLength: 5000
nullable: true
type: string
refund_address:
description: The refund address of this bitcoin receiver.
maxLength: 5000
nullable: true
type: string
transactions:
description: A list with one entry for each time that the customer sent
bitcoin to the receiver. Hidden when viewing the receiver with a publishable
key.
properties:
data:
description: Details about each object.
items:
"$ref": "#/components/schemas/bitcoin_transaction"
type: array
has_more:
description: True if this list has another page of items after this
one that can be fetched.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value. Always has the value `list`.
enum:
- list
type: string
url:
description: The URL where this list can be accessed.
maxLength: 5000
type: string
required:
- data
- has_more
- object
- url
title: BitcoinTransactionList
type: object
x-expandableFields:
- data
uncaptured_funds:
description: This receiver contains uncaptured funds that can be used for
a payment or refunded.
type: boolean
used_for_payment:
description: Indicate if this source is used for payment.
nullable: true
type: boolean
required:
- active
- amount
- amount_received
- bitcoin_amount
- bitcoin_amount_received
- bitcoin_uri
- created
- currency
- filled
- id
- inbound_address
- livemode
- metadata
- object
- uncaptured_funds
title: BitcoinReceiver
type: object
x-expandableFields:
- transactions
x-resourceId: bitcoin_receiver
bitcoin_transaction:
description: ''
properties:
amount:
description: The amount of `currency` that the transaction was converted
to in real-time.
type: integer
bitcoin_amount:
description: The amount of bitcoin contained in the transaction.
type: integer
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
currency:
description: Three-letter [ISO code for the currency](https://stripe.com/docs/currencies)
to which this transaction was converted.
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- bitcoin_transaction
type: string
receiver:
description: The receiver to which this transaction was sent.
maxLength: 5000
type: string
required:
- amount
- bitcoin_amount
- created
- currency
- id
- object
- receiver
title: BitcoinTransaction
type: object
x-expandableFields: []
x-resourceId: bitcoin_transaction
capability:
description: |-
This is an object representing a capability for a Stripe account.
Related guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities).
properties:
account:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/account"
description: The account for which the capability enables functionality.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/account"
id:
description: The identifier for the capability.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- capability
type: string
requested:
description: Whether the capability has been requested.
type: boolean
requested_at:
description: Time at which the capability was requested. Measured in seconds
since the Unix epoch.
format: unix-time
nullable: true
type: integer
requirements:
"$ref": "#/components/schemas/account_capability_requirements"
status:
description: The status of the capability. Can be `active`, `inactive`,
`pending`, or `unrequested`.
enum:
- active
- disabled
- inactive
- pending
- unrequested
type: string
required:
- account
- id
- object
- requested
- status
title: AccountCapability
type: object
x-expandableFields:
- account
- requirements
x-resourceId: capability
card:
description: |-
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](https://stripe.com/docs/sources/cards).
properties:
account:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/account"
description: 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.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/account"
address_city:
description: City/District/Suburb/Town/Village.
maxLength: 5000
nullable: true
type: string
address_country:
description: Billing address country, if provided when creating card.
maxLength: 5000
nullable: true
type: string
address_line1:
description: Address line 1 (Street address/PO Box/Company name).
maxLength: 5000
nullable: true
type: string
address_line1_check:
description: 'If `address_line1` was provided, results of the check: `pass`,
`fail`, `unavailable`, or `unchecked`.'
maxLength: 5000
nullable: true
type: string
address_line2:
description: Address line 2 (Apartment/Suite/Unit/Building).
maxLength: 5000
nullable: true
type: string
address_state:
description: State/County/Province/Region.
maxLength: 5000
nullable: true
type: string
address_zip:
description: ZIP or postal code.
maxLength: 5000
nullable: true
type: string
address_zip_check:
description: 'If `address_zip` was provided, results of the check: `pass`,
`fail`, `unavailable`, or `unchecked`.'
maxLength: 5000
nullable: true
type: string
available_payout_methods:
description: A set of available payout methods for this card. Will be either
`["standard"]` or `["standard", "instant"]`. Only values from this set
should be passed as the `method` when creating a transfer.
items:
enum:
- instant
- standard
type: string
nullable: true
type: array
brand:
description: Card brand. Can be `American Express`, `Diners Club`, `Discover`,
`JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
maxLength: 5000
type: string
country:
description: 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.
maxLength: 5000
nullable: true
type: string
currency:
nullable: true
type: string
customer:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/customer"
- "$ref": "#/components/schemas/deleted_customer"
description: 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.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/customer"
- "$ref": "#/components/schemas/deleted_customer"
cvc_check:
description: 'If a CVC was provided, results of the check: `pass`, `fail`,
`unavailable`, or `unchecked`.'
maxLength: 5000
nullable: true
type: string
default_for_currency:
description: Whether this card is the default external account for its currency.
nullable: true
type: boolean
dynamic_last4:
description: "(For tokenized numbers only.) The last four digits of the
device account number."
maxLength: 5000
nullable: true
type: string
exp_month:
description: Two-digit number representing the card's expiration month.
type: integer
exp_year:
description: Four-digit number representing the card's expiration year.
type: integer
fingerprint:
description: 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.
maxLength: 5000
nullable: true
type: string
funding:
description: Card funding type. Can be `credit`, `debit`, `prepaid`, or
`unknown`.
maxLength: 5000
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
last4:
description: The last four digits of the card.
maxLength: 5000
type: string
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
name:
description: Cardholder name.
maxLength: 5000
nullable: true
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- card
type: string
recipient:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/recipient"
description: The recipient that this card belongs to. This attribute will
not be in the card object if the card belongs to a customer or account
instead.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/recipient"
tokenization_method:
description: If the card number is tokenized, this is the method that was
used. Can be `amex_express_checkout`, `android_pay` (includes Google Pay),
`apple_pay`, `masterpass`, `visa_checkout`, or null.
maxLength: 5000
nullable: true
type: string
required:
- brand
- exp_month
- exp_year
- funding
- id
- last4
- metadata
- object
title: Card
type: object
x-expandableFields:
- account
- customer
- recipient
x-resourceId: card
card_mandate_payment_method_details:
description: ''
properties: {}
title: card_mandate_payment_method_details
type: object
x-expandableFields: []
charge:
description: |-
To charge a credit or a debit card, you create a `Charge` object. You can
retrieve and refund individual charges as well as list all charges. Charges
are identified by a unique, random ID.
Related guide: [Accept a payment with the Charges API](https://stripe.com/docs/payments/accept-a-payment-charges).
properties:
amount:
description: Amount intended to be collected by this payment. A positive
integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)
(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](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts).
The amount value supports up to eight digits (e.g., a value of 99999999
for a USD charge of $999,999.99).
type: integer
amount_refunded:
description: Amount in %s refunded (can be less than the amount attribute
on the charge if a partial refund was issued).
type: integer
application:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/application"
description: ID of the Connect application that created the charge.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/application"
application_fee:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/application_fee"
description: The application fee (if any) for the charge. [See the Connect
documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees)
for details.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/application_fee"
application_fee_amount:
description: The amount of the application fee (if any) for the charge.
[See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees)
for details.
nullable: true
type: integer
balance_transaction:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/balance_transaction"
description: ID of the balance transaction that describes the impact of
this charge on your account balance (not including refunds or disputes).
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/balance_transaction"
billing_details:
"$ref": "#/components/schemas/billing_details"
calculated_statement_descriptor:
description: 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.
maxLength: 5000
nullable: true
type: string
captured:
description: If the charge was created without capturing, this Boolean represents
whether it is still uncaptured or has since been captured.
type: boolean
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
customer:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/customer"
- "$ref": "#/components/schemas/deleted_customer"
description: ID of the customer this charge is for if one exists.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/customer"
- "$ref": "#/components/schemas/deleted_customer"
description:
description: An arbitrary string attached to the object. Often useful for
displaying to users.
maxLength: 40000
nullable: true
type: string
disputed:
description: Whether the charge has been disputed.
type: boolean
failure_code:
description: Error code explaining reason for charge failure if available
(see [the errors section](https://stripe.com/docs/api#errors) for a list
of codes).
maxLength: 5000
nullable: true
type: string
failure_message:
description: Message to user further explaining reason for charge failure
if available.
maxLength: 5000
nullable: true
type: string
fraud_details:
anyOf:
- "$ref": "#/components/schemas/charge_fraud_details"
description: Information on fraud assessments for the charge.
nullable: true
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
invoice:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/invoice"
description: ID of the invoice this charge is for if one exists.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/invoice"
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- charge
type: string
on_behalf_of:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/account"
description: The account (if any) the charge was made on behalf of without
triggering an automatic transfer. See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers)
for details.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/account"
order:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/order"
description: ID of the order this charge is for if one exists.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/order"
outcome:
anyOf:
- "$ref": "#/components/schemas/charge_outcome"
description: Details about whether the payment was accepted, and why. See
[understanding declines](https://stripe.com/docs/declines) for details.
nullable: true
paid:
description: "`true` if the charge succeeded, or was successfully authorized
for later capture."
type: boolean
payment_intent:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/payment_intent"
description: ID of the PaymentIntent associated with this charge, if one
exists.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/payment_intent"
payment_method:
description: ID of the payment method used in this charge.
maxLength: 5000
nullable: true
type: string
payment_method_details:
anyOf:
- "$ref": "#/components/schemas/payment_method_details"
description: Details about the payment method at the time of the transaction.
nullable: true
receipt_email:
description: This is the email address that the receipt for this charge
was sent to.
maxLength: 5000
nullable: true
type: string
receipt_number:
description: This is the transaction number that appears on email receipts
sent for this charge. This attribute will be `null` until a receipt has
been sent.
maxLength: 5000
nullable: true
type: string
receipt_url:
description: 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.
maxLength: 5000
nullable: true
type: string
refunded:
description: Whether the charge has been fully refunded. If the charge is
only partially refunded, this attribute will still be false.
type: boolean
refunds:
description: A list of refunds that have been applied to the charge.
properties:
data:
description: Details about each object.
items:
"$ref": "#/components/schemas/refund"
type: array
has_more:
description: True if this list has another page of items after this
one that can be fetched.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value. Always has the value `list`.
enum:
- list
type: string
url:
description: The URL where this list can be accessed.
maxLength: 5000
type: string
required:
- data
- has_more
- object
- url
title: RefundList
type: object
x-expandableFields:
- data
review:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/review"
description: ID of the review associated with this charge if one exists.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/review"
shipping:
anyOf:
- "$ref": "#/components/schemas/shipping"
description: Shipping information for the charge.
nullable: true
source_transfer:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/transfer"
description: The transfer ID which created this charge. Only present if
the charge came from another Stripe account. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges)
for details.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/transfer"
statement_descriptor:
description: For card charges, use `statement_descriptor_suffix` instead.
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.
maxLength: 5000
nullable: true
type: string
statement_descriptor_suffix:
description: 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.
maxLength: 5000
nullable: true
type: string
status:
description: The status of the payment is either `succeeded`, `pending`,
or `failed`.
maxLength: 5000
type: string
transfer:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/transfer"
description: ID of the transfer to the `destination` account (only applicable
if the charge was created using the `destination` parameter).
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/transfer"
transfer_data:
anyOf:
- "$ref": "#/components/schemas/charge_transfer_data"
description: An optional dictionary including the account to automatically
transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges)
for details.
nullable: true
transfer_group:
description: A string that identifies this transaction as part of a group.
See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options)
for details.
maxLength: 5000
nullable: true
type: string
required:
- amount
- amount_refunded
- billing_details
- captured
- created
- currency
- disputed
- id
- livemode
- metadata
- object
- paid
- refunded
- refunds
- status
title: Charge
type: object
x-expandableFields:
- application
- application_fee
- balance_transaction
- billing_details
- customer
- fraud_details
- invoice
- on_behalf_of
- order
- outcome
- payment_intent
- payment_method_details
- refunds
- review
- shipping
- source_transfer
- transfer
- transfer_data
x-resourceId: charge
charge_fraud_details:
description: ''
properties:
stripe_report:
description: Assessments from Stripe. If set, the value is `fraudulent`.
maxLength: 5000
type: string
user_report:
description: Assessments reported by you. If set, possible values of are
`safe` and `fraudulent`.
maxLength: 5000
type: string
title: ChargeFraudDetails
type: object
x-expandableFields: []
charge_outcome:
description: ''
properties:
network_status:
description: Possible values are `approved_by_network`, `declined_by_network`,
`not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval`
indicates the payment was [blocked by Stripe](https://stripe.com/docs/declines#blocked-payments)
after bank authorization, and may temporarily appear as "pending" on a
cardholder's statement.
maxLength: 5000
nullable: true
type: string
reason:
description: An enumerated value providing a more detailed explanation of
the outcome's `type`. Charges blocked by Radar's default block rule have
the value `highest_risk_level`. Charges placed in review by Radar's default
review rule have the value `elevated_risk_level`. Charges authorized,
blocked, or placed in review by custom rules have the value `rule`. See
[understanding declines](https://stripe.com/docs/declines) for more details.
maxLength: 5000
nullable: true
type: string
risk_level:
description: Stripe'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 value `not_assessed`. In the
event of an error in the evaluation, this field will have the value `unknown`.
maxLength: 5000
type: string
risk_score:
description: Stripe'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.
type: integer
rule:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/rule"
description: The ID of the Radar rule that matched the payment, if applicable.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/rule"
seller_message:
description: A human-readable description of the outcome type and reason,
designed for you (the recipient of the payment), not your customer.
maxLength: 5000
nullable: true
type: string
type:
description: Possible values are `authorized`, `manual_review`, `issuer_declined`,
`blocked`, and `invalid`. See [understanding declines](https://stripe.com/docs/declines)
and [Radar reviews](https://stripe.com/docs/radar/reviews) for details.
maxLength: 5000
type: string
required:
- type
title: ChargeOutcome
type: object
x-expandableFields:
- rule
charge_transfer_data:
description: ''
properties:
amount:
description: The amount transferred to the destination account, if specified.
By default, the entire charge amount is transferred to the destination
account.
nullable: true
type: integer
destination:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/account"
description: ID of an existing, connected Stripe account to transfer funds
to if `transfer_data` was specified in the charge request.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/account"
required:
- destination
title: ChargeTransferData
type: object
x-expandableFields:
- destination
checkout.session:
description: |-
A Checkout Session represents your customer's session as they pay for
one-time purchases or subscriptions through [Checkout](https://stripe.com/docs/payments/checkout).
We recommend creating a new Session each time your customer attempts to pay.
Once payment is successful, the Checkout Session will contain a reference
to the [Customer](https://stripe.com/docs/api/customers), and either the successful
[PaymentIntent](https://stripe.com/docs/api/payment_intents) or an active
[Subscription](https://stripe.com/docs/api/subscriptions).
You can create a Checkout Session on your server and pass its ID to the
client to begin Checkout.
Related guide: [Checkout Server Quickstart](https://stripe.com/docs/payments/checkout/api).
properties:
billing_address_collection:
description: |-
The value (`auto` or `required`) for whether Checkout collected the
customer's billing address.
maxLength: 5000
nullable: true
type: string
cancel_url:
description: The URL the customer will be directed to if they decide to
cancel payment and return to your website.
maxLength: 5000
type: string
client_reference_id:
description: |-
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.
maxLength: 5000
nullable: true
type: string
customer:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/customer"
description: |-
The ID of the customer for this session.
For Checkout Sessions in `payment` or `subscription` mode, Checkout
will create a new customer object based on information provided
during the session unless an existing customer was provided when
the session was created.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/customer"
customer_email:
description: |-
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 `customer` attribute.
maxLength: 5000
nullable: true
type: string
display_items:
description: The line items, plans, or SKUs purchased by the customer. Prefer
using `line_items`.
items:
"$ref": "#/components/schemas/checkout_session_display_item"
type: array
id:
description: |-
Unique identifier for the object. Used to pass to `redirectToCheckout`
in Stripe.js.
maxLength: 5000
type: string
line_items:
description: The line items purchased by the customer.
properties:
data:
description: Details about each object.
items:
"$ref": "#/components/schemas/item"
type: array
has_more:
description: True if this list has another page of items after this
one that can be fetched.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value. Always has the value `list`.
enum:
- list
type: string
url:
description: The URL where this list can be accessed.
maxLength: 5000
type: string
required:
- data
- has_more
- object
- url
title: PaymentPagesCheckoutSessionListLineItems
type: object
x-expandableFields:
- data
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
locale:
description: The IETF language tag of the locale Checkout is displayed in.
If blank or `auto`, the browser's locale is used.
enum:
- auto
- bg
- cs
- da
- de
- el
- en
- es
- et
- fi
- fr
- hu
- it
- ja
- lt
- lv
- ms
- mt
- nb
- nl
- pl
- pt
- pt-BR
- ro
- ru
- sk
- sl
- sv
- tr
- zh
nullable: true
type: string
x-stripeBypassValidation: true
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
nullable: true
type: object
mode:
description: The mode of the Checkout Session, one of `payment`, `setup`,
or `subscription`.
enum:
- payment
- setup
- subscription
nullable: true
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- checkout.session
type: string
payment_intent:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/payment_intent"
description: The ID of the PaymentIntent for Checkout Sessions in `payment`
mode.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/payment_intent"
payment_method_types:
description: |-
A list of the types of payment methods (e.g. card) this Checkout
Session is allowed to accept.
items:
maxLength: 5000
type: string
type: array
setup_intent:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/setup_intent"
description: The ID of the SetupIntent for Checkout Sessions in `setup`
mode.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/setup_intent"
shipping:
anyOf:
- "$ref": "#/components/schemas/shipping"
description: Shipping information for this Checkout Session.
nullable: true
shipping_address_collection:
anyOf:
- "$ref": "#/components/schemas/payment_pages_payment_page_resources_shipping_address_collection"
description: When set, provides configuration for Checkout to collect a
shipping address from a customer.
nullable: true
submit_type:
description: |-
Describes the type of transaction being performed by Checkout in order to customize
relevant text on the page, such as the submit button. `submit_type` can only be
specified on Checkout Sessions in `payment` mode, but not Checkout Sessions
in `subscription` or `setup` mode.
enum:
- auto
- book
- donate
- pay
nullable: true
type: string
subscription:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/subscription"
description: The ID of the subscription for Checkout Sessions in `subscription`
mode.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/subscription"
success_url:
description: |-
The URL the customer will be directed to after the payment or
subscription creation is successful.
maxLength: 5000
type: string
required:
- cancel_url
- id
- livemode
- object
- payment_method_types
- success_url
title: Session
type: object
x-expandableFields:
- customer
- display_items
- line_items
- payment_intent
- setup_intent
- shipping
- shipping_address_collection
- subscription
x-resourceId: checkout.session
checkout_session_custom_display_item_description:
description: ''
properties:
description:
description: The description of the line item.
maxLength: 5000
nullable: true
type: string
images:
description: The images of the line item.
items:
maxLength: 5000
type: string
nullable: true
type: array
name:
description: The name of the line item.
maxLength: 5000
type: string
required:
- name
title: checkout_session_custom_display_item_description
type: object
x-expandableFields: []
checkout_session_display_item:
description: ''
properties:
amount:
description: Amount for the display item.
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
custom:
"$ref": "#/components/schemas/checkout_session_custom_display_item_description"
plan:
"$ref": "#/components/schemas/plan"
quantity:
description: Quantity of the display item being purchased.
type: integer
sku:
"$ref": "#/components/schemas/sku"
type:
description: The type of display item. One of `custom`, `plan` or `sku`
maxLength: 5000
type: string
title: checkout_session_display_item
type: object
x-expandableFields:
- custom
- plan
- sku
connect_collection_transfer:
description: ''
properties:
amount:
description: Amount transferred, in %s.
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
destination:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/account"
description: ID of the account that funds are being collected for.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/account"
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- connect_collection_transfer
type: string
required:
- amount
- currency
- destination
- id
- livemode
- object
title: ConnectCollectionTransfer
type: object
x-expandableFields:
- destination
country_spec:
description: |-
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](/docs/connect/required-verification-information).
properties:
default_currency:
description: The default currency for this country. This applies to both
payment methods and bank accounts.
maxLength: 5000
type: string
id:
description: Unique identifier for the object. Represented as the ISO country
code for this country.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- country_spec
type: string
supported_bank_account_currencies:
additionalProperties:
items:
maxLength: 5000
type: string
type: array
description: Currencies that can be accepted in the specific country (for
transfers).
type: object
supported_payment_currencies:
description: Currencies that can be accepted in the specified country (for
payments).
items:
maxLength: 5000
type: string
type: array
supported_payment_methods:
description: Payment methods available in the specified country. You may
need to enable some payment methods (e.g., [ACH](https://stripe.com/docs/ach))
on your account before they appear in this list. The `stripe` payment
method refers to [charging through your platform](https://stripe.com/docs/connect/destination-charges).
items:
maxLength: 5000
type: string
type: array
supported_transfer_countries:
description: Countries that can accept transfers from the specified country.
items:
maxLength: 5000
type: string
type: array
verification_fields:
"$ref": "#/components/schemas/country_spec_verification_fields"
required:
- default_currency
- id
- object
- supported_bank_account_currencies
- supported_payment_currencies
- supported_payment_methods
- supported_transfer_countries
- verification_fields
title: CountrySpec
type: object
x-expandableFields:
- verification_fields
x-resourceId: country_spec
country_spec_verification_field_details:
description: ''
properties:
additional:
description: Additional fields which are only required for some users.
items:
maxLength: 5000
type: string
type: array
minimum:
description: Fields which every account must eventually provide.
items:
maxLength: 5000
type: string
type: array
required:
- additional
- minimum
title: CountrySpecVerificationFieldDetails
type: object
x-expandableFields: []
country_spec_verification_fields:
description: ''
properties:
company:
"$ref": "#/components/schemas/country_spec_verification_field_details"
individual:
"$ref": "#/components/schemas/country_spec_verification_field_details"
required:
- company
- individual
title: CountrySpecVerificationFields
type: object
x-expandableFields:
- company
- individual
coupon:
description: |-
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 [invoices](https://stripe.com/docs/api#invoices) or
[orders](https://stripe.com/docs/api#create_order-coupon). Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge).
properties:
amount_off:
description: Amount (in the `currency` specified) that will be taken off
the subtotal of any invoices for this customer.
nullable: true
type: integer
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
currency:
description: If `amount_off` has been set, the three-letter [ISO code for
the currency](https://stripe.com/docs/currencies) of the amount to take
off.
nullable: true
type: string
duration:
description: One of `forever`, `once`, and `repeating`. Describes how long
a customer who applies this coupon will get the discount.
enum:
- forever
- once
- repeating
type: string
duration_in_months:
description: If `duration` is `repeating`, the number of months the coupon
applies. Null if coupon `duration` is `forever` or `once`.
nullable: true
type: integer
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
max_redemptions:
description: Maximum number of times this coupon can be redeemed, in total,
across all customers, before it is no longer valid.
nullable: true
type: integer
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
name:
description: Name of the coupon displayed to customers on for instance invoices
or receipts.
maxLength: 5000
nullable: true
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- coupon
type: string
percent_off:
description: 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 %s100 invoice %s50 instead.
nullable: true
type: number
redeem_by:
description: Date after which the coupon can no longer be redeemed.
format: unix-time
nullable: true
type: integer
times_redeemed:
description: Number of times this coupon has been applied to a customer.
type: integer
valid:
description: Taking account of the above properties, whether this coupon
can still be applied to a customer.
type: boolean
required:
- created
- duration
- id
- livemode
- metadata
- object
- times_redeemed
- valid
title: Coupon
type: object
x-expandableFields: []
x-resourceId: coupon
credit_note:
description: |-
Issue a credit note to adjust an invoice's amount after the invoice is finalized.
Related guide: [Credit Notes](https://stripe.com/docs/billing/invoices/credit-notes).
properties:
amount:
description: The integer amount in **%s** representing the total amount
of the credit note, including tax.
type: integer
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
customer:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/customer"
description: ID of the customer.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/customer"
customer_balance_transaction:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/customer_balance_transaction"
description: Customer balance transaction related to this credit note.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/customer_balance_transaction"
discount_amount:
description: The integer amount in **%s** representing the amount of the
discount that was credited.
type: integer
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
invoice:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/invoice"
description: ID of the invoice.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/invoice"
lines:
description: Line items that make up the credit note
properties:
data:
description: Details about each object.
items:
"$ref": "#/components/schemas/credit_note_line_item"
type: array
has_more:
description: True if this list has another page of items after this
one that can be fetched.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value. Always has the value `list`.
enum:
- list
type: string
url:
description: The URL where this list can be accessed.
maxLength: 5000
type: string
required:
- data
- has_more
- object
- url
title: CreditNoteLinesList
type: object
x-expandableFields:
- data
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
memo:
description: Customer-facing text that appears on the credit note PDF.
maxLength: 5000
nullable: true
type: string
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
number:
description: A unique number that identifies this particular credit note
and appears on the PDF of the credit note and its associated invoice.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- credit_note
type: string
out_of_band_amount:
description: Amount that was credited outside of Stripe.
nullable: true
type: integer
pdf:
description: The link to download the PDF of the credit note.
maxLength: 5000
type: string
reason:
description: Reason for issuing this credit note, one of `duplicate`, `fraudulent`,
`order_change`, or `product_unsatisfactory`
enum:
- duplicate
- fraudulent
- order_change
- product_unsatisfactory
nullable: true
type: string
refund:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/refund"
description: Refund related to this credit note.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/refund"
status:
description: Status of this credit note, one of `issued` or `void`. Learn
more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding).
enum:
- issued
- void
type: string
subtotal:
description: The integer amount in **%s** representing the amount of the
credit note, excluding tax and discount.
type: integer
tax_amounts:
description: The aggregate amounts calculated per tax rate for all line
items.
items:
"$ref": "#/components/schemas/credit_note_tax_amount"
type: array
total:
description: The integer amount in **%s** representing the total amount
of the credit note, including tax and discount.
type: integer
type:
description: Type of this credit note, one of `pre_payment` or `post_payment`.
A `pre_payment` credit note means it was issued when the invoice was open.
A `post_payment` credit note means it was issued when the invoice was
paid.
enum:
- post_payment
- pre_payment
type: string
voided_at:
description: The time that the credit note was voided.
format: unix-time
nullable: true
type: integer
required:
- amount
- created
- currency
- customer
- discount_amount
- id
- invoice
- lines
- livemode
- metadata
- number
- object
- pdf
- status
- subtotal
- tax_amounts
- total
- type
title: CreditNote
type: object
x-expandableFields:
- customer
- customer_balance_transaction
- invoice
- lines
- refund
- tax_amounts
x-resourceId: credit_note
credit_note_line_item:
description: ''
properties:
amount:
description: The integer amount in **%s** representing the gross amount
being credited for this line item, excluding (exclusive) tax and discounts.
type: integer
description:
description: Description of the item being credited.
maxLength: 5000
nullable: true
type: string
discount_amount:
description: The integer amount in **%s** representing the discount being
credited for this line item.
type: integer
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
invoice_line_item:
description: ID of the invoice line item being credited
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- credit_note_line_item
type: string
quantity:
description: The number of units of product being credited.
nullable: true
type: integer
tax_amounts:
description: The amount of tax calculated per tax rate for this line item
items:
"$ref": "#/components/schemas/credit_note_tax_amount"
type: array
tax_rates:
description: The tax rates which apply to the line item.
items:
"$ref": "#/components/schemas/tax_rate"
type: array
type:
description: The type of the credit note line item, one of `invoice_line_item`
or `custom_line_item`. When the type is `invoice_line_item` there is an
additional `invoice_line_item` property on the resource the value of which
is the id of the credited line item on the invoice.
enum:
- custom_line_item
- invoice_line_item
type: string
unit_amount:
description: The cost of each unit of product being credited.
nullable: true
type: integer
unit_amount_decimal:
description: Same as `unit_amount`, but contains a decimal value with at
most 12 decimal places.
format: decimal
nullable: true
type: string
required:
- amount
- discount_amount
- id
- livemode
- object
- tax_amounts
- tax_rates
- type
title: CreditNoteLineItem
type: object
x-expandableFields:
- tax_amounts
- tax_rates
x-resourceId: credit_note_line_item
credit_note_tax_amount:
description: ''
properties:
amount:
description: The amount, in %s, of the tax.
type: integer
inclusive:
description: Whether this tax amount is inclusive or exclusive.
type: boolean
tax_rate:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/tax_rate"
description: The tax rate that was applied to get this tax amount.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/tax_rate"
required:
- amount
- inclusive
- tax_rate
title: CreditNoteTaxAmount
type: object
x-expandableFields:
- tax_rate
customer:
description: |-
`Customer` objects allow you to perform recurring charges, and to track
multiple charges, that are associated with the same customer. The API allows
you to create, delete, and update your customers. You can retrieve individual
customers as well as a list of all your customers.
Related guide: [Save a card during payment](https://stripe.com/docs/payments/save-during-payment).
properties:
address:
anyOf:
- "$ref": "#/components/schemas/address"
description: The customer's address.
nullable: true
balance:
description: Current balance, if any, being 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 will be added to their next invoice.
The balance does not refer to any unpaid invoices; it solely takes into
account amounts that have yet to be successfully applied to any invoice.
This balance is only taken into account as invoices are finalized.
type: integer
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
currency:
description: Three-letter [ISO code for the currency](https://stripe.com/docs/currencies)
the customer can be charged in for recurring billing purposes.
maxLength: 5000
nullable: true
type: string
default_source:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/alipay_account"
- "$ref": "#/components/schemas/bank_account"
- "$ref": "#/components/schemas/bitcoin_receiver"
- "$ref": "#/components/schemas/card"
- "$ref": "#/components/schemas/source"
description: |-
ID of the default payment source for the customer.
If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/alipay_account"
- "$ref": "#/components/schemas/bank_account"
- "$ref": "#/components/schemas/bitcoin_receiver"
- "$ref": "#/components/schemas/card"
- "$ref": "#/components/schemas/source"
delinquent:
description: When the customer's latest invoice is billed by charging automatically,
delinquent is true if the invoice's latest charge is failed. When the
customer's latest invoice is billed by sending an invoice, delinquent
is true if the invoice is not paid by its due date.
nullable: true
type: boolean
description:
description: An arbitrary string attached to the object. Often useful for
displaying to users.
maxLength: 5000
nullable: true
type: string
discount:
anyOf:
- "$ref": "#/components/schemas/discount"
description: Describes the current discount active on the customer, if there
is one.
nullable: true
email:
description: The customer's email address.
maxLength: 5000
nullable: true
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
invoice_prefix:
description: The prefix for the customer used to generate unique invoice
numbers.
maxLength: 5000
nullable: true
type: string
invoice_settings:
"$ref": "#/components/schemas/invoice_setting_customer_setting"
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
name:
description: The customer's full name or business name.
maxLength: 5000
nullable: true
type: string
next_invoice_sequence:
description: The suffix of the customer's next invoice number, e.g., 0001.
type: integer
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- customer
type: string
phone:
description: The customer's phone number.
maxLength: 5000
nullable: true
type: string
preferred_locales:
description: The customer's preferred locales (languages), ordered by preference.
items:
maxLength: 5000
type: string
nullable: true
type: array
shipping:
anyOf:
- "$ref": "#/components/schemas/shipping"
description: Mailing and shipping address for the customer. Appears on invoices
emailed to this customer.
nullable: true
sources:
description: The customer's payment sources, if any.
properties:
data:
description: Details about each object.
items:
anyOf:
- "$ref": "#/components/schemas/alipay_account"
- "$ref": "#/components/schemas/bank_account"
- "$ref": "#/components/schemas/bitcoin_receiver"
- "$ref": "#/components/schemas/card"
- "$ref": "#/components/schemas/source"
title: Polymorphic
type: array
has_more:
description: True if this list has another page of items after this
one that can be fetched.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value. Always has the value `list`.
enum:
- list
type: string
url:
description: The URL where this list can be accessed.
maxLength: 5000
type: string
required:
- data
- has_more
- object
- url
title: ApmsSourcesSourceList
type: object
x-expandableFields:
- data
subscriptions:
description: The customer's current subscriptions, if any.
properties:
data:
description: Details about each object.
items:
"$ref": "#/components/schemas/subscription"
type: array
has_more:
description: True if this list has another page of items after this
one that can be fetched.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value. Always has the value `list`.
enum:
- list
type: string
url:
description: The URL where this list can be accessed.
maxLength: 5000
type: string
required:
- data
- has_more
- object
- url
title: SubscriptionList
type: object
x-expandableFields:
- data
tax_exempt:
description: Describes the customer's tax exemption status. One of `none`,
`exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs
include the text **"Reverse charge"**.
enum:
- exempt
- none
- reverse
nullable: true
type: string
tax_ids:
description: The customer's tax IDs.
properties:
data:
description: Details about each object.
items:
"$ref": "#/components/schemas/tax_id"
type: array
has_more:
description: True if this list has another page of items after this
one that can be fetched.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value. Always has the value `list`.
enum:
- list
type: string
url:
description: The URL where this list can be accessed.
maxLength: 5000
type: string
required:
- data
- has_more
- object
- url
title: TaxIDsList
type: object
x-expandableFields:
- data
required:
- created
- id
- livemode
- object
- sources
title: Customer
type: object
x-expandableFields:
- address
- default_source
- discount
- invoice_settings
- shipping
- sources
- subscriptions
- tax_ids
x-resourceId: customer
customer_acceptance:
description: ''
properties:
accepted_at:
description: The time at which the customer accepted the Mandate.
format: unix-time
nullable: true
type: integer
offline:
"$ref": "#/components/schemas/offline_acceptance"
online:
"$ref": "#/components/schemas/online_acceptance"
type:
description: The type of customer acceptance information included with the
Mandate. One of `online` or `offline`.
enum:
- offline
- online
type: string
required:
- type
title: customer_acceptance
type: object
x-expandableFields:
- offline
- online
customer_balance_transaction:
description: |-
Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-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](https://stripe.com/docs/api/customers/update),
or by creating a Customer Balance Transaction, which increments or decrements the customer's `balance` by the specified `amount`.
Related guide: [Customer Balance](https://stripe.com/docs/billing/customer/balance) to learn more.
properties:
amount:
description: 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`.
type: integer
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
credit_note:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/credit_note"
description: The ID of the credit note (if any) related to the transaction.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/credit_note"
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
customer:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/customer"
description: The ID of the customer the transaction belongs to.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/customer"
description:
description: An arbitrary string attached to the object. Often useful for
displaying to users.
maxLength: 5000
nullable: true
type: string
ending_balance:
description: The customer's `balance` after 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.
type: integer
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
invoice:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/invoice"
description: The ID of the invoice (if any) related to the transaction.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/invoice"
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
nullable: true
type: object
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- customer_balance_transaction
type: string
type:
description: 'Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`,
`initial`, `invoice_too_large`, `invoice_too_small`, `unspent_receiver_credit`,
or `unapplied_from_invoice`. See the [Customer Balance page](https://stripe.com/docs/billing/customer/balance#types)
to learn more about transaction types.'
enum:
- adjustment
- applied_to_invoice
- credit_note
- initial
- invoice_too_large
- invoice_too_small
- migration
- unapplied_from_invoice
- unspent_receiver_credit
type: string
required:
- amount
- created
- currency
- customer
- ending_balance
- id
- livemode
- object
- type
title: CustomerBalanceTransaction
type: object
x-expandableFields:
- credit_note
- customer
- invoice
x-resourceId: customer_balance_transaction
deleted_account:
description: ''
properties:
deleted:
description: Always true for a deleted object
enum:
- true
type: boolean
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- account
type: string
required:
- deleted
- id
- object
title: DeletedAccount
type: object
x-expandableFields: []
x-resourceId: deleted_account
deleted_alipay_account:
description: ''
properties:
deleted:
description: Always true for a deleted object
enum:
- true
type: boolean
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- alipay_account
type: string
required:
- deleted
- id
- object
title: AlipayDeletedAccount
type: object
x-expandableFields: []
deleted_apple_pay_domain:
description: ''
properties:
deleted:
description: Always true for a deleted object
enum:
- true
type: boolean
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- apple_pay_domain
type: string
required:
- deleted
- id
- object
title: DeletedApplePayDomain
type: object
x-expandableFields: []
x-resourceId: deleted_apple_pay_domain
deleted_bank_account:
description: ''
properties:
currency:
description: Three-letter [ISO code for the currency](https://stripe.com/docs/payouts)
paid out to the bank account.
maxLength: 5000
nullable: true
type: string
deleted:
description: Always true for a deleted object
enum:
- true
type: boolean
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- bank_account
type: string
required:
- deleted
- id
- object
title: DeletedBankAccount
type: object
x-expandableFields: []
deleted_bitcoin_receiver:
description: ''
properties:
deleted:
description: Always true for a deleted object
enum:
- true
type: boolean
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- bitcoin_receiver
type: string
required:
- deleted
- id
- object
title: BitcoinDeletedReceiver
type: object
x-expandableFields: []
deleted_card:
description: ''
properties:
currency:
description: Three-letter [ISO code for the currency](https://stripe.com/docs/payouts)
paid out to the bank account.
maxLength: 5000
nullable: true
type: string
deleted:
description: Always true for a deleted object
enum:
- true
type: boolean
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- card
type: string
required:
- deleted
- id
- object
title: DeletedCard
type: object
x-expandableFields: []
deleted_coupon:
description: ''
properties:
deleted:
description: Always true for a deleted object
enum:
- true
type: boolean
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- coupon
type: string
required:
- deleted
- id
- object
title: DeletedCoupon
type: object
x-expandableFields: []
x-resourceId: deleted_coupon
deleted_customer:
description: ''
properties:
deleted:
description: Always true for a deleted object
enum:
- true
type: boolean
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- customer
type: string
required:
- deleted
- id
- object
title: DeletedCustomer
type: object
x-expandableFields: []
x-resourceId: deleted_customer
deleted_discount:
description: ''
properties:
deleted:
description: Always true for a deleted object
enum:
- true
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- discount
type: string
required:
- deleted
- object
title: DeletedDiscount
type: object
x-expandableFields: []
x-resourceId: deleted_discount
deleted_external_account:
anyOf:
- "$ref": "#/components/schemas/deleted_bank_account"
- "$ref": "#/components/schemas/deleted_card"
title: Polymorphic
x-resourceId: deleted_external_account
deleted_invoice:
description: ''
properties:
deleted:
description: Always true for a deleted object
enum:
- true
type: boolean
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- invoice
type: string
required:
- deleted
- id
- object
title: DeletedInvoice
type: object
x-expandableFields: []
x-resourceId: deleted_invoice
deleted_invoiceitem:
description: ''
properties:
deleted:
description: Always true for a deleted object
enum:
- true
type: boolean
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- invoiceitem
type: string
required:
- deleted
- id
- object
title: DeletedInvoiceItem
type: object
x-expandableFields: []
x-resourceId: deleted_invoiceitem
deleted_payment_source:
anyOf:
- "$ref": "#/components/schemas/deleted_alipay_account"
- "$ref": "#/components/schemas/deleted_bank_account"
- "$ref": "#/components/schemas/deleted_bitcoin_receiver"
- "$ref": "#/components/schemas/deleted_card"
title: Polymorphic
x-resourceId: deleted_payment_source
deleted_person:
description: ''
properties:
deleted:
description: Always true for a deleted object
enum:
- true
type: boolean
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- person
type: string
required:
- deleted
- id
- object
title: DeletedPerson
type: object
x-expandableFields: []
x-resourceId: deleted_person
deleted_plan:
description: ''
properties:
deleted:
description: Always true for a deleted object
enum:
- true
type: boolean
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- plan
type: string
required:
- deleted
- id
- object
title: DeletedPlan
type: object
x-expandableFields: []
x-resourceId: deleted_plan
deleted_price:
description: ''
properties:
deleted:
description: Always true for a deleted object
enum:
- true
type: boolean
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- price
type: string
required:
- deleted
- id
- object
title: DeletedPrice
type: object
x-expandableFields: []
deleted_product:
description: ''
properties:
deleted:
description: Always true for a deleted object
enum:
- true
type: boolean
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- product
type: string
required:
- deleted
- id
- object
title: DeletedProduct
type: object
x-expandableFields: []
x-resourceId: deleted_product
deleted_radar.value_list:
description: ''
properties:
deleted:
description: Always true for a deleted object
enum:
- true
type: boolean
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- radar.value_list
type: string
required:
- deleted
- id
- object
title: RadarListDeletedList
type: object
x-expandableFields: []
x-resourceId: deleted_radar.value_list
deleted_radar.value_list_item:
description: ''
properties:
deleted:
description: Always true for a deleted object
enum:
- true
type: boolean
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- radar.value_list_item
type: string
required:
- deleted
- id
- object
title: RadarListDeletedListItem
type: object
x-expandableFields: []
x-resourceId: deleted_radar.value_list_item
deleted_recipient:
description: ''
properties:
deleted:
description: Always true for a deleted object
enum:
- true
type: boolean
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- recipient
type: string
required:
- deleted
- id
- object
title: DeletedTransferRecipient
type: object
x-expandableFields: []
x-resourceId: deleted_recipient
deleted_sku:
description: ''
properties:
deleted:
description: Always true for a deleted object
enum:
- true
type: boolean
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- sku
type: string
required:
- deleted
- id
- object
title: DeletedSKU
type: object
x-expandableFields: []
x-resourceId: deleted_sku
deleted_subscription_item:
description: ''
properties:
deleted:
description: Always true for a deleted object
enum:
- true
type: boolean
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- subscription_item
type: string
required:
- deleted
- id
- object
title: DeletedSubscriptionItem
type: object
x-expandableFields: []
x-resourceId: deleted_subscription_item
deleted_tax_id:
description: ''
properties:
deleted:
description: Always true for a deleted object
enum:
- true
type: boolean
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- tax_id
type: string
required:
- deleted
- id
- object
title: deleted_tax_id
type: object
x-expandableFields: []
x-resourceId: deleted_tax_id
deleted_terminal.location:
description: ''
properties:
deleted:
description: Always true for a deleted object
enum:
- true
type: boolean
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- terminal.location
type: string
required:
- deleted
- id
- object
title: TerminalLocationDeletedLocation
type: object
x-expandableFields: []
x-resourceId: deleted_terminal.location
deleted_terminal.reader:
description: ''
properties:
deleted:
description: Always true for a deleted object
enum:
- true
type: boolean
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- terminal.reader
type: string
required:
- deleted
- id
- object
title: TerminalReaderDeletedReader
type: object
x-expandableFields: []
x-resourceId: deleted_terminal.reader
deleted_webhook_endpoint:
description: ''
properties:
deleted:
description: Always true for a deleted object
enum:
- true
type: boolean
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- webhook_endpoint
type: string
required:
- deleted
- id
- object
title: NotificationWebhookEndpointDeleted
type: object
x-expandableFields: []
x-resourceId: deleted_webhook_endpoint
delivery_estimate:
description: ''
properties:
date:
description: If `type` is `"exact"`, `date` will be the expected delivery
date in the format YYYY-MM-DD.
maxLength: 5000
type: string
earliest:
description: If `type` is `"range"`, `earliest` will be be the earliest
delivery date in the format YYYY-MM-DD.
maxLength: 5000
type: string
latest:
description: If `type` is `"range"`, `latest` will be the latest delivery
date in the format YYYY-MM-DD.
maxLength: 5000
type: string
type:
description: The type of estimate. Must be either `"range"` or `"exact"`.
maxLength: 5000
type: string
required:
- type
title: DeliveryEstimate
type: object
x-expandableFields: []
discount:
description: |-
A discount represents the actual application of a coupon to a particular
customer. It contains information about when the discount began and when it
will end.
Related guide: [Applying Discounts to Subscriptions](https://stripe.com/docs/billing/subscriptions/discounts).
properties:
coupon:
"$ref": "#/components/schemas/coupon"
customer:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/customer"
- "$ref": "#/components/schemas/deleted_customer"
description: The ID of the customer associated with this discount.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/customer"
- "$ref": "#/components/schemas/deleted_customer"
end:
description: If the coupon has a duration of `repeating`, the date that
this discount will end. If the coupon has a duration of `once` or `forever`,
this attribute will be null.
format: unix-time
nullable: true
type: integer
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- discount
type: string
start:
description: Date that the coupon was applied.
format: unix-time
type: integer
subscription:
description: The subscription that this coupon is applied to, if it is applied
to a particular subscription.
maxLength: 5000
nullable: true
type: string
required:
- coupon
- object
- start
title: Discount
type: object
x-expandableFields:
- coupon
- customer
x-resourceId: discount
dispute:
description: |-
A dispute occurs when a customer questions your charge with their card issuer.
When this happens, you're given the opportunity to respond to the dispute with
evidence that shows that the charge is legitimate. You can find more
information about the dispute process in our [Disputes and
Fraud](/docs/disputes) documentation.
Related guide: [Disputes and Fraud](https://stripe.com/docs/disputes).
properties:
amount:
description: Disputed amount. Usually the amount of the charge, but can
differ (usually because of currency fluctuation or because only part of
the order is disputed).
type: integer
balance_transactions:
description: List of zero, one, or two balance transactions that show funds
withdrawn and reinstated to your Stripe account as a result of this dispute.
items:
"$ref": "#/components/schemas/balance_transaction"
type: array
charge:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/charge"
description: ID of the charge that was disputed.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/charge"
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
evidence:
"$ref": "#/components/schemas/dispute_evidence"
evidence_details:
"$ref": "#/components/schemas/dispute_evidence_details"
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
is_charge_refundable:
description: If true, it is still possible to refund the disputed payment.
Once the payment has been fully refunded, no further funds will be withdrawn
from your Stripe account as a result of this dispute.
type: boolean
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- dispute
type: string
payment_intent:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/payment_intent"
description: ID of the PaymentIntent that was disputed.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/payment_intent"
reason:
description: 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`, or `unrecognized`. Read more about [dispute reasons](https://stripe.com/docs/disputes/categories).
maxLength: 5000
type: string
status:
description: Current status of dispute. Possible values are `warning_needs_response`,
`warning_under_review`, `warning_closed`, `needs_response`, `under_review`,
`charge_refunded`, `won`, or `lost`.
enum:
- charge_refunded
- lost
- needs_response
- under_review
- warning_closed
- warning_needs_response
- warning_under_review
- won
type: string
required:
- amount
- balance_transactions
- charge
- created
- currency
- evidence
- evidence_details
- id
- is_charge_refundable
- livemode
- metadata
- object
- reason
- status
title: Dispute
type: object
x-expandableFields:
- balance_transactions
- charge
- evidence
- evidence_details
- payment_intent
x-resourceId: dispute
dispute_evidence:
description: ''
properties:
access_activity_log:
description: 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.
maxLength: 150000
nullable: true
type: string
billing_address:
description: The billing address provided by the customer.
maxLength: 5000
nullable: true
type: string
cancellation_policy:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/file"
description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload))
Your subscription cancellation policy, as shown to the customer."
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/file"
cancellation_policy_disclosure:
description: An explanation of how and when the customer was shown your
refund policy prior to purchase.
maxLength: 150000
nullable: true
type: string
cancellation_rebuttal:
description: A justification for why the customer's subscription was not
canceled.
maxLength: 150000
nullable: true
type: string
customer_communication:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/file"
description: "(ID of a [file upload](https://stripe.com/docs/guides/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."
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/file"
customer_email_address:
description: The email address of the customer.
maxLength: 5000
nullable: true
type: string
customer_name:
description: The name of the customer.
maxLength: 5000
nullable: true
type: string
customer_purchase_ip:
description: The IP address that the customer used when making the purchase.
maxLength: 5000
nullable: true
type: string
customer_signature:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/file"
description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload))
A relevant document or contract showing the customer's signature."
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/file"
duplicate_charge_documentation:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/file"
description: "(ID of a [file upload](https://stripe.com/docs/guides/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."
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/file"
duplicate_charge_explanation:
description: An explanation of the difference between the disputed charge
versus the prior charge that appears to be a duplicate.
maxLength: 150000
nullable: true
type: string
duplicate_charge_id:
description: The Stripe ID for the prior charge which appears to be a duplicate
of the disputed charge.
maxLength: 5000
nullable: true
type: string
product_description:
description: A description of the product or service that was sold.
maxLength: 150000
nullable: true
type: string
receipt:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/file"
description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload))
Any receipt or message sent to the customer notifying them of the charge."
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/file"
refund_policy:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/file"
description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload))
Your refund policy, as shown to the customer."
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/file"
refund_policy_disclosure:
description: Documentation demonstrating that the customer was shown your
refund policy prior to purchase.
maxLength: 150000
nullable: true
type: string
refund_refusal_explanation:
description: A justification for why the customer is not entitled to a refund.
maxLength: 150000
nullable: true
type: string
service_date:
description: The date on which the customer received or began receiving
the purchased service, in a clear human-readable format.
maxLength: 5000
nullable: true
type: string
service_documentation:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/file"
description: "(ID of a [file upload](https://stripe.com/docs/guides/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."
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/file"
shipping_address:
description: The address to which a physical product was shipped. You should
try to include as complete address information as possible.
maxLength: 5000
nullable: true
type: string
shipping_carrier:
description: 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.
maxLength: 5000
nullable: true
type: string
shipping_date:
description: The date on which a physical product began its route to the
shipping address, in a clear human-readable format.
maxLength: 5000
nullable: true
type: string
shipping_documentation:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/file"
description: "(ID of a [file upload](https://stripe.com/docs/guides/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."
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/file"
shipping_tracking_number:
description: 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.
maxLength: 5000
nullable: true
type: string
uncategorized_file:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/file"
description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload))
Any additional evidence or statements."
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/file"
uncategorized_text:
description: Any additional evidence or statements.
maxLength: 150000
nullable: true
type: string
title: DisputeEvidence
type: object
x-expandableFields:
- cancellation_policy
- customer_communication
- customer_signature
- duplicate_charge_documentation
- receipt
- refund_policy
- service_documentation
- shipping_documentation
- uncategorized_file
dispute_evidence_details:
description: ''
properties:
due_by:
description: Date by which evidence must be submitted in order to successfully
challenge dispute. Will be null if the customer's bank or credit card
company doesn't allow a response for this particular dispute.
format: unix-time
nullable: true
type: integer
has_evidence:
description: Whether evidence has been staged for this dispute.
type: boolean
past_due:
description: Whether the last evidence submission was submitted past the
due date. Defaults to `false` if no evidence submissions have occurred.
If `true`, then delivery of the latest evidence is *not* guaranteed.
type: boolean
submission_count:
description: The number of times evidence has been submitted. Typically,
you may only submit evidence once.
type: integer
required:
- has_evidence
- past_due
- submission_count
title: DisputeEvidenceDetails
type: object
x-expandableFields: []
ephemeral_key:
description: ''
properties:
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
expires:
description: Time at which the key will expire. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- ephemeral_key
type: string
secret:
description: The key's secret. You can use this value to make authorized
requests to the Stripe API.
maxLength: 5000
type: string
required:
- created
- expires
- id
- livemode
- object
title: EphemeralKey
type: object
x-expandableFields: []
x-resourceId: ephemeral_key
error:
description: An error response from the Stripe API
properties:
error:
"$ref": "#/components/schemas/api_errors"
required:
- error
type: object
event:
description: |-
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. Note that many API requests may cause multiple
events to be created. For example, if you create a new subscription for a
customer, you will receive both a `customer.subscription.created` event and a
`charge.succeeded` event.
Events occur when the state of another API resource changes. The state of that
resource at the time of the change is embedded in the event's data field. For
example, a `charge.succeeded` event will contain a charge, and an
`invoice.payment_failed` event will contain an invoice.
As with other API resources, you can use endpoints to retrieve an
[individual event](https://stripe.com/docs/api#retrieve_event) or a [list of events](https://stripe.com/docs/api#list_events)
from the API. We also have a separate
[webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the
`Event` objects directly to an endpoint on your server. Webhooks are managed
in your
[account settings](https://dashboard.stripe.com/account/webhooks'),
and our [Using Webhooks](https://stripe.com/docs/webhooks) guide will help you get set up.
When using [Connect](https://stripe.com/docs/connect), you can also receive notifications of
events that occur in connected accounts. For these events, there will be an
additional `account` attribute in the received `Event` object.
**NOTE:** Right now, access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event) is
guaranteed only for 30 days.
properties:
account:
description: The connected account that originated the event.
maxLength: 5000
type: string
api_version:
description: 'The Stripe API version used to render `data`. *Note: This
property is populated only for events on or after October 31, 2014*.'
maxLength: 5000
nullable: true
type: string
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
data:
"$ref": "#/components/schemas/notification_event_data"
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- event
type: string
pending_webhooks:
description: Number of webhooks that have yet to be successfully delivered
(i.e., to return a 20x response) to the URLs you've specified.
type: integer
request:
anyOf:
- "$ref": "#/components/schemas/notification_event_request"
description: Information on the API request that instigated the event.
nullable: true
type:
description: Description of the event (e.g., `invoice.created` or `charge.refunded`).
maxLength: 5000
type: string
required:
- created
- data
- id
- livemode
- object
- pending_webhooks
- type
title: NotificationEvent
type: object
x-expandableFields:
- data
- request
x-resourceId: event
exchange_rate:
description: |-
`Exchange Rate` 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).
If you want a guarantee that the charge is made with a certain exchange rate
you expect is current, you can pass in `exchange_rate` to charges endpoints.
If the value is no longer up to date, the charge won't go through. Please
refer to our [Exchange Rates API](https://stripe.com/docs/exchange-rates) guide for more
details.
properties:
id:
description: Unique identifier for the object. Represented as the three-letter
[ISO currency code](https://www.iso.org/iso-4217-currency-codes.html)
in lowercase.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- exchange_rate
type: string
rates:
additionalProperties:
type: number
description: 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.
type: object
required:
- id
- object
- rates
title: ExchangeRate
type: object
x-expandableFields: []
x-resourceId: exchange_rate
external_account:
anyOf:
- "$ref": "#/components/schemas/bank_account"
- "$ref": "#/components/schemas/card"
title: Polymorphic
x-resourceId: external_account
fee:
description: ''
properties:
amount:
description: Amount of the fee, in cents.
type: integer
application:
description: ID of the Connect application that earned the fee.
maxLength: 5000
nullable: true
type: string
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
description:
description: An arbitrary string attached to the object. Often useful for
displaying to users.
maxLength: 5000
nullable: true
type: string
type:
description: 'Type of the fee, one of: `application_fee`, `stripe_fee` or
`tax`.'
maxLength: 5000
type: string
required:
- amount
- currency
- type
title: Fee
type: object
x-expandableFields: []
fee_refund:
description: |-
`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](https://stripe.com/docs/connect/destination-charges#refunding-app-fee).
properties:
amount:
description: Amount, in %s.
type: integer
balance_transaction:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/balance_transaction"
description: Balance transaction that describes the impact on your account
balance.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/balance_transaction"
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
fee:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/application_fee"
description: ID of the application fee that was refunded.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/application_fee"
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- fee_refund
type: string
required:
- amount
- created
- currency
- fee
- id
- metadata
- object
title: FeeRefund
type: object
x-expandableFields:
- balance_transaction
- fee
x-resourceId: fee_refund
file:
description: |-
This is an object representing a file hosted on Stripe's servers. The
file may have been uploaded by yourself using the [create file](https://stripe.com/docs/api#create_file)
request (for example, when uploading dispute evidence) or it may have
been created by Stripe (for example, the results of a [Sigma scheduled
query](#scheduled_queries)).
Related guide: [File Upload Guide](https://stripe.com/docs/file-upload).
properties:
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
filename:
description: A filename for the file, suitable for saving to a filesystem.
maxLength: 5000
nullable: true
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
links:
description: A list of [file links](https://stripe.com/docs/api#file_links)
that point at this file.
nullable: true
properties:
data:
description: Details about each object.
items:
"$ref": "#/components/schemas/file_link"
type: array
has_more:
description: True if this list has another page of items after this
one that can be fetched.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value. Always has the value `list`.
enum:
- list
type: string
url:
description: The URL where this list can be accessed.
maxLength: 5000
type: string
required:
- data
- has_more
- object
- url
title: FileFileLinkList
type: object
x-expandableFields:
- data
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- file
type: string
purpose:
description: The purpose of the file. Possible values are `additional_verification`,
`business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`,
`finance_report_run`, `identity_document`, `pci_document`, `sigma_scheduled_query`,
or `tax_document_user_upload`.
maxLength: 5000
type: string
size:
description: The size in bytes of the file object.
type: integer
title:
description: A user friendly title for the document.
maxLength: 5000
nullable: true
type: string
type:
description: The type of the file returned (e.g., `csv`, `pdf`, `jpg`, or
`png`).
maxLength: 5000
nullable: true
type: string
url:
description: The URL from which the file can be downloaded using your live
secret API key.
maxLength: 5000
nullable: true
type: string
required:
- created
- id
- object
- purpose
- size
title: File
type: object
x-expandableFields:
- links
x-resourceId: file
file_link:
description: |-
To share the contents of a `File` object with non-Stripe users, you can
create a `FileLink`. `FileLink`s contain a URL that can be used to
retrieve the contents of the file without authentication.
properties:
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
expired:
description: Whether this link is already expired.
type: boolean
expires_at:
description: Time at which the link expires.
format: unix-time
nullable: true
type: integer
file:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/file"
description: The file object this link points to.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/file"
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- file_link
type: string
url:
description: The publicly accessible URL to download the file.
maxLength: 5000
nullable: true
type: string
required:
- created
- expired
- file
- id
- livemode
- metadata
- object
title: FileLink
type: object
x-expandableFields:
- file
x-resourceId: file_link
financial_reporting_finance_report_run_run_parameters:
description: ''
properties:
columns:
description: The set of output columns requested for inclusion in the report
run.
items:
maxLength: 5000
type: string
type: array
connected_account:
description: Connected account ID by which to filter the report run.
maxLength: 5000
type: string
currency:
description: Currency of objects to be included in the report run.
type: string
interval_end:
description: Ending timestamp of data to be included in the report run (exclusive).
format: unix-time
type: integer
interval_start:
description: Starting timestamp of data to be included in the report run.
format: unix-time
type: integer
payout:
description: Payout ID by which to filter the report run.
maxLength: 5000
type: string
reporting_category:
description: Category of balance transactions to be included in the report
run.
maxLength: 5000
type: string
timezone:
description: 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](http://www.iana.org/time-zones). Has no effect
on `interval_start` or `interval_end`.
maxLength: 5000
type: string
title: FinancialReportingFinanceReportRunRunParameters
type: object
x-expandableFields: []
inventory:
description: ''
properties:
quantity:
description: The count of inventory available. Will be present if and only
if `type` is `finite`.
nullable: true
type: integer
type:
description: Inventory type. Possible values are `finite`, `bucket` (not
quantified), and `infinite`.
maxLength: 5000
type: string
value:
description: An indicator of the inventory available. Possible values are
`in_stock`, `limited`, and `out_of_stock`. Will be present if and only
if `type` is `bucket`.
maxLength: 5000
nullable: true
type: string
required:
- type
title: Inventory
type: object
x-expandableFields: []
invoice:
description: |-
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](https://stripe.com/docs/api#invoiceitems), 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](https://stripe.com/docs/billing/invoices/workflow/#auto_advance), 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](https://dashboard.stripe.com/account/billing/automatic'),
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](/docs/currencies#minimum-and-maximum-charge-amounts), the
invoice is automatically marked paid, and we add the amount due to the
customer's running account balance which is applied to the next invoice.
More details on the customer's account balance are
[here](https://stripe.com/docs/api/customers/object#customer_object-account_balance).
Related guide: [Send Invoices to Customers](https://stripe.com/docs/billing/invoices/sending).
properties:
account_country:
description: The country of the business associated with this invoice, most
often the business creating the invoice.
maxLength: 5000
nullable: true
type: string
account_name:
description: The public name of the business associated with this invoice,
most often the business creating the invoice.
maxLength: 5000
nullable: true
type: string
amount_due:
description: 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_due`
may be 0. If there is a positive `starting_balance` for the invoice (the
customer owes money), the `amount_due` will also take that into account.
The charge that gets generated for the invoice will be for the amount
specified in `amount_due`.
type: integer
amount_paid:
description: The amount, in %s, that was paid.
type: integer
amount_remaining:
description: The amount remaining, in %s, that is due.
type: integer
application_fee_amount:
description: The fee in %s that will be applied to the invoice and transferred
to the application owner's Stripe account when the invoice is paid.
nullable: true
type: integer
attempt_count:
description: 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.
type: integer
attempted:
description: Whether an attempt has been made to pay the invoice. An invoice
is not attempted until 1 hour after the `invoice.created` webhook, for
example, so you might not want to display that invoice as unpaid to your
users.
type: boolean
auto_advance:
description: Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance)
of the invoice. When `false`, the invoice's state will not automatically
advance without an explicit action.
type: boolean
billing_reason:
description: 'Indicates the reason why the invoice was created. `subscription_cycle`
indicates an invoice created by a subscription advancing into a new period.
`subscription_create` indicates an invoice created due to creating a subscription.
`subscription_update` indicates an invoice created due to updating a subscription.
`subscription` is set for all old invoices to indicate either a change
to a subscription or a period advancement. `manual` is set for all invoices
unrelated to a subscription (for example: created via the invoice editor).
The `upcoming` value is reserved for simulated invoices per the upcoming
invoice endpoint. `subscription_threshold` indicates an invoice created
due to a billing threshold being reached.'
enum:
- automatic_pending_invoice_item_invoice
- manual
- subscription
- subscription_create
- subscription_cycle
- subscription_threshold
- subscription_update
- upcoming
nullable: true
type: string
charge:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/charge"
description: ID of the latest charge generated for this invoice, if any.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/charge"
collection_method:
description: Either `charge_automatically`, or `send_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.
enum:
- charge_automatically
- send_invoice
nullable: true
type: string
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
custom_fields:
description: Custom fields displayed on the invoice.
items:
"$ref": "#/components/schemas/invoice_setting_custom_field"
nullable: true
type: array
customer:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/customer"
- "$ref": "#/components/schemas/deleted_customer"
description: The ID of the customer who will be billed.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/customer"
- "$ref": "#/components/schemas/deleted_customer"
customer_address:
anyOf:
- "$ref": "#/components/schemas/address"
description: 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.
nullable: true
customer_email:
description: 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.
maxLength: 5000
nullable: true
type: string
customer_name:
description: 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.
maxLength: 5000
nullable: true
type: string
customer_phone:
description: 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.
maxLength: 5000
nullable: true
type: string
customer_shipping:
anyOf:
- "$ref": "#/components/schemas/shipping"
description: 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.
nullable: true
customer_tax_exempt:
description: 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.
enum:
- exempt
- none
- reverse
nullable: true
type: string
customer_tax_ids:
description: 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.
items:
"$ref": "#/components/schemas/invoices_resource_invoice_tax_id"
nullable: true
type: array
default_payment_method:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/payment_method"
description: 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.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/payment_method"
default_source:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/alipay_account"
- "$ref": "#/components/schemas/bank_account"
- "$ref": "#/components/schemas/bitcoin_receiver"
- "$ref": "#/components/schemas/card"
- "$ref": "#/components/schemas/source"
description: 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.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/alipay_account"
- "$ref": "#/components/schemas/bank_account"
- "$ref": "#/components/schemas/bitcoin_receiver"
- "$ref": "#/components/schemas/card"
- "$ref": "#/components/schemas/source"
default_tax_rates:
description: The tax rates applied to this invoice, if any.
items:
"$ref": "#/components/schemas/tax_rate"
nullable: true
type: array
description:
description: An arbitrary string attached to the object. Often useful for
displaying to users. Referenced as 'memo' in the Dashboard.
maxLength: 5000
nullable: true
type: string
discount:
anyOf:
- "$ref": "#/components/schemas/discount"
description: Describes the current discount applied to this invoice, if
there is one.
nullable: true
due_date:
description: The date on which payment for this invoice is due. This value
will be `null` for invoices where `collection_method=charge_automatically`.
format: unix-time
nullable: true
type: integer
ending_balance:
description: 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.
nullable: true
type: integer
footer:
description: Footer displayed on the invoice.
maxLength: 5000
nullable: true
type: string
hosted_invoice_url:
description: 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.
maxLength: 5000
nullable: true
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
invoice_pdf:
description: The link to download the PDF for the invoice. If the invoice
has not been finalized yet, this will be null.
maxLength: 5000
nullable: true
type: string
lines:
description: 'The individual line items that make up the invoice. `lines`
is sorted as follows: invoice items in reverse chronological order, followed
by the subscription, if any.'
properties:
data:
description: Details about each object.
items:
"$ref": "#/components/schemas/line_item"
type: array
has_more:
description: True if this list has another page of items after this
one that can be fetched.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value. Always has the value `list`.
enum:
- list
type: string
url:
description: The URL where this list can be accessed.
maxLength: 5000
type: string
required:
- data
- has_more
- object
- url
title: InvoiceLinesList
type: object
x-expandableFields:
- data
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
nullable: true
type: object
next_payment_attempt:
description: The time at which payment will next be attempted. This value
will be `null` for invoices where `collection_method=send_invoice`.
format: unix-time
nullable: true
type: integer
number:
description: 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.
maxLength: 5000
nullable: true
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- invoice
type: string
paid:
description: 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.
type: boolean
payment_intent:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/payment_intent"
description: 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.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/payment_intent"
period_end:
description: End of the usage period during which invoice items were added
to this invoice.
format: unix-time
type: integer
period_start:
description: Start of the usage period during which invoice items were added
to this invoice.
format: unix-time
type: integer
post_payment_credit_notes_amount:
description: Total amount of all post-payment credit notes issued for this
invoice.
type: integer
pre_payment_credit_notes_amount:
description: Total amount of all pre-payment credit notes issued for this
invoice.
type: integer
receipt_number:
description: This is the transaction number that appears on email receipts
sent for this invoice.
maxLength: 5000
nullable: true
type: string
starting_balance:
description: Starting customer balance before the invoice is finalized.
If the invoice has not been finalized yet, this will be the current customer
balance.
type: integer
statement_descriptor:
description: Extra information about an invoice for the customer's credit
card statement.
maxLength: 5000
nullable: true
type: string
status:
description: The status of the invoice, one of `draft`, `open`, `paid`,
`uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)
enum:
- deleted
- draft
- open
- paid
- uncollectible
- void
nullable: true
type: string
status_transitions:
"$ref": "#/components/schemas/invoices_status_transitions"
subscription:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/subscription"
description: The subscription that this invoice was prepared for, if any.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/subscription"
subscription_proration_date:
description: Only set for upcoming invoices that preview prorations. The
time used to calculate prorations.
type: integer
subtotal:
description: Total of all subscriptions, invoice items, and prorations on
the invoice before any discount or tax is applied.
type: integer
tax:
description: The amount of tax on this invoice. This is the sum of all the
tax amounts on this invoice.
nullable: true
type: integer
tax_percent:
description: This percentage of the subtotal has been added to the total
amount of the invoice, including invoice line items and discounts. This
field is inherited from the subscription's `tax_percent` field, but can
be changed before the invoice is paid. This field defaults to null.
nullable: true
type: number
threshold_reason:
"$ref": "#/components/schemas/invoice_threshold_reason"
total:
description: Total after discounts and taxes.
type: integer
total_tax_amounts:
description: The aggregate amounts calculated per tax rate for all line
items.
items:
"$ref": "#/components/schemas/invoice_tax_amount"
nullable: true
type: array
transfer_data:
anyOf:
- "$ref": "#/components/schemas/invoice_transfer_data"
description: 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.
nullable: true
webhooks_delivered_at:
description: Invoices are automatically paid or sent 1 hour after webhooks
are delivered, or until all webhook delivery attempts have [been exhausted](https://stripe.com/docs/billing/webhooks#understand).
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.
format: unix-time
nullable: true
type: integer
required:
- amount_due
- amount_paid
- amount_remaining
- attempt_count
- attempted
- created
- currency
- customer
- lines
- livemode
- object
- paid
- period_end
- period_start
- post_payment_credit_notes_amount
- pre_payment_credit_notes_amount
- starting_balance
- status_transitions
- subtotal
- total
title: Invoice
type: object
x-expandableFields:
- charge
- custom_fields
- customer
- customer_address
- customer_shipping
- customer_tax_ids
- default_payment_method
- default_source
- default_tax_rates
- discount
- lines
- payment_intent
- status_transitions
- subscription
- threshold_reason
- total_tax_amounts
- transfer_data
x-resourceId: invoice
invoice_item_threshold_reason:
description: ''
properties:
line_item_ids:
description: The IDs of the line items that triggered the threshold invoice.
items:
maxLength: 5000
type: string
type: array
usage_gte:
description: The quantity threshold boundary that applied to the given line
item.
type: integer
required:
- line_item_ids
- usage_gte
title: InvoiceItemThresholdReason
type: object
x-expandableFields: []
invoice_line_item_period:
description: ''
properties:
end:
description: End of the line item's billing period
type: integer
start:
description: Start of the line item's billing period
type: integer
required:
- end
- start
title: InvoiceLineItemPeriod
type: object
x-expandableFields: []
invoice_setting_custom_field:
description: ''
properties:
name:
description: The name of the custom field.
maxLength: 5000
type: string
value:
description: The value of the custom field.
maxLength: 5000
type: string
required:
- name
- value
title: InvoiceSettingCustomField
type: object
x-expandableFields: []
invoice_setting_customer_setting:
description: ''
properties:
custom_fields:
description: Default custom fields to be displayed on invoices for this
customer.
items:
"$ref": "#/components/schemas/invoice_setting_custom_field"
nullable: true
type: array
default_payment_method:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/payment_method"
description: 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.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/payment_method"
footer:
description: Default footer to be displayed on invoices for this customer.
maxLength: 5000
nullable: true
type: string
title: InvoiceSettingCustomerSetting
type: object
x-expandableFields:
- custom_fields
- default_payment_method
invoice_setting_subscription_schedule_setting:
description: ''
properties:
days_until_due:
description: Number of days within which a customer must pay invoices generated
by this subscription schedule. This value will be `null` for subscription
schedules where `billing=charge_automatically`.
nullable: true
type: integer
title: InvoiceSettingSubscriptionScheduleSetting
type: object
x-expandableFields: []
invoice_tax_amount:
description: ''
properties:
amount:
description: The amount, in %s, of the tax.
type: integer
inclusive:
description: Whether this tax amount is inclusive or exclusive.
type: boolean
tax_rate:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/tax_rate"
description: The tax rate that was applied to get this tax amount.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/tax_rate"
required:
- amount
- inclusive
- tax_rate
title: InvoiceTaxAmount
type: object
x-expandableFields:
- tax_rate
invoice_threshold_reason:
description: ''
properties:
amount_gte:
description: The total invoice amount threshold boundary if it triggered
the threshold invoice.
nullable: true
type: integer
item_reasons:
description: Indicates which line items triggered a threshold invoice.
items:
"$ref": "#/components/schemas/invoice_item_threshold_reason"
type: array
required:
- item_reasons
title: InvoiceThresholdReason
type: object
x-expandableFields:
- item_reasons
invoice_transfer_data:
description: ''
properties:
amount:
description: The amount in %s that will be transferred to the destination
account when the invoice is paid. By default, the entire amount is transferred
to the destination.
nullable: true
type: integer
destination:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/account"
description: The account where funds from the payment will be transferred
to upon payment success.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/account"
required:
- destination
title: InvoiceTransferData
type: object
x-expandableFields:
- destination
invoiceitem:
description: |-
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 guide: [Subscription Invoices](https://stripe.com/docs/billing/invoices/subscription#adding-upcoming-invoice-items).
properties:
amount:
description: Amount (in the `currency` specified) of the invoice item. This
should always be equal to `unit_amount * quantity`.
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
customer:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/customer"
- "$ref": "#/components/schemas/deleted_customer"
description: The ID of the customer who will be billed when this invoice
item is billed.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/customer"
- "$ref": "#/components/schemas/deleted_customer"
date:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
description:
description: An arbitrary string attached to the object. Often useful for
displaying to users.
maxLength: 5000
nullable: true
type: string
discountable:
description: If true, discounts will apply to this invoice item. Always
false for prorations.
type: boolean
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
invoice:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/invoice"
description: The ID of the invoice this invoice item belongs to.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/invoice"
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- invoiceitem
type: string
period:
"$ref": "#/components/schemas/invoice_line_item_period"
plan:
anyOf:
- "$ref": "#/components/schemas/plan"
description: If the invoice item is a proration, the plan of the subscription
that the proration was computed for.
nullable: true
price:
anyOf:
- "$ref": "#/components/schemas/price"
description: The price of the invoice item.
nullable: true
proration:
description: Whether the invoice item was created automatically as a proration
adjustment when the customer switched plans.
type: boolean
quantity:
description: 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.
type: integer
subscription:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/subscription"
description: The subscription that this invoice item has been created for,
if any.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/subscription"
subscription_item:
description: The subscription item that this invoice item has been created
for, if any.
maxLength: 5000
type: string
tax_rates:
description: The tax rates which apply to the invoice item. When set, the
`default_tax_rates` on the invoice do not apply to this invoice item.
items:
"$ref": "#/components/schemas/tax_rate"
nullable: true
type: array
unit_amount:
description: Unit Amount (in the `currency` specified) of the invoice item.
nullable: true
type: integer
unit_amount_decimal:
description: Same as `unit_amount`, but contains a decimal value with at
most 12 decimal places.
format: decimal
nullable: true
type: string
required:
- amount
- currency
- customer
- date
- discountable
- id
- livemode
- metadata
- object
- period
- proration
- quantity
title: InvoiceItem
type: object
x-expandableFields:
- customer
- invoice
- period
- plan
- price
- subscription
- tax_rates
x-resourceId: invoiceitem
invoices_resource_invoice_tax_id:
description: ''
properties:
type:
description: The type of the tax ID, one of `eu_vat`, `br_cnpj`, `br_cpf`,
`nz_gst`, `au_abn`, `in_gst`, `no_vat`, `za_vat`, `ch_vat`, `mx_rfc`,
`sg_uen`, `ru_inn`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`,
`li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `my_sst`, `sg_gst`,
`ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, or `unknown`
enum:
- ae_trn
- au_abn
- br_cnpj
- br_cpf
- ca_bn
- ca_qst
- ch_vat
- cl_tin
- es_cif
- eu_vat
- hk_br
- id_npwp
- in_gst
- jp_cn
- kr_brn
- li_uid
- mx_rfc
- my_frp
- my_itn
- my_sst
- no_vat
- nz_gst
- ru_inn
- sa_vat
- sg_gst
- sg_uen
- th_vat
- tw_vat
- unknown
- us_ein
- za_vat
type: string
value:
description: The value of the tax ID.
maxLength: 5000
nullable: true
type: string
required:
- type
title: InvoicesResourceInvoiceTaxID
type: object
x-expandableFields: []
invoices_status_transitions:
description: ''
properties:
finalized_at:
description: The time that the invoice draft was finalized.
format: unix-time
nullable: true
type: integer
marked_uncollectible_at:
description: The time that the invoice was marked uncollectible.
format: unix-time
nullable: true
type: integer
paid_at:
description: The time that the invoice was paid.
format: unix-time
nullable: true
type: integer
voided_at:
description: The time that the invoice was voided.
format: unix-time
nullable: true
type: integer
title: InvoicesStatusTransitions
type: object
x-expandableFields: []
issuer_fraud_record:
description: |-
This resource has been renamed to [Early Fraud
Warning](#early_fraud_warning_object) and will be removed in a future API
version.
properties:
actionable:
description: An IFR is actionable if it has not received a dispute and has
not been fully refunded. You may wish to proactively refund a charge that
receives an IFR, in order to avoid receiving a dispute later.
type: boolean
charge:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/charge"
description: ID of the charge this issuer fraud record is for, optionally
expanded.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/charge"
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
fraud_type:
description: The type of fraud labelled by the issuer. One of `card_never_received`,
`fraudulent_card_application`, `made_with_counterfeit_card`, `made_with_lost_card`,
`made_with_stolen_card`, `misc`, `unauthorized_use_of_card`.
maxLength: 5000
type: string
has_liability_shift:
description: If true, the associated charge is subject to [liability shift](https://stripe.com/docs/payments/3d-secure#disputed-payments).
type: boolean
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- issuer_fraud_record
type: string
post_date:
description: The timestamp at which the card issuer posted the issuer fraud
record.
type: integer
required:
- actionable
- charge
- created
- fraud_type
- has_liability_shift
- id
- livemode
- object
- post_date
title: IssuerFraudRecord
type: object
x-expandableFields:
- charge
x-resourceId: issuer_fraud_record
issuing.authorization:
description: |-
When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization`
object is created. [Authorizations](https://stripe.com/docs/issuing/purchases/authorizations) must be approved for the
purchase to be completed successfully.
Related guide: [Issued Card Authorizations](https://stripe.com/docs/issuing/purchases/authorizations).
properties:
amount:
description: The total amount that was authorized or rejected. This amount
is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
type: integer
approved:
description: Whether the authorization has been approved.
type: boolean
authorization_method:
description: How the card details were provided.
enum:
- chip
- contactless
- keyed_in
- online
- swipe
type: string
balance_transactions:
description: List of balance transactions associated with this authorization.
items:
"$ref": "#/components/schemas/balance_transaction"
type: array
card:
"$ref": "#/components/schemas/issuing.card"
cardholder:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/issuing.cardholder"
description: The cardholder to whom this authorization belongs.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/issuing.cardholder"
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
merchant_amount:
description: The total amount that was authorized or rejected. This amount
is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
type: integer
merchant_currency:
description: The currency that was presented to the cardholder for the authorization.
Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
merchant_data:
"$ref": "#/components/schemas/issuing_authorization_merchant_data"
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- issuing.authorization
type: string
pending_request:
anyOf:
- "$ref": "#/components/schemas/issuing_authorization_pending_request"
description: The pending authorization request. This field will only be
non-null during an `issuing_authorization.request` webhook.
nullable: true
request_history:
description: History of every time the authorization was approved/denied
(whether approved/denied by you directly or by Stripe based on your `spending_controls`).
If the merchant changes the authorization by performing an [incremental
authorization or partial capture](https://stripe.com/docs/issuing/purchases/authorizations),
you can look at this field to see the previous states of the authorization.
items:
"$ref": "#/components/schemas/issuing_authorization_request"
type: array
status:
description: The current status of the authorization in its lifecycle.
enum:
- closed
- pending
- reversed
type: string
transactions:
description: List of [transactions](https://stripe.com/docs/api/issuing/transactions)
associated with this authorization.
items:
"$ref": "#/components/schemas/issuing.transaction"
type: array
verification_data:
"$ref": "#/components/schemas/issuing_authorization_verification_data"
wallet:
description: What, if any, digital wallet was used for this authorization.
One of `apple_pay`, `google_pay`, or `samsung_pay`.
maxLength: 5000
nullable: true
type: string
required:
- amount
- approved
- authorization_method
- balance_transactions
- card
- created
- currency
- id
- livemode
- merchant_amount
- merchant_currency
- merchant_data
- metadata
- object
- request_history
- status
- transactions
- verification_data
title: IssuingAuthorization
type: object
x-expandableFields:
- balance_transactions
- card
- cardholder
- merchant_data
- pending_request
- request_history
- transactions
- verification_data
x-resourceId: issuing.authorization
issuing.card:
description: You can [create physical or virtual cards](https://stripe.com/docs/issuing/cards)
that are issued to cardholders.
properties:
brand:
description: The brand of the card.
maxLength: 5000
type: string
cancellation_reason:
description: The reason why the card was canceled.
enum:
- lost
- stolen
nullable: true
type: string
cardholder:
"$ref": "#/components/schemas/issuing.cardholder"
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
cvc:
description: The card's CVC. For security reasons, this is only available
for virtual cards, and will be omitted unless you explicitly request it
with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects).
Additionally, it's only available via the ["Retrieve a card" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve),
not via "List all cards" or any other endpoint.
maxLength: 5000
type: string
exp_month:
description: The expiration month of the card.
type: integer
exp_year:
description: The expiration year of the card.
type: integer
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
last4:
description: The last 4 digits of the card number.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
number:
description: The full unredacted card number. For security reasons, this
is only available for virtual cards, and will be omitted unless you explicitly
request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects).
Additionally, it's only available via the ["Retrieve a card" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve),
not via "List all cards" or any other endpoint.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- issuing.card
type: string
replaced_by:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/issuing.card"
description: The latest card that replaces this card, if any.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/issuing.card"
replacement_for:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/issuing.card"
description: The card this card replaces, if any.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/issuing.card"
replacement_reason:
description: The reason why the previous card needed to be replaced.
enum:
- damaged
- expired
- lost
- stolen
nullable: true
type: string
x-stripeBypassValidation: true
shipping:
anyOf:
- "$ref": "#/components/schemas/issuing_card_shipping"
description: Where and how the card will be shipped.
nullable: true
spending_controls:
"$ref": "#/components/schemas/issuing_card_authorization_controls"
status:
description: Whether authorizations can be approved on this card.
enum:
- active
- canceled
- inactive
type: string
x-stripeBypassValidation: true
type:
description: The type of the card.
enum:
- physical
- virtual
type: string
required:
- brand
- cardholder
- created
- currency
- exp_month
- exp_year
- id
- last4
- livemode
- metadata
- object
- spending_controls
- status
- type
title: IssuingCard
type: object
x-expandableFields:
- cardholder
- replaced_by
- replacement_for
- shipping
- spending_controls
x-resourceId: issuing.card
issuing.cardholder:
description: |-
An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/docs/issuing) cards.
Related guide: [How to create a Cardholder](https://stripe.com/docs/issuing/cards#create-cardholder)
properties:
billing:
"$ref": "#/components/schemas/issuing_cardholder_address"
company:
anyOf:
- "$ref": "#/components/schemas/issuing_cardholder_company"
description: Additional information about a `company` cardholder.
nullable: true
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
email:
description: The cardholder's email address.
maxLength: 5000
nullable: true
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
individual:
anyOf:
- "$ref": "#/components/schemas/issuing_cardholder_individual"
description: Additional information about an `individual` cardholder.
nullable: true
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
name:
description: The cardholder's name. This will be printed on cards issued
to them.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- issuing.cardholder
type: string
phone_number:
description: The cardholder's phone number.
maxLength: 5000
nullable: true
type: string
requirements:
"$ref": "#/components/schemas/issuing_cardholder_requirements"
spending_controls:
anyOf:
- "$ref": "#/components/schemas/issuing_cardholder_authorization_controls"
description: Spending rules that give you some control over how this cardholder's
cards can be used. Refer to our [authorizations](https://stripe.com/docs/issuing/purchases/authorizations)
documentation for more details.
nullable: true
status:
description: Specifies whether to permit authorizations on this cardholder's
cards.
enum:
- active
- blocked
- inactive
type: string
type:
description: One of `individual` or `company`.
enum:
- company
- individual
type: string
x-stripeBypassValidation: true
required:
- billing
- created
- id
- livemode
- metadata
- name
- object
- requirements
- status
- type
title: IssuingCardholder
type: object
x-expandableFields:
- billing
- company
- individual
- requirements
- spending_controls
x-resourceId: issuing.cardholder
issuing.dispute:
description: |-
As a [card issuer](https://stripe.com/docs/issuing), you can [dispute](https://stripe.com/docs/issuing/purchases/disputes) transactions that you do not recognize, suspect to be fraudulent, or have some other issue.
Related guide: [Disputing Transactions](https://stripe.com/docs/issuing/purchases/disputes)
properties:
balance_transactions:
description: List of balance transactions associated with this dispute.
items:
"$ref": "#/components/schemas/balance_transaction"
type: array
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- issuing.dispute
type: string
required:
- balance_transactions
- id
- livemode
- object
title: IssuingDispute
type: object
x-expandableFields:
- balance_transactions
x-resourceId: issuing.dispute
issuing.settlement:
description: When a non-stripe BIN is used, any use of an [issued card](https://stripe.com/docs/issuing)
must be settled directly with the card network. The net amount owed is represented
by an Issuing `Settlement` object.
properties:
bin:
description: The Bank Identification Number reflecting this settlement record.
maxLength: 5000
type: string
clearing_date:
description: The date that the transactions are cleared and posted to user's
accounts.
type: integer
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
interchange_fees:
description: The total interchange received as reimbursement for the transactions.
type: integer
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
net_total:
description: The total net amount required to settle with the network.
type: integer
network:
description: The card network for this settlement report. One of ["visa"]
enum:
- visa
type: string
network_fees:
description: The total amount of fees owed to the network.
type: integer
network_settlement_identifier:
description: The Settlement Identification Number assigned by the network.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- issuing.settlement
type: string
settlement_service:
description: One of `international` or `uk_national_net`.
maxLength: 5000
type: string
transaction_count:
description: The total number of transactions reflected in this settlement.
type: integer
transaction_volume:
description: The total transaction amount reflected in this settlement.
type: integer
required:
- bin
- clearing_date
- created
- currency
- id
- interchange_fees
- livemode
- metadata
- net_total
- network
- network_fees
- network_settlement_identifier
- object
- settlement_service
- transaction_count
- transaction_volume
title: IssuingSettlement
type: object
x-expandableFields: []
x-resourceId: issuing.settlement
issuing.transaction:
description: |-
Any use of an [issued card](https://stripe.com/docs/issuing) that results in funds entering or leaving
your Stripe account, such as a completed purchase or refund, is represented by an Issuing
`Transaction` object.
Related guide: [Issued Card Transactions](https://stripe.com/docs/issuing/purchases/transactions).
properties:
amount:
description: The transaction amount, which will be reflected in your balance.
This amount is in your currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
type: integer
authorization:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/issuing.authorization"
description: The `Authorization` object that led to this transaction.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/issuing.authorization"
balance_transaction:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/balance_transaction"
description: ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions)
associated with this transaction.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/balance_transaction"
card:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/issuing.card"
description: The card used to make this transaction.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/issuing.card"
cardholder:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/issuing.cardholder"
description: The cardholder to whom this transaction belongs.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/issuing.cardholder"
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
merchant_amount:
description: The amount that the merchant will receive, denominated in `merchant_currency`
and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
It will be different from `amount` if the merchant is taking payment in
a different currency.
type: integer
merchant_currency:
description: The currency with which the merchant is taking payment.
type: string
merchant_data:
"$ref": "#/components/schemas/issuing_authorization_merchant_data"
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- issuing.transaction
type: string
purchase_details:
anyOf:
- "$ref": "#/components/schemas/issuing_transaction_purchase_details"
description: Additional purchase information that is optionally provided
by the merchant.
nullable: true
type:
description: The nature of the transaction.
enum:
- capture
- refund
type: string
x-stripeBypassValidation: true
required:
- amount
- card
- created
- currency
- id
- livemode
- merchant_amount
- merchant_currency
- merchant_data
- metadata
- object
- type
title: IssuingTransaction
type: object
x-expandableFields:
- authorization
- balance_transaction
- card
- cardholder
- merchant_data
- purchase_details
x-resourceId: issuing.transaction
issuing_authorization_merchant_data:
description: ''
properties:
category:
description: A categorization of the seller's type of business. See our
[merchant categories guide](https://stripe.com/docs/issuing/merchant-categories)
for a list of possible values.
maxLength: 5000
type: string
city:
description: City where the seller is located
maxLength: 5000
nullable: true
type: string
country:
description: Country where the seller is located
maxLength: 5000
nullable: true
type: string
name:
description: Name of the seller
maxLength: 5000
nullable: true
type: string
network_id:
description: Identifier assigned to the seller by the card brand
maxLength: 5000
type: string
postal_code:
description: Postal code where the seller is located
maxLength: 5000
nullable: true
type: string
state:
description: State where the seller is located
maxLength: 5000
nullable: true
type: string
required:
- category
- network_id
title: IssuingAuthorizationMerchantData
type: object
x-expandableFields: []
issuing_authorization_pending_request:
description: ''
properties:
amount:
description: The additional amount Stripe will hold if the authorization
is approved, in the card's [currency](https://stripe.com/docs/api#issuing_authorization_object-pending-request-currency)
and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
is_amount_controllable:
description: If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount)
to control how much to hold for the authorization.
type: boolean
merchant_amount:
description: The amount the merchant is requesting to be authorized in the
`merchant_currency`. The amount is in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
type: integer
merchant_currency:
description: The local currency the merchant is requesting to authorize.
type: string
required:
- amount
- currency
- is_amount_controllable
- merchant_amount
- merchant_currency
title: IssuingAuthorizationPendingRequest
type: object
x-expandableFields: []
issuing_authorization_request:
description: ''
properties:
amount:
description: The authorization amount in your card's currency and in the
[smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
Stripe held this amount from your account to fund the authorization if
the request was approved.
type: integer
approved:
description: Whether this request was approved.
type: boolean
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
maxLength: 5000
type: string
merchant_amount:
description: The amount that was authorized at the time of this request.
This amount is in the `merchant_currency` and in the [smallest currency
unit](https://stripe.com/docs/currencies#zero-decimal).
type: integer
merchant_currency:
description: The currency that was collected by the merchant and presented
to the cardholder for the authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
maxLength: 5000
type: string
reason:
description: The reason for the approval or decline.
enum:
- account_disabled
- card_active
- card_inactive
- cardholder_inactive
- cardholder_verification_required
- insufficient_funds
- not_allowed
- spending_controls
- suspected_fraud
- verification_failed
- webhook_approved
- webhook_declined
- webhook_timeout
type: string
x-stripeBypassValidation: true
required:
- amount
- approved
- created
- currency
- merchant_amount
- merchant_currency
- reason
title: IssuingAuthorizationRequest
type: object
x-expandableFields: []
issuing_authorization_verification_data:
description: ''
properties:
address_line1_check:
description: Whether the cardholder provided an address first line and if
it matched the cardholder’s `billing.address.line1`.
enum:
- match
- mismatch
- not_provided
type: string
address_postal_code_check:
description: Whether the cardholder provided a postal code and if it matched
the cardholder’s `billing.address.postal_code`.
enum:
- match
- mismatch
- not_provided
type: string
cvc_check:
description: Whether the cardholder provided a CVC and if it matched Stripe’s
record.
enum:
- match
- mismatch
- not_provided
type: string
expiry_check:
description: Whether the cardholder provided an expiry date and if it matched
Stripe’s record.
enum:
- match
- mismatch
- not_provided
type: string
required:
- address_line1_check
- address_postal_code_check
- cvc_check
- expiry_check
title: IssuingAuthorizationVerificationData
type: object
x-expandableFields: []
issuing_card_authorization_controls:
description: ''
properties:
allowed_categories:
description: Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category)
of authorizations permitted on this card.
items:
enum:
- 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
- electrical_parts_and_equipment
- electrical_services
- electronics_repair_shops
- electronics_stores
- elementary_secondary_schools
- 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_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
- 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
type: string
nullable: true
type: array
blocked_categories:
description: Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category)
of authorizations to always decline on this card.
items:
enum:
- 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
- electrical_parts_and_equipment
- electrical_services
- electronics_repair_shops
- electronics_stores
- elementary_secondary_schools
- 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_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
- 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
type: string
nullable: true
type: array
spending_limits:
description: Limit the spending with rules based on time intervals and categories.
items:
"$ref": "#/components/schemas/issuing_card_spending_limit"
nullable: true
type: array
spending_limits_currency:
description: Currency for the amounts within spending_limits. Locked to
the currency of the card.
nullable: true
type: string
title: IssuingCardAuthorizationControls
type: object
x-expandableFields:
- spending_limits
issuing_card_shipping:
description: ''
properties:
address:
"$ref": "#/components/schemas/address"
carrier:
description: The delivery company that shipped a card.
enum:
- fedex
- usps
nullable: true
type: string
eta:
description: A unix timestamp representing a best estimate of when the card
will be delivered.
format: unix-time
nullable: true
type: integer
name:
description: Recipient name.
maxLength: 5000
type: string
service:
description: Shipment service, such as `standard` or `express`.
enum:
- express
- priority
- standard
type: string
x-stripeBypassValidation: true
status:
description: The delivery status of the card.
enum:
- canceled
- delivered
- failure
- pending
- returned
- shipped
nullable: true
type: string
tracking_number:
description: A tracking number for a card shipment.
maxLength: 5000
nullable: true
type: string
tracking_url:
description: A link to the shipping carrier's site where you can view detailed
information about a card shipment.
maxLength: 5000
nullable: true
type: string
type:
description: Packaging options.
enum:
- bulk
- individual
type: string
required:
- address
- name
- service
- type
title: IssuingCardShipping
type: object
x-expandableFields:
- address
issuing_card_spending_limit:
description: ''
properties:
amount:
description: Maximum amount allowed to spend per time interval.
type: integer
categories:
description: Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category)
on which to apply the spending limit. Leave this blank to limit all charges.
items:
enum:
- 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
- electrical_parts_and_equipment
- electrical_services
- electronics_repair_shops
- electronics_stores
- elementary_secondary_schools
- 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_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
- 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
type: string
nullable: true
type: array
interval:
description: The time interval or event with which to apply this spending
limit towards.
enum:
- all_time
- daily
- monthly
- per_authorization
- weekly
- yearly
type: string
required:
- amount
- interval
title: IssuingCardSpendingLimit
type: object
x-expandableFields: []
issuing_cardholder_address:
description: ''
properties:
address:
"$ref": "#/components/schemas/address"
required:
- address
title: IssuingCardholderAddress
type: object
x-expandableFields:
- address
issuing_cardholder_authorization_controls:
description: ''
properties:
allowed_categories:
description: Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category)
of authorizations permitted on this cardholder's cards.
items:
enum:
- 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
- electrical_parts_and_equipment
- electrical_services
- electronics_repair_shops
- electronics_stores
- elementary_secondary_schools
- 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_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
- 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
type: string
nullable: true
type: array
blocked_categories:
description: Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category)
of authorizations to always decline on this cardholder's cards.
items:
enum:
- 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
- electrical_parts_and_equipment
- electrical_services
- electronics_repair_shops
- electronics_stores
- elementary_secondary_schools
- 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_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
- 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
type: string
nullable: true
type: array
spending_limits:
description: Limit the spending with rules based on time intervals and categories.
items:
"$ref": "#/components/schemas/issuing_cardholder_spending_limit"
nullable: true
type: array
spending_limits_currency:
description: Currency for the amounts within spending_limits.
nullable: true
type: string
title: IssuingCardholderAuthorizationControls
type: object
x-expandableFields:
- spending_limits
issuing_cardholder_company:
description: ''
properties:
tax_id_provided:
description: Whether the company's business ID number was provided.
type: boolean
required:
- tax_id_provided
title: IssuingCardholderCompany
type: object
x-expandableFields: []
issuing_cardholder_id_document:
description: ''
properties:
back:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/file"
description: The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file)
with a `purpose` value of `identity_document`.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/file"
front:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/file"
description: The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file)
with a `purpose` value of `identity_document`.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/file"
title: IssuingCardholderIdDocument
type: object
x-expandableFields:
- back
- front
issuing_cardholder_individual:
description: ''
properties:
dob:
anyOf:
- "$ref": "#/components/schemas/issuing_cardholder_individual_dob"
description: The date of birth of this cardholder.
nullable: true
first_name:
description: The first name of this cardholder.
maxLength: 5000
type: string
last_name:
description: The last name of this cardholder.
maxLength: 5000
type: string
verification:
anyOf:
- "$ref": "#/components/schemas/issuing_cardholder_verification"
description: Government-issued ID document for this cardholder.
nullable: true
required:
- first_name
- last_name
title: IssuingCardholderIndividual
type: object
x-expandableFields:
- dob
- verification
issuing_cardholder_individual_dob:
description: ''
properties:
day:
description: The day of birth, between 1 and 31.
nullable: true
type: integer
month:
description: The month of birth, between 1 and 12.
nullable: true
type: integer
year:
description: The four-digit year of birth.
nullable: true
type: integer
title: IssuingCardholderIndividualDOB
type: object
x-expandableFields: []
issuing_cardholder_requirements:
description: ''
properties:
disabled_reason:
description: If `disabled_reason` is present, all cards will decline authorizations
with `cardholder_verification_required` reason.
enum:
- listed
- rejected.listed
- under_review
nullable: true
type: string
past_due:
description: Array of fields that need to be collected in order to verify
and re-enable the cardholder.
items:
enum:
- company.tax_id
- individual.dob.day
- individual.dob.month
- individual.dob.year
- individual.first_name
- individual.last_name
- individual.verification.document
type: string
x-stripeBypassValidation: true
nullable: true
type: array
title: IssuingCardholderRequirements
type: object
x-expandableFields: []
issuing_cardholder_spending_limit:
description: ''
properties:
amount:
description: Maximum amount allowed to spend per time interval.
type: integer
categories:
description: Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category)
on which to apply the spending limit. Leave this blank to limit all charges.
items:
enum:
- 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
- electrical_parts_and_equipment
- electrical_services
- electronics_repair_shops
- electronics_stores
- elementary_secondary_schools
- 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_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
- 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
type: string
nullable: true
type: array
interval:
description: The time interval or event with which to apply this spending
limit towards.
enum:
- all_time
- daily
- monthly
- per_authorization
- weekly
- yearly
type: string
required:
- amount
- interval
title: IssuingCardholderSpendingLimit
type: object
x-expandableFields: []
issuing_cardholder_verification:
description: ''
properties:
document:
anyOf:
- "$ref": "#/components/schemas/issuing_cardholder_id_document"
description: An identifying document, either a passport or local ID card.
nullable: true
title: IssuingCardholderVerification
type: object
x-expandableFields:
- document
issuing_transaction_flight_data:
description: ''
properties:
departure_at:
description: The time that the flight departed.
nullable: true
type: integer
passenger_name:
description: The name of the passenger.
maxLength: 5000
nullable: true
type: string
refundable:
description: Whether the ticket is refundable.
nullable: true
type: boolean
segments:
description: The legs of the trip.
items:
"$ref": "#/components/schemas/issuing_transaction_flight_data_leg"
nullable: true
type: array
travel_agency:
description: The travel agency that issued the ticket.
maxLength: 5000
nullable: true
type: string
title: IssuingTransactionFlightData
type: object
x-expandableFields:
- segments
issuing_transaction_flight_data_leg:
description: ''
properties:
arrival_airport_code:
description: The three-letter IATA airport code of the flight's destination.
maxLength: 5000
nullable: true
type: string
carrier:
description: The airline carrier code.
maxLength: 5000
nullable: true
type: string
departure_airport_code:
description: The three-letter IATA airport code that the flight departed
from.
maxLength: 5000
nullable: true
type: string
flight_number:
description: The flight number.
maxLength: 5000
nullable: true
type: string
service_class:
description: The flight's service class.
maxLength: 5000
nullable: true
type: string
stopover_allowed:
description: Whether a stopover is allowed on this flight.
nullable: true
type: boolean
title: IssuingTransactionFlightDataLeg
type: object
x-expandableFields: []
issuing_transaction_fuel_data:
description: ''
properties:
type:
description: The type of fuel that was purchased. One of `diesel`, `unleaded_plus`,
`unleaded_regular`, `unleaded_super`, or `other`.
maxLength: 5000
type: string
unit:
description: The units for `volume`. One of `us_gallon` or `liter`.
maxLength: 5000
type: string
unit_cost_decimal:
description: The cost in cents per each unit of fuel, represented as a decimal
string with at most 12 decimal places.
format: decimal
type: string
volume_decimal:
description: The volume of the fuel that was pumped, represented as a decimal
string with at most 12 decimal places.
format: decimal
nullable: true
type: string
required:
- type
- unit
- unit_cost_decimal
title: IssuingTransactionFuelData
type: object
x-expandableFields: []
issuing_transaction_lodging_data:
description: ''
properties:
check_in_at:
description: The time of checking into the lodging.
nullable: true
type: integer
nights:
description: The number of nights stayed at the lodging.
nullable: true
type: integer
title: IssuingTransactionLodgingData
type: object
x-expandableFields: []
issuing_transaction_purchase_details:
description: ''
properties:
flight:
anyOf:
- "$ref": "#/components/schemas/issuing_transaction_flight_data"
description: Information about the flight that was purchased with this transaction.
nullable: true
fuel:
anyOf:
- "$ref": "#/components/schemas/issuing_transaction_fuel_data"
description: Information about fuel that was purchased with this transaction.
nullable: true
lodging:
anyOf:
- "$ref": "#/components/schemas/issuing_transaction_lodging_data"
description: Information about lodging that was purchased with this transaction.
nullable: true
receipt:
description: The line items in the purchase.
items:
"$ref": "#/components/schemas/issuing_transaction_receipt_data"
nullable: true
type: array
reference:
description: A merchant-specific order number.
maxLength: 5000
nullable: true
type: string
title: IssuingTransactionPurchaseDetails
type: object
x-expandableFields:
- flight
- fuel
- lodging
- receipt
issuing_transaction_receipt_data:
description: ''
properties:
description:
description: The description of the item. The maximum length of this field
is 26 characters.
maxLength: 5000
nullable: true
type: string
quantity:
description: The quantity of the item.
nullable: true
type: number
total:
description: The total for this line item in cents.
nullable: true
type: integer
unit_cost:
description: The unit cost of the item in cents.
nullable: true
type: integer
title: IssuingTransactionReceiptData
type: object
x-expandableFields: []
item:
description: Checkout Session line item.
properties:
amount_subtotal:
description: Total before any discounts or taxes is applied.
nullable: true
type: integer
amount_total:
description: Total after discounts and taxes.
nullable: true
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
description:
description: An arbitrary string attached to the object. Often useful for
displaying to users. Defaults to product name.
maxLength: 5000
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- item
type: string
price:
"$ref": "#/components/schemas/price"
quantity:
description: The quantity of products being purchased.
nullable: true
type: integer
taxes:
description: The taxes applied to the line item.
items:
"$ref": "#/components/schemas/payment_pages_checkout_session_line_item_resource_line_item_tax"
type: array
required:
- currency
- description
- id
- object
- price
title: PaymentPagesCheckoutSessionLineItem
type: object
x-expandableFields:
- price
- taxes
x-resourceId: item
legal_entity_company:
description: ''
properties:
address:
"$ref": "#/components/schemas/address"
address_kana:
anyOf:
- "$ref": "#/components/schemas/legal_entity_japan_address"
description: The Kana variation of the company's primary address (Japan
only).
nullable: true
address_kanji:
anyOf:
- "$ref": "#/components/schemas/legal_entity_japan_address"
description: The Kanji variation of the company's primary address (Japan
only).
nullable: true
directors_provided:
description: Whether the company's directors have been provided. This Boolean
will be `true` if you've manually indicated that all directors are provided
via [the `directors_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-directors_provided).
type: boolean
executives_provided:
description: Whether the company's executives have been provided. This Boolean
will be `true` if you've manually indicated that all executives are provided
via [the `executives_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-executives_provided),
or if Stripe determined that sufficient executives were provided.
type: boolean
name:
description: The company's legal name.
maxLength: 5000
nullable: true
type: string
name_kana:
description: The Kana variation of the company's legal name (Japan only).
maxLength: 5000
nullable: true
type: string
name_kanji:
description: The Kanji variation of the company's legal name (Japan only).
maxLength: 5000
nullable: true
type: string
owners_provided:
description: Whether the company's owners have been provided. This Boolean
will be `true` if you've manually indicated that all owners are provided
via [the `owners_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-owners_provided),
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 the `percent_ownership`
of each owner together).
type: boolean
phone:
description: The company's phone number (used for verification).
maxLength: 5000
nullable: true
type: string
structure:
description: The category identifying the legal structure of the company
or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure)
for more details.
enum:
- government_instrumentality
- governmental_unit
- incorporated_non_profit
- limited_liability_partnership
- multi_member_llc
- private_company
- private_corporation
- private_partnership
- public_company
- public_corporation
- public_partnership
- sole_proprietorship
- tax_exempt_government_instrumentality
- unincorporated_association
- unincorporated_non_profit
type: string
x-stripeBypassValidation: true
tax_id_provided:
description: Whether the company's business ID number was provided.
type: boolean
tax_id_registrar:
description: The jurisdiction in which the `tax_id` is registered (Germany-based
companies only).
maxLength: 5000
type: string
vat_id_provided:
description: Whether the company's business VAT number was provided.
type: boolean
verification:
anyOf:
- "$ref": "#/components/schemas/legal_entity_company_verification"
description: Information on the verification state of the company.
nullable: true
title: LegalEntityCompany
type: object
x-expandableFields:
- address
- address_kana
- address_kanji
- verification
legal_entity_company_verification:
description: ''
properties:
document:
"$ref": "#/components/schemas/legal_entity_company_verification_document"
required:
- document
title: LegalEntityCompanyVerification
type: object
x-expandableFields:
- document
legal_entity_company_verification_document:
description: ''
properties:
back:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/file"
description: The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file)
with a `purpose` value of `additional_verification`.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/file"
details:
description: A user-displayable string describing the verification state
of this document.
maxLength: 5000
nullable: true
type: string
details_code:
description: 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`,
or `document_too_large`. A machine-readable code specifying the verification
state for this document.
maxLength: 5000
nullable: true
type: string
front:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/file"
description: The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file)
with a `purpose` value of `additional_verification`.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/file"
title: LegalEntityCompanyVerificationDocument
type: object
x-expandableFields:
- back
- front
legal_entity_dob:
description: ''
properties:
day:
description: The day of birth, between 1 and 31.
nullable: true
type: integer
month:
description: The month of birth, between 1 and 12.
nullable: true
type: integer
year:
description: The four-digit year of birth.
nullable: true
type: integer
title: LegalEntityDOB
type: object
x-expandableFields: []
legal_entity_japan_address:
description: ''
properties:
city:
description: City/Ward.
maxLength: 5000
nullable: true
type: string
country:
description: Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
maxLength: 5000
nullable: true
type: string
line1:
description: Block/Building number.
maxLength: 5000
nullable: true
type: string
line2:
description: Building details.
maxLength: 5000
nullable: true
type: string
postal_code:
description: ZIP or postal code.
maxLength: 5000
nullable: true
type: string
state:
description: Prefecture.
maxLength: 5000
nullable: true
type: string
town:
description: Town/cho-me.
maxLength: 5000
nullable: true
type: string
title: LegalEntityJapanAddress
type: object
x-expandableFields: []
legal_entity_person_verification:
description: ''
properties:
additional_document:
anyOf:
- "$ref": "#/components/schemas/legal_entity_person_verification_document"
description: A document showing address, either a passport, local ID card,
or utility bill from a well-known utility company.
nullable: true
details:
description: A user-displayable string describing the verification state
for the person. For example, this may say "Provided identity information
could not be verified".
maxLength: 5000
nullable: true
type: string
details_code:
description: One of `document_address_mismatch`, `document_dob_mismatch`,
`document_duplicate_type`, `document_id_number_mismatch`, `document_name_mismatch`,
`document_nationality_mismatch`, `failed_keyed_identity`, or `failed_other`.
A machine-readable code specifying the verification state for the person.
maxLength: 5000
nullable: true
type: string
document:
"$ref": "#/components/schemas/legal_entity_person_verification_document"
status:
description: The state of verification for the person. Possible values are
`unverified`, `pending`, or `verified`.
maxLength: 5000
type: string
required:
- status
title: LegalEntityPersonVerification
type: object
x-expandableFields:
- additional_document
- document
legal_entity_person_verification_document:
description: ''
properties:
back:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/file"
description: The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file)
with a `purpose` value of `identity_document`.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/file"
details:
description: 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".
maxLength: 5000
nullable: true
type: string
details_code:
description: 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`, or `document_type_not_supported`. A machine-readable
code specifying the verification state for this document.
maxLength: 5000
nullable: true
type: string
front:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/file"
description: The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file)
with a `purpose` value of `identity_document`.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/file"
title: LegalEntityPersonVerificationDocument
type: object
x-expandableFields:
- back
- front
light_account_logout:
description: ''
properties: {}
title: LightAccountLogout
type: object
x-expandableFields: []
x-resourceId: light_account_logout
line_item:
description: ''
properties:
amount:
description: The amount, in %s.
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
description:
description: An arbitrary string attached to the object. Often useful for
displaying to users.
maxLength: 5000
nullable: true
type: string
discountable:
description: If true, discounts will apply to this line item. Always false
for prorations.
type: boolean
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
invoice_item:
description: The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems)
associated with this line item if any.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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` this
will reflect the metadata of the subscription that caused the line item
to be created.
type: object
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- line_item
type: string
period:
"$ref": "#/components/schemas/invoice_line_item_period"
plan:
anyOf:
- "$ref": "#/components/schemas/plan"
description: The plan of the subscription, if the line item is a subscription
or a proration.
nullable: true
price:
anyOf:
- "$ref": "#/components/schemas/price"
description: The price of the line item.
nullable: true
proration:
description: Whether this is a proration.
type: boolean
quantity:
description: The quantity of the subscription, if the line item is a subscription
or a proration.
nullable: true
type: integer
subscription:
description: The subscription that the invoice item pertains to, if any.
maxLength: 5000
nullable: true
type: string
subscription_item:
description: The subscription item that generated this invoice item. Left
empty if the line item is not an explicit result of a subscription.
maxLength: 5000
type: string
tax_amounts:
description: The amount of tax calculated per tax rate for this line item
items:
"$ref": "#/components/schemas/invoice_tax_amount"
nullable: true
type: array
tax_rates:
description: The tax rates which apply to the line item.
items:
"$ref": "#/components/schemas/tax_rate"
nullable: true
type: array
type:
description: A string identifying the type of the source of this line item,
either an `invoiceitem` or a `subscription`.
enum:
- invoiceitem
- subscription
type: string
required:
- amount
- currency
- discountable
- id
- livemode
- metadata
- object
- period
- proration
- type
title: InvoiceLineItem
type: object
x-expandableFields:
- period
- plan
- price
- tax_amounts
- tax_rates
x-resourceId: line_item
login_link:
description: ''
properties:
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- login_link
type: string
url:
description: The URL for the login link.
maxLength: 5000
type: string
required:
- created
- object
- url
title: LoginLink
type: object
x-expandableFields: []
x-resourceId: login_link
mandate:
description: A Mandate is a record of the permission a customer has given you
to debit their payment method.
properties:
customer_acceptance:
"$ref": "#/components/schemas/customer_acceptance"
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
multi_use:
"$ref": "#/components/schemas/mandate_multi_use"
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- mandate
type: string
payment_method:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/payment_method"
description: ID of the payment method associated with this mandate.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/payment_method"
payment_method_details:
"$ref": "#/components/schemas/mandate_payment_method_details"
single_use:
"$ref": "#/components/schemas/mandate_single_use"
status:
description: The status of the mandate, which indicates whether it can be
used to initiate a payment.
enum:
- active
- inactive
- pending
type: string
type:
description: The type of the mandate.
enum:
- multi_use
- single_use
type: string
required:
- customer_acceptance
- id
- livemode
- object
- payment_method
- payment_method_details
- status
- type
title: Mandate
type: object
x-expandableFields:
- customer_acceptance
- multi_use
- payment_method
- payment_method_details
- single_use
x-resourceId: mandate
mandate_au_becs_debit:
description: ''
properties:
url:
description: The URL of the mandate. This URL generally contains sensitive
information about the customer and should be shared with them exclusively.
maxLength: 5000
type: string
required:
- url
title: mandate_au_becs_debit
type: object
x-expandableFields: []
mandate_bacs_debit:
description: ''
properties:
network_status:
description: The status of the mandate on the Bacs network. Can be one of
`pending`, `revoked`, `refused`, or `accepted`.
enum:
- accepted
- pending
- refused
- revoked
type: string
reference:
description: The unique reference identifying the mandate on the Bacs network.
maxLength: 5000
type: string
url:
description: The URL that will contain the mandate that the customer has
signed.
maxLength: 5000
type: string
required:
- network_status
- reference
- url
title: mandate_bacs_debit
type: object
x-expandableFields: []
mandate_multi_use:
description: ''
properties: {}
title: mandate_multi_use
type: object
x-expandableFields: []
mandate_payment_method_details:
description: ''
properties:
au_becs_debit:
"$ref": "#/components/schemas/mandate_au_becs_debit"
bacs_debit:
"$ref": "#/components/schemas/mandate_bacs_debit"
card:
"$ref": "#/components/schemas/card_mandate_payment_method_details"
sepa_debit:
"$ref": "#/components/schemas/mandate_sepa_debit"
type:
description: The type of the payment method associated with this mandate.
An additional hash is included on `payment_method_details` with a name
matching this value. It contains mandate information specific to the payment
method.
maxLength: 5000
type: string
required:
- type
title: mandate_payment_method_details
type: object
x-expandableFields:
- au_becs_debit
- bacs_debit
- card
- sepa_debit
mandate_sepa_debit:
description: ''
properties:
reference:
description: The unique reference of the mandate.
maxLength: 5000
type: string
url:
description: The URL of the mandate. This URL generally contains sensitive
information about the customer and should be shared with them exclusively.
maxLength: 5000
type: string
required:
- reference
- url
title: mandate_sepa_debit
type: object
x-expandableFields: []
mandate_single_use:
description: ''
properties:
amount:
description: On a single use mandate, the amount of the payment.
type: integer
currency:
description: On a single use mandate, the currency of the payment.
type: string
required:
- amount
- currency
title: mandate_single_use
type: object
x-expandableFields: []
networks:
description: ''
properties:
available:
description: All available networks for the card.
items:
maxLength: 5000
type: string
type: array
preferred:
description: The preferred network for the card.
maxLength: 5000
nullable: true
type: string
required:
- available
title: networks
type: object
x-expandableFields: []
notification_event_data:
description: ''
properties:
object:
description: Object containing the API resource relevant to the event. For
example, an `invoice.created` event will have a full [invoice object](https://stripe.com/docs/api#invoice_object)
as the value of the object key.
type: object
previous_attributes:
description: Object containing the names of the attributes that have changed,
and their previous values (sent along only with *.updated events).
type: object
required:
- object
title: NotificationEventData
type: object
x-expandableFields: []
notification_event_request:
description: ''
properties:
id:
description: ID of the API request that caused the event. If null, the event
was automatic (e.g., Stripe's automatic subscription handling). Request
logs are available in the [dashboard](https://dashboard.stripe.com/logs),
but currently not in the API.
maxLength: 5000
nullable: true
type: string
idempotency_key:
description: 'The idempotency key transmitted during the request, if any.
*Note: This property is populated only for events on or after May 23,
2017*.'
maxLength: 5000
nullable: true
type: string
title: NotificationEventRequest
type: object
x-expandableFields: []
offline_acceptance:
description: ''
properties: {}
title: offline_acceptance
type: object
x-expandableFields: []
online_acceptance:
description: ''
properties:
ip_address:
description: The IP address from which the Mandate was accepted by the customer.
maxLength: 5000
nullable: true
type: string
user_agent:
description: The user agent of the browser from which the Mandate was accepted
by the customer.
maxLength: 5000
nullable: true
type: string
title: online_acceptance
type: object
x-expandableFields: []
order:
description: |-
Order objects are created to handle end customers' purchases of previously
defined [products](https://stripe.com/docs/api#products). You can create, retrieve, and pay individual orders, as well
as list all orders. Orders are identified by a unique, random ID.
Related guide: [Tax, Shipping, and Inventory](https://stripe.com/docs/orders).
properties:
amount:
description: A positive integer in the smallest currency unit (that is,
100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency)
representing the total amount for the order.
type: integer
amount_returned:
description: The total amount that was returned to the customer.
nullable: true
type: integer
application:
description: ID of the Connect Application that created the order.
maxLength: 5000
nullable: true
type: string
application_fee:
description: A fee in cents that will be applied to the order 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.
nullable: true
type: integer
charge:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/charge"
description: The ID of the payment used to pay for the order. Present if
the order status is `paid`, `fulfilled`, or `refunded`.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/charge"
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
customer:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/customer"
- "$ref": "#/components/schemas/deleted_customer"
description: The customer used for the order.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/customer"
- "$ref": "#/components/schemas/deleted_customer"
email:
description: The email address of the customer placing the order.
maxLength: 5000
nullable: true
type: string
external_coupon_code:
description: External coupon code to load for this order.
maxLength: 5000
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
items:
description: List of items constituting the order. An order can have up
to 25 items.
items:
"$ref": "#/components/schemas/order_item"
type: array
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- order
type: string
returns:
description: A list of returns that have taken place for this order.
nullable: true
properties:
data:
description: Details about each object.
items:
"$ref": "#/components/schemas/order_return"
type: array
has_more:
description: True if this list has another page of items after this
one that can be fetched.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value. Always has the value `list`.
enum:
- list
type: string
url:
description: The URL where this list can be accessed.
maxLength: 5000
type: string
required:
- data
- has_more
- object
- url
title: OrderReturnList
type: object
x-expandableFields:
- data
selected_shipping_method:
description: The shipping method that is currently selected for this order,
if any. If present, it is equal to one of the `id`s of shipping methods
in the `shipping_methods` array. At order creation time, if there are
multiple shipping methods, Stripe will automatically selected the first
method.
maxLength: 5000
nullable: true
type: string
shipping:
anyOf:
- "$ref": "#/components/schemas/shipping"
description: The shipping address for the order. Present if the order is
for goods to be shipped.
nullable: true
shipping_methods:
description: A list of supported shipping methods for this order. The desired
shipping method can be specified either by updating the order, or when
paying it.
items:
"$ref": "#/components/schemas/shipping_method"
nullable: true
type: array
status:
description: Current order status. One of `created`, `paid`, `canceled`,
`fulfilled`, or `returned`. More details in the [Orders Guide](https://stripe.com/docs/orders/guide#understanding-order-statuses).
maxLength: 5000
type: string
status_transitions:
anyOf:
- "$ref": "#/components/schemas/status_transitions"
description: The timestamps at which the order status was updated.
nullable: true
updated:
description: Time at which the object was last updated. Measured in seconds
since the Unix epoch.
format: unix-time
nullable: true
type: integer
upstream_id:
description: The user's order ID if it is different from the Stripe order
ID.
maxLength: 5000
type: string
required:
- amount
- created
- currency
- id
- items
- livemode
- metadata
- object
- status
title: Order
type: object
x-expandableFields:
- charge
- customer
- items
- returns
- shipping
- shipping_methods
- status_transitions
x-resourceId: order
order_item:
description: |-
A representation of the constituent items of any given order. Can be used to
represent [SKUs](https://stripe.com/docs/api#skus), shipping costs, or taxes owed on the order.
Related guide: [Orders](https://stripe.com/docs/orders/guide).
properties:
amount:
description: A positive integer in the smallest currency unit (that is,
100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency)
representing the total amount for the line item.
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
description:
description: Description of the line item, meant to be displayable to the
user (e.g., `"Express shipping"`).
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- order_item
type: string
parent:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/sku"
description: The ID of the associated object for this line item. Expandable
if not null (e.g., expandable to a SKU).
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/sku"
quantity:
description: A positive integer representing the number of instances of
`parent` that are included in this order item. Applicable/present only
if `type` is `sku`.
nullable: true
type: integer
type:
description: The type of line item. One of `sku`, `tax`, `shipping`, or
`discount`.
maxLength: 5000
type: string
required:
- amount
- currency
- description
- object
- type
title: OrderItem
type: object
x-expandableFields:
- parent
order_return:
description: |-
A return represents the full or partial return of a number of [order items](https://stripe.com/docs/api#order_items).
Returns always belong to an order, and may optionally contain a refund.
Related guide: [Handling Returns](https://stripe.com/docs/orders/guide#handling-returns).
properties:
amount:
description: A positive integer in the smallest currency unit (that is,
100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency)
representing the total amount for the returned line item.
type: integer
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
items:
description: The items included in this order return.
items:
"$ref": "#/components/schemas/order_item"
type: array
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- order_return
type: string
order:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/order"
description: The order that this return includes items from.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/order"
refund:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/refund"
description: The ID of the refund issued for this return.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/refund"
required:
- amount
- created
- currency
- id
- items
- livemode
- object
title: OrderReturn
type: object
x-expandableFields:
- items
- order
- refund
x-resourceId: order_return
package_dimensions:
description: ''
properties:
height:
description: Height, in inches.
type: number
length:
description: Length, in inches.
type: number
weight:
description: Weight, in ounces.
type: number
width:
description: Width, in inches.
type: number
required:
- height
- length
- weight
- width
title: PackageDimensions
type: object
x-expandableFields: []
payment_flows_private_payment_methods_alipay_details:
description: ''
properties:
fingerprint:
description: Uniquely identifies this particular Alipay account. You can
use this attribute to check whether two Alipay accounts are the same.
maxLength: 5000
nullable: true
type: string
transaction_id:
description: Transaction ID of this particular Alipay transaction.
maxLength: 5000
nullable: true
type: string
title: PaymentFlowsPrivatePaymentMethodsAlipayDetails
type: object
x-expandableFields: []
payment_intent:
description: |-
A PaymentIntent guides you through the process of collecting a payment from your customer.
We recommend that you create exactly one PaymentIntent for each order or
customer session in your system. You can reference the PaymentIntent later to
see the history of payment attempts for a particular session.
A PaymentIntent transitions through
[multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)
throughout its lifetime as it interfaces with Stripe.js to perform
authentication flows and ultimately creates at most one successful charge.
Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents).
properties:
amount:
description: Amount intended to be collected by this PaymentIntent. A positive
integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)
(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](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts).
The amount value supports up to eight digits (e.g., a value of 99999999
for a USD charge of $999,999.99).
type: integer
amount_capturable:
description: Amount that can be captured from this PaymentIntent.
type: integer
amount_received:
description: Amount that was collected by this PaymentIntent.
type: integer
application:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/application"
description: ID of the Connect application that created the PaymentIntent.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/application"
application_fee_amount:
description: The amount of the application fee (if any) for the resulting
payment. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts)
for details.
nullable: true
type: integer
canceled_at:
description: Populated when `status` is `canceled`, this is the time at
which the PaymentIntent was canceled. Measured in seconds since the Unix
epoch.
format: unix-time
nullable: true
type: integer
cancellation_reason:
description: Reason for cancellation of this PaymentIntent, either user-provided
(`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or
generated by Stripe internally (`failed_invoice`, `void_invoice`, or `automatic`).
enum:
- abandoned
- automatic
- duplicate
- failed_invoice
- fraudulent
- requested_by_customer
- void_invoice
nullable: true
type: string
capture_method:
description: Controls when the funds will be captured from the customer's
account.
enum:
- automatic
- manual
type: string
charges:
description: Charges that were created by this PaymentIntent, if any.
properties:
data:
description: This list only contains the latest charge, even if there
were previously multiple unsuccessful charges. To view all previous
charges for a PaymentIntent, you can filter the charges list using
the `payment_intent` [parameter](https://stripe.com/docs/api/charges/list#list_charges-payment_intent).
items:
"$ref": "#/components/schemas/charge"
type: array
has_more:
description: True if this list has another page of items after this
one that can be fetched.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value. Always has the value `list`.
enum:
- list
type: string
url:
description: The URL where this list can be accessed.
maxLength: 5000
type: string
required:
- data
- has_more
- object
- url
title: PaymentFlowsPaymentIntentResourceChargeList
type: object
x-expandableFields:
- data
client_secret:
description: "The client secret of this PaymentIntent. Used for client-side
retrieval using a publishable key. \n\nThe client secret can be used to
complete a payment from your frontend. It should not be stored, logged,
embedded in URLs, or exposed to anyone other than the customer. Make sure
that you have TLS enabled on any page that includes the client secret.\n\nRefer
to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment)
and learn about how `client_secret` should be handled."
maxLength: 5000
nullable: true
type: string
confirmation_method:
enum:
- automatic
- manual
type: string
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
customer:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/customer"
- "$ref": "#/components/schemas/deleted_customer"
description: |-
ID of the Customer this PaymentIntent belongs to, if one exists.
Payment methods attached to other Customers cannot be used with this PaymentIntent.
If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/customer"
- "$ref": "#/components/schemas/deleted_customer"
description:
description: An arbitrary string attached to the object. Often useful for
displaying to users.
maxLength: 5000
nullable: true
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
invoice:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/invoice"
description: ID of the invoice that created this PaymentIntent, if it exists.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/invoice"
last_payment_error:
anyOf:
- "$ref": "#/components/schemas/api_errors"
description: The payment error encountered in the previous PaymentIntent
confirmation. It will be cleared if the PaymentIntent is later updated
for any reason.
nullable: true
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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. For more information, see the [documentation](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata).
type: object
next_action:
anyOf:
- "$ref": "#/components/schemas/payment_intent_next_action"
description: If present, this property tells you what actions you need to
take in order for your customer to fulfill a payment using the provided
source.
nullable: true
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- payment_intent
type: string
on_behalf_of:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/account"
description: The account (if any) for which the funds of the PaymentIntent
are intended. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts)
for details.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/account"
payment_method:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/payment_method"
description: ID of the payment method used in this PaymentIntent.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/payment_method"
payment_method_options:
anyOf:
- "$ref": "#/components/schemas/payment_intent_payment_method_options"
description: Payment-method-specific configuration for this PaymentIntent.
nullable: true
payment_method_types:
description: The list of payment method types (e.g. card) that this PaymentIntent
is allowed to use.
items:
maxLength: 5000
type: string
type: array
receipt_email:
description: Email address that the receipt for the resulting payment will
be sent to.
maxLength: 5000
nullable: true
type: string
review:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/review"
description: ID of the review associated with this PaymentIntent, if any.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/review"
setup_future_usage:
description: |-
Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) 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](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.
When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).
enum:
- off_session
- on_session
nullable: true
type: string
shipping:
anyOf:
- "$ref": "#/components/schemas/shipping"
description: Shipping information for this PaymentIntent.
nullable: true
statement_descriptor:
description: For non-card charges, you can use this value as the complete
description that appears on your customers’ statements. Must contain at
least one letter, maximum 22 characters.
maxLength: 5000
nullable: true
type: string
statement_descriptor_suffix:
description: 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. Maximum 22 characters for the concatenated descriptor.
maxLength: 5000
nullable: true
type: string
status:
description: Status of this PaymentIntent, one of `requires_payment_method`,
`requires_confirmation`, `requires_action`, `processing`, `requires_capture`,
`canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://stripe.com/docs/payments/intents#intent-statuses).
enum:
- canceled
- processing
- requires_action
- requires_capture
- requires_confirmation
- requires_payment_method
- succeeded
type: string
transfer_data:
anyOf:
- "$ref": "#/components/schemas/transfer_data"
description: The data with which to automatically create a Transfer when
the payment is finalized. See the PaymentIntents [use case for connected
accounts](https://stripe.com/docs/payments/connected-accounts) for details.
nullable: true
transfer_group:
description: A string that identifies the resulting payment as part of a
group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts)
for details.
maxLength: 5000
nullable: true
type: string
required:
- amount
- capture_method
- confirmation_method
- created
- currency
- id
- livemode
- object
- payment_method_types
- status
title: PaymentIntent
type: object
x-expandableFields:
- application
- charges
- customer
- invoice
- last_payment_error
- next_action
- on_behalf_of
- payment_method
- payment_method_options
- review
- shipping
- transfer_data
x-resourceId: payment_intent
payment_intent_next_action:
description: ''
properties:
redirect_to_url:
"$ref": "#/components/schemas/payment_intent_next_action_redirect_to_url"
type:
description: Type of the next action to perform, one of `redirect_to_url`
or `use_stripe_sdk`.
maxLength: 5000
type: string
use_stripe_sdk:
description: When confirming a PaymentIntent with Stripe.js, Stripe.js depends
on the contents of this dictionary to invoke authentication flows. The
shape of the contents is subject to change and is only intended to be
used by Stripe.js.
type: object
required:
- type
title: PaymentIntentNextAction
type: object
x-expandableFields:
- redirect_to_url
payment_intent_next_action_redirect_to_url:
description: ''
properties:
return_url:
description: If the customer does not exit their browser while authenticating,
they will be redirected to this specified URL after completion.
maxLength: 5000
nullable: true
type: string
url:
description: The URL you must redirect your customer to in order to authenticate
the payment.
maxLength: 5000
nullable: true
type: string
title: PaymentIntentNextActionRedirectToUrl
type: object
x-expandableFields: []
payment_intent_payment_method_options:
description: ''
properties:
bancontact:
"$ref": "#/components/schemas/payment_method_options_bancontact"
card:
"$ref": "#/components/schemas/payment_intent_payment_method_options_card"
title: PaymentIntentPaymentMethodOptions
type: object
x-expandableFields:
- bancontact
- card
payment_intent_payment_method_options_card:
description: ''
properties:
installments:
anyOf:
- "$ref": "#/components/schemas/payment_method_options_card_installments"
description: |-
Installment details for this payment (Mexico only).
For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
nullable: true
network:
description: Selected network to process this PaymentIntent on. Depends
on the available networks of the card attached to the PaymentIntent. Can
be only set confirm-time.
enum:
- amex
- cartes_bancaires
- diners
- discover
- interac
- jcb
- mastercard
- unionpay
- unknown
- visa
nullable: true
type: string
request_three_d_secure:
description: 'We strongly recommend that you rely on our SCA Engine to automatically
prompt your customers for authentication based on risk level and [other
requirements](https://stripe.com/docs/strong-customer-authentication).
However, if you wish to request 3D Secure based on logic from your own
fraud engine, provide this option. Permitted values include: `automatic`
or `any`. If not provided, defaults to `automatic`. Read our guide on
[manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds)
for more information on how this configuration interacts with Radar and
our SCA Engine.'
enum:
- any
- automatic
- challenge_only
nullable: true
type: string
title: payment_intent_payment_method_options_card
type: object
x-expandableFields:
- installments
payment_method:
description: |-
PaymentMethod objects represent your customer's payment instruments.
They can be used with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or saved to
Customer objects to store instrument details for future payments.
Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).
properties:
au_becs_debit:
"$ref": "#/components/schemas/payment_method_au_becs_debit"
bacs_debit:
"$ref": "#/components/schemas/payment_method_bacs_debit"
bancontact:
"$ref": "#/components/schemas/payment_method_bancontact"
billing_details:
"$ref": "#/components/schemas/billing_details"
card:
"$ref": "#/components/schemas/payment_method_card"
card_present:
"$ref": "#/components/schemas/payment_method_card_present"
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
customer:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/customer"
description: The ID of the Customer to which this PaymentMethod is saved.
This will not be set when the PaymentMethod has not been saved to a Customer.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/customer"
eps:
"$ref": "#/components/schemas/payment_method_eps"
fpx:
"$ref": "#/components/schemas/payment_method_fpx"
giropay:
"$ref": "#/components/schemas/payment_method_giropay"
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
ideal:
"$ref": "#/components/schemas/payment_method_ideal"
interac_present:
"$ref": "#/components/schemas/payment_method_interac_present"
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- payment_method
type: string
p24:
"$ref": "#/components/schemas/payment_method_p24"
sepa_debit:
"$ref": "#/components/schemas/payment_method_sepa_debit"
type:
description: 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.
enum:
- au_becs_debit
- bacs_debit
- bancontact
- card
- eps
- fpx
- giropay
- ideal
- p24
- sepa_debit
type: string
x-stripeBypassValidation: true
required:
- billing_details
- created
- id
- livemode
- metadata
- object
- type
title: PaymentMethod
type: object
x-expandableFields:
- au_becs_debit
- bacs_debit
- bancontact
- billing_details
- card
- card_present
- customer
- eps
- fpx
- giropay
- ideal
- interac_present
- p24
- sepa_debit
x-resourceId: payment_method
payment_method_au_becs_debit:
description: ''
properties:
bsb_number:
description: Six-digit number identifying bank and branch associated with
this bank account.
maxLength: 5000
nullable: true
type: string
fingerprint:
description: Uniquely identifies this particular bank account. You can use
this attribute to check whether two bank accounts are the same.
maxLength: 5000
nullable: true
type: string
last4:
description: Last four digits of the bank account number.
maxLength: 5000
nullable: true
type: string
title: payment_method_au_becs_debit
type: object
x-expandableFields: []
payment_method_bacs_debit:
description: ''
properties:
fingerprint:
description: Uniquely identifies this particular bank account. You can use
this attribute to check whether two bank accounts are the same.
maxLength: 5000
nullable: true
type: string
last4:
description: Last four digits of the bank account number.
maxLength: 5000
nullable: true
type: string
sort_code:
description: Sort code of the bank account. (e.g., `10-20-30`)
maxLength: 5000
nullable: true
type: string
title: payment_method_bacs_debit
type: object
x-expandableFields: []
payment_method_bancontact:
description: ''
properties: {}
title: payment_method_bancontact
type: object
x-expandableFields: []
payment_method_card:
description: ''
properties:
brand:
description: Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`,
`unionpay`, `visa`, or `unknown`.
maxLength: 5000
type: string
checks:
anyOf:
- "$ref": "#/components/schemas/payment_method_card_checks"
description: Checks on Card address and CVC if provided.
nullable: true
country:
description: 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.
maxLength: 5000
nullable: true
type: string
exp_month:
description: Two-digit number representing the card's expiration month.
type: integer
exp_year:
description: Four-digit number representing the card's expiration year.
type: integer
fingerprint:
description: 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.
maxLength: 5000
nullable: true
type: string
funding:
description: Card funding type. Can be `credit`, `debit`, `prepaid`, or
`unknown`.
maxLength: 5000
type: string
generated_from:
anyOf:
- "$ref": "#/components/schemas/payment_method_card_generated_card"
description: Details of the original PaymentMethod that created this object.
nullable: true
last4:
description: The last four digits of the card.
maxLength: 5000
type: string
networks:
anyOf:
- "$ref": "#/components/schemas/networks"
description: Contains information about card networks that can be used to
process the payment.
nullable: true
three_d_secure_usage:
anyOf:
- "$ref": "#/components/schemas/three_d_secure_usage"
description: Contains details on how this Card maybe be used for 3D Secure
authentication.
nullable: true
wallet:
anyOf:
- "$ref": "#/components/schemas/payment_method_card_wallet"
description: If this Card is part of a card wallet, this contains the details
of the card wallet.
nullable: true
required:
- brand
- exp_month
- exp_year
- funding
- last4
title: payment_method_card
type: object
x-expandableFields:
- checks
- generated_from
- networks
- three_d_secure_usage
- wallet
payment_method_card_checks:
description: ''
properties:
address_line1_check:
description: If a address line1 was provided, results of the check, one
of `pass`, `fail`, `unavailable`, or `unchecked`.
maxLength: 5000
nullable: true
type: string
address_postal_code_check:
description: If a address postal code was provided, results of the check,
one of `pass`, `fail`, `unavailable`, or `unchecked`.
maxLength: 5000
nullable: true
type: string
cvc_check:
description: If a CVC was provided, results of the check, one of `pass`,
`fail`, `unavailable`, or `unchecked`.
maxLength: 5000
nullable: true
type: string
title: payment_method_card_checks
type: object
x-expandableFields: []
payment_method_card_generated_card:
description: ''
properties:
charge:
description: The charge that created this object.
maxLength: 5000
nullable: true
type: string
payment_method_details:
anyOf:
- "$ref": "#/components/schemas/payment_method_details"
description: Transaction-specific details of the payment method used in
the payment.
nullable: true
title: payment_method_card_generated_card
type: object
x-expandableFields:
- payment_method_details
payment_method_card_present:
description: ''
properties: {}
title: payment_method_card_present
type: object
x-expandableFields: []
payment_method_card_wallet:
description: ''
properties:
amex_express_checkout:
"$ref": "#/components/schemas/payment_method_card_wallet_amex_express_checkout"
apple_pay:
"$ref": "#/components/schemas/payment_method_card_wallet_apple_pay"
dynamic_last4:
description: "(For tokenized numbers only.) The last four digits of the
device account number."
maxLength: 5000
nullable: true
type: string
google_pay:
"$ref": "#/components/schemas/payment_method_card_wallet_google_pay"
masterpass:
"$ref": "#/components/schemas/payment_method_card_wallet_masterpass"
samsung_pay:
"$ref": "#/components/schemas/payment_method_card_wallet_samsung_pay"
type:
description: The type of the card wallet, one of `amex_express_checkout`,
`apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, or `visa_checkout`.
An additional hash is included on the Wallet subhash with a name matching
this value. It contains additional information specific to the card wallet
type.
enum:
- amex_express_checkout
- apple_pay
- google_pay
- masterpass
- samsung_pay
- visa_checkout
type: string
visa_checkout:
"$ref": "#/components/schemas/payment_method_card_wallet_visa_checkout"
required:
- type
title: payment_method_card_wallet
type: object
x-expandableFields:
- amex_express_checkout
- apple_pay
- google_pay
- masterpass
- samsung_pay
- visa_checkout
payment_method_card_wallet_amex_express_checkout:
description: ''
properties: {}
title: payment_method_card_wallet_amex_express_checkout
type: object
x-expandableFields: []
payment_method_card_wallet_apple_pay:
description: ''
properties: {}
title: payment_method_card_wallet_apple_pay
type: object
x-expandableFields: []
payment_method_card_wallet_google_pay:
description: ''
properties: {}
title: payment_method_card_wallet_google_pay
type: object
x-expandableFields: []
payment_method_card_wallet_masterpass:
description: ''
properties:
billing_address:
anyOf:
- "$ref": "#/components/schemas/address"
description: Owner's verified billing address. Values are verified or provided
by the wallet directly (if supported) at the time of authorization or
settlement. They cannot be set or mutated.
nullable: true
email:
description: Owner's verified email. Values are verified or provided by
the wallet directly (if supported) at the time of authorization or settlement.
They cannot be set or mutated.
maxLength: 5000
nullable: true
type: string
name:
description: Owner's verified full name. Values are verified or provided
by the wallet directly (if supported) at the time of authorization or
settlement. They cannot be set or mutated.
maxLength: 5000
nullable: true
type: string
shipping_address:
anyOf:
- "$ref": "#/components/schemas/address"
description: Owner's verified shipping address. Values are verified or provided
by the wallet directly (if supported) at the time of authorization or
settlement. They cannot be set or mutated.
nullable: true
title: payment_method_card_wallet_masterpass
type: object
x-expandableFields:
- billing_address
- shipping_address
payment_method_card_wallet_samsung_pay:
description: ''
properties: {}
title: payment_method_card_wallet_samsung_pay
type: object
x-expandableFields: []
payment_method_card_wallet_visa_checkout:
description: ''
properties:
billing_address:
anyOf:
- "$ref": "#/components/schemas/address"
description: Owner's verified billing address. Values are verified or provided
by the wallet directly (if supported) at the time of authorization or
settlement. They cannot be set or mutated.
nullable: true
email:
description: Owner's verified email. Values are verified or provided by
the wallet directly (if supported) at the time of authorization or settlement.
They cannot be set or mutated.
maxLength: 5000
nullable: true
type: string
name:
description: Owner's verified full name. Values are verified or provided
by the wallet directly (if supported) at the time of authorization or
settlement. They cannot be set or mutated.
maxLength: 5000
nullable: true
type: string
shipping_address:
anyOf:
- "$ref": "#/components/schemas/address"
description: Owner's verified shipping address. Values are verified or provided
by the wallet directly (if supported) at the time of authorization or
settlement. They cannot be set or mutated.
nullable: true
title: payment_method_card_wallet_visa_checkout
type: object
x-expandableFields:
- billing_address
- shipping_address
payment_method_details:
description: ''
properties:
ach_credit_transfer:
"$ref": "#/components/schemas/payment_method_details_ach_credit_transfer"
ach_debit:
"$ref": "#/components/schemas/payment_method_details_ach_debit"
alipay:
"$ref": "#/components/schemas/payment_flows_private_payment_methods_alipay_details"
au_becs_debit:
"$ref": "#/components/schemas/payment_method_details_au_becs_debit"
bacs_debit:
"$ref": "#/components/schemas/payment_method_details_bacs_debit"
bancontact:
"$ref": "#/components/schemas/payment_method_details_bancontact"
card:
"$ref": "#/components/schemas/payment_method_details_card"
card_present:
"$ref": "#/components/schemas/payment_method_details_card_present"
eps:
"$ref": "#/components/schemas/payment_method_details_eps"
fpx:
"$ref": "#/components/schemas/payment_method_details_fpx"
giropay:
"$ref": "#/components/schemas/payment_method_details_giropay"
ideal:
"$ref": "#/components/schemas/payment_method_details_ideal"
interac_present:
"$ref": "#/components/schemas/payment_method_details_interac_present"
klarna:
"$ref": "#/components/schemas/payment_method_details_klarna"
multibanco:
"$ref": "#/components/schemas/payment_method_details_multibanco"
p24:
"$ref": "#/components/schemas/payment_method_details_p24"
sepa_debit:
"$ref": "#/components/schemas/payment_method_details_sepa_debit"
sofort:
"$ref": "#/components/schemas/payment_method_details_sofort"
stripe_account:
"$ref": "#/components/schemas/payment_method_details_stripe_account"
type:
description: |-
The type of transaction-specific details of the payment method used in the payment, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `au_becs_debit`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `klarna`, `multibanco`, `p24`, `sepa_debit`, `sofort`, `stripe_account`, or `wechat`.
An additional hash is included on `payment_method_details` with a name matching this value.
It contains information specific to the payment method.
maxLength: 5000
type: string
wechat:
"$ref": "#/components/schemas/payment_method_details_wechat"
required:
- type
title: payment_method_details
type: object
x-expandableFields:
- ach_credit_transfer
- ach_debit
- alipay
- au_becs_debit
- bacs_debit
- bancontact
- card
- card_present
- eps
- fpx
- giropay
- ideal
- interac_present
- klarna
- multibanco
- p24
- sepa_debit
- sofort
- stripe_account
- wechat
payment_method_details_ach_credit_transfer:
description: ''
properties:
account_number:
description: Account number to transfer funds to.
maxLength: 5000
nullable: true
type: string
bank_name:
description: Name of the bank associated with the routing number.
maxLength: 5000
nullable: true
type: string
routing_number:
description: Routing transit number for the bank account to transfer funds
to.
maxLength: 5000
nullable: true
type: string
swift_code:
description: SWIFT code of the bank associated with the routing number.
maxLength: 5000
nullable: true
type: string
title: payment_method_details_ach_credit_transfer
type: object
x-expandableFields: []
payment_method_details_ach_debit:
description: ''
properties:
account_holder_type:
description: Type of entity that holds the account. This can be either `individual`
or `company`.
enum:
- company
- individual
nullable: true
type: string
bank_name:
description: Name of the bank associated with the bank account.
maxLength: 5000
nullable: true
type: string
country:
description: Two-letter ISO code representing the country the bank account
is located in.
maxLength: 5000
nullable: true
type: string
fingerprint:
description: Uniquely identifies this particular bank account. You can use
this attribute to check whether two bank accounts are the same.
maxLength: 5000
nullable: true
type: string
last4:
description: Last four digits of the bank account number.
maxLength: 5000
nullable: true
type: string
routing_number:
description: Routing transit number of the bank account.
maxLength: 5000
nullable: true
type: string
title: payment_method_details_ach_debit
type: object
x-expandableFields: []
payment_method_details_au_becs_debit:
description: ''
properties:
bsb_number:
description: Bank-State-Branch number of the bank account.
maxLength: 5000
nullable: true
type: string
fingerprint:
description: Uniquely identifies this particular bank account. You can use
this attribute to check whether two bank accounts are the same.
maxLength: 5000
nullable: true
type: string
last4:
description: Last four digits of the bank account number.
maxLength: 5000
nullable: true
type: string
mandate:
description: ID of the mandate used to make this payment.
maxLength: 5000
type: string
title: payment_method_details_au_becs_debit
type: object
x-expandableFields: []
payment_method_details_bacs_debit:
description: ''
properties:
fingerprint:
description: Uniquely identifies this particular bank account. You can use
this attribute to check whether two bank accounts are the same.
maxLength: 5000
nullable: true
type: string
last4:
description: Last four digits of the bank account number.
maxLength: 5000
nullable: true
type: string
mandate:
description: ID of the mandate used to make this payment.
maxLength: 5000
nullable: true
type: string
sort_code:
description: Sort code of the bank account. (e.g., `10-20-30`)
maxLength: 5000
nullable: true
type: string
title: payment_method_details_bacs_debit
type: object
x-expandableFields: []
payment_method_details_bancontact:
description: ''
properties:
bank_code:
description: Bank code of bank associated with the bank account.
maxLength: 5000
nullable: true
type: string
bank_name:
description: Name of the bank associated with the bank account.
maxLength: 5000
nullable: true
type: string
bic:
description: Bank Identifier Code of the bank associated with the bank account.
maxLength: 5000
nullable: true
type: string
iban_last4:
description: Last four characters of the IBAN.
maxLength: 5000
nullable: true
type: string
preferred_language:
description: |-
Preferred language of the Bancontact authorization page that the customer is redirected to.
Can be one of `en`, `de`, `fr`, or `nl`
enum:
- de
- en
- fr
- nl
nullable: true
type: string
verified_name:
description: |-
Owner's verified full name. Values are verified or provided by Bancontact directly
(if supported) at the time of authorization or settlement. They cannot be set or mutated.
maxLength: 5000
nullable: true
type: string
title: payment_method_details_bancontact
type: object
x-expandableFields: []
payment_method_details_card:
description: ''
properties:
brand:
description: Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`,
`unionpay`, `visa`, or `unknown`.
maxLength: 5000
nullable: true
type: string
checks:
anyOf:
- "$ref": "#/components/schemas/payment_method_details_card_checks"
description: Check results by Card networks on Card address and CVC at time
of payment.
nullable: true
country:
description: 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.
maxLength: 5000
nullable: true
type: string
exp_month:
description: Two-digit number representing the card's expiration month.
nullable: true
type: integer
exp_year:
description: Four-digit number representing the card's expiration year.
nullable: true
type: integer
fingerprint:
description: 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.
maxLength: 5000
nullable: true
type: string
funding:
description: Card funding type. Can be `credit`, `debit`, `prepaid`, or
`unknown`.
maxLength: 5000
nullable: true
type: string
installments:
anyOf:
- "$ref": "#/components/schemas/payment_method_details_card_installments"
description: |-
Installment details for this payment (Mexico only).
For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
nullable: true
last4:
description: The last four digits of the card.
maxLength: 5000
nullable: true
type: string
network:
description: Identifies which network this charge was processed on. Can
be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`,
`mastercard`, `unionpay`, `visa`, or `unknown`.
maxLength: 5000
nullable: true
type: string
three_d_secure:
anyOf:
- "$ref": "#/components/schemas/three_d_secure_details"
description: Populated if this transaction used 3D Secure authentication.
nullable: true
wallet:
anyOf:
- "$ref": "#/components/schemas/payment_method_details_card_wallet"
description: If this Card is part of a card wallet, this contains the details
of the card wallet.
nullable: true
title: payment_method_details_card
type: object
x-expandableFields:
- checks
- installments
- three_d_secure
- wallet
payment_method_details_card_checks:
description: ''
properties:
address_line1_check:
description: If a address line1 was provided, results of the check, one
of `pass`, `fail`, `unavailable`, or `unchecked`.
maxLength: 5000
nullable: true
type: string
address_postal_code_check:
description: If a address postal code was provided, results of the check,
one of `pass`, `fail`, `unavailable`, or `unchecked`.
maxLength: 5000
nullable: true
type: string
cvc_check:
description: If a CVC was provided, results of the check, one of `pass`,
`fail`, `unavailable`, or `unchecked`.
maxLength: 5000
nullable: true
type: string
title: payment_method_details_card_checks
type: object
x-expandableFields: []
payment_method_details_card_installments:
description: ''
properties:
plan:
anyOf:
- "$ref": "#/components/schemas/payment_method_details_card_installments_plan"
description: Installment plan selected for the payment.
nullable: true
title: payment_method_details_card_installments
type: object
x-expandableFields:
- plan
payment_method_details_card_installments_plan:
description: ''
properties:
count:
description: For `fixed_count` installment plans, this is the number of
installment payments your customer will make to their credit card.
nullable: true
type: integer
interval:
description: |-
For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.
One of `month`.
enum:
- month
nullable: true
type: string
type:
description: Type of installment plan, one of `fixed_count`.
enum:
- fixed_count
type: string
required:
- type
title: payment_method_details_card_installments_plan
type: object
x-expandableFields: []
payment_method_details_card_present:
description: ''
properties:
brand:
description: Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`,
`unionpay`, `visa`, or `unknown`.
maxLength: 5000
nullable: true
type: string
cardholder_name:
description: The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813)
format. May include alphanumeric characters, special characters and first/last
name separator (`/`).
maxLength: 5000
nullable: true
type: string
country:
description: 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.
maxLength: 5000
nullable: true
type: string
emv_auth_data:
description: Authorization response cryptogram.
maxLength: 5000
nullable: true
type: string
exp_month:
description: Two-digit number representing the card's expiration month.
nullable: true
type: integer
exp_year:
description: Four-digit number representing the card's expiration year.
nullable: true
type: integer
fingerprint:
description: 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.
maxLength: 5000
nullable: true
type: string
funding:
description: Card funding type. Can be `credit`, `debit`, `prepaid`, or
`unknown`.
maxLength: 5000
nullable: true
type: string
generated_card:
description: ID of a card PaymentMethod generated from the card_present
PaymentMethod that may be attached to a Customer for future transactions.
Only present if it was possible to generate a card PaymentMethod.
maxLength: 5000
nullable: true
type: string
last4:
description: The last four digits of the card.
maxLength: 5000
nullable: true
type: string
network:
description: Identifies which network this charge was processed on. Can
be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`,
`mastercard`, `unionpay`, `visa`, or `unknown`.
maxLength: 5000
nullable: true
type: string
read_method:
description: How were card details read in this transaction. Can be contact_emv,
contactless_emv, magnetic_stripe_fallback, magnetic_stripe_track2, or
contactless_magstripe_mode
maxLength: 5000
nullable: true
type: string
receipt:
anyOf:
- "$ref": "#/components/schemas/payment_method_details_card_present_receipt"
description: A collection of fields required to be displayed on receipts.
Only required for EMV transactions.
nullable: true
title: payment_method_details_card_present
type: object
x-expandableFields:
- receipt
payment_method_details_card_present_receipt:
description: ''
properties:
application_cryptogram:
description: EMV tag 9F26, cryptogram generated by the integrated circuit
chip.
maxLength: 5000
nullable: true
type: string
application_preferred_name:
description: Mnenomic of the Application Identifier.
maxLength: 5000
nullable: true
type: string
authorization_code:
description: Identifier for this transaction.
maxLength: 5000
nullable: true
type: string
authorization_response_code:
description: EMV tag 8A. A code returned by the card issuer.
maxLength: 5000
nullable: true
type: string
cardholder_verification_method:
description: How the cardholder verified ownership of the card.
maxLength: 5000
nullable: true
type: string
dedicated_file_name:
description: EMV tag 84. Similar to the application identifier stored on
the integrated circuit chip.
maxLength: 5000
nullable: true
type: string
terminal_verification_results:
description: The outcome of a series of EMV functions performed by the card
reader.
maxLength: 5000
nullable: true
type: string
transaction_status_information:
description: An indication of various EMV functions performed during the
transaction.
maxLength: 5000
nullable: true
type: string
title: payment_method_details_card_present_receipt
type: object
x-expandableFields: []
payment_method_details_card_wallet:
description: ''
properties:
amex_express_checkout:
"$ref": "#/components/schemas/payment_method_details_card_wallet_amex_express_checkout"
apple_pay:
"$ref": "#/components/schemas/payment_method_details_card_wallet_apple_pay"
dynamic_last4:
description: "(For tokenized numbers only.) The last four digits of the
device account number."
maxLength: 5000
nullable: true
type: string
google_pay:
"$ref": "#/components/schemas/payment_method_details_card_wallet_google_pay"
masterpass:
"$ref": "#/components/schemas/payment_method_details_card_wallet_masterpass"
samsung_pay:
"$ref": "#/components/schemas/payment_method_details_card_wallet_samsung_pay"
type:
description: The type of the card wallet, one of `amex_express_checkout`,
`apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, or `visa_checkout`.
An additional hash is included on the Wallet subhash with a name matching
this value. It contains additional information specific to the card wallet
type.
enum:
- amex_express_checkout
- apple_pay
- google_pay
- masterpass
- samsung_pay
- visa_checkout
type: string
visa_checkout:
"$ref": "#/components/schemas/payment_method_details_card_wallet_visa_checkout"
required:
- type
title: payment_method_details_card_wallet
type: object
x-expandableFields:
- amex_express_checkout
- apple_pay
- google_pay
- masterpass
- samsung_pay
- visa_checkout
payment_method_details_card_wallet_amex_express_checkout:
description: ''
properties: {}
title: payment_method_details_card_wallet_amex_express_checkout
type: object
x-expandableFields: []
payment_method_details_card_wallet_apple_pay:
description: ''
properties: {}
title: payment_method_details_card_wallet_apple_pay
type: object
x-expandableFields: []
payment_method_details_card_wallet_google_pay:
description: ''
properties: {}
title: payment_method_details_card_wallet_google_pay
type: object
x-expandableFields: []
payment_method_details_card_wallet_masterpass:
description: ''
properties:
billing_address:
anyOf:
- "$ref": "#/components/schemas/address"
description: Owner's verified billing address. Values are verified or provided
by the wallet directly (if supported) at the time of authorization or
settlement. They cannot be set or mutated.
nullable: true
email:
description: Owner's verified email. Values are verified or provided by
the wallet directly (if supported) at the time of authorization or settlement.
They cannot be set or mutated.
maxLength: 5000
nullable: true
type: string
name:
description: Owner's verified full name. Values are verified or provided
by the wallet directly (if supported) at the time of authorization or
settlement. They cannot be set or mutated.
maxLength: 5000
nullable: true
type: string
shipping_address:
anyOf:
- "$ref": "#/components/schemas/address"
description: Owner's verified shipping address. Values are verified or provided
by the wallet directly (if supported) at the time of authorization or
settlement. They cannot be set or mutated.
nullable: true
title: payment_method_details_card_wallet_masterpass
type: object
x-expandableFields:
- billing_address
- shipping_address
payment_method_details_card_wallet_samsung_pay:
description: ''
properties: {}
title: payment_method_details_card_wallet_samsung_pay
type: object
x-expandableFields: []
payment_method_details_card_wallet_visa_checkout:
description: ''
properties:
billing_address:
anyOf:
- "$ref": "#/components/schemas/address"
description: Owner's verified billing address. Values are verified or provided
by the wallet directly (if supported) at the time of authorization or
settlement. They cannot be set or mutated.
nullable: true
email:
description: Owner's verified email. Values are verified or provided by
the wallet directly (if supported) at the time of authorization or settlement.
They cannot be set or mutated.
maxLength: 5000
nullable: true
type: string
name:
description: Owner's verified full name. Values are verified or provided
by the wallet directly (if supported) at the time of authorization or
settlement. They cannot be set or mutated.
maxLength: 5000
nullable: true
type: string
shipping_address:
anyOf:
- "$ref": "#/components/schemas/address"
description: Owner's verified shipping address. Values are verified or provided
by the wallet directly (if supported) at the time of authorization or
settlement. They cannot be set or mutated.
nullable: true
title: payment_method_details_card_wallet_visa_checkout
type: object
x-expandableFields:
- billing_address
- shipping_address
payment_method_details_eps:
description: ''
properties:
verified_name:
description: |-
Owner's verified full name. Values are verified or provided by EPS directly
(if supported) at the time of authorization or settlement. They cannot be set or mutated.
EPS rarely provides this information so the attribute is usually empty.
maxLength: 5000
nullable: true
type: string
title: payment_method_details_eps
type: object
x-expandableFields: []
payment_method_details_fpx:
description: ''
properties:
bank:
description: The customer's bank. Can be one of `affin_bank`, `alliance_bank`,
`ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`,
`hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`,
`rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, or `pb_enterprise`.
enum:
- affin_bank
- alliance_bank
- ambank
- bank_islam
- bank_muamalat
- bank_rakyat
- bsn
- cimb
- deutsche_bank
- hong_leong_bank
- hsbc
- kfh
- maybank2e
- maybank2u
- ocbc
- pb_enterprise
- public_bank
- rhb
- standard_chartered
- uob
type: string
transaction_id:
description: Unique transaction id generated by FPX for every request from
the merchant
maxLength: 5000
nullable: true
type: string
required:
- bank
title: payment_method_details_fpx
type: object
x-expandableFields: []
payment_method_details_giropay:
description: ''
properties:
bank_code:
description: Bank code of bank associated with the bank account.
maxLength: 5000
nullable: true
type: string
bank_name:
description: Name of the bank associated with the bank account.
maxLength: 5000
nullable: true
type: string
bic:
description: Bank Identifier Code of the bank associated with the bank account.
maxLength: 5000
nullable: true
type: string
verified_name:
description: |-
Owner's verified full name. Values are verified or provided by Giropay directly
(if supported) at the time of authorization or settlement. They cannot be set or mutated.
Giropay rarely provides this information so the attribute is usually empty.
maxLength: 5000
nullable: true
type: string
title: payment_method_details_giropay
type: object
x-expandableFields: []
payment_method_details_ideal:
description: ''
properties:
bank:
description: The customer's bank. Can be one of `abn_amro`, `asn_bank`,
`bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `rabobank`, `regiobank`,
`sns_bank`, `triodos_bank`, or `van_lanschot`.
enum:
- abn_amro
- asn_bank
- bunq
- handelsbanken
- ing
- knab
- moneyou
- rabobank
- regiobank
- sns_bank
- triodos_bank
- van_lanschot
nullable: true
type: string
bic:
description: The Bank Identifier Code of the customer's bank.
enum:
- ABNANL2A
- ASNBNL21
- BUNQNL2A
- FVLBNL22
- HANDNL2A
- INGBNL2A
- KNABNL2H
- MOYONL21
- RABONL2U
- RBRBNL21
- SNSBNL2A
- TRIONL2U
nullable: true
type: string
iban_last4:
description: Last four characters of the IBAN.
maxLength: 5000
nullable: true
type: string
verified_name:
description: |-
Owner's verified full name. Values are verified or provided by iDEAL directly
(if supported) at the time of authorization or settlement. They cannot be set or mutated.
maxLength: 5000
nullable: true
type: string
title: payment_method_details_ideal
type: object
x-expandableFields: []
payment_method_details_interac_present:
description: ''
properties:
brand:
description: Card brand. Can be `interac`, `mastercard` or `visa`.
maxLength: 5000
nullable: true
type: string
cardholder_name:
description: The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813)
format. May include alphanumeric characters, special characters and first/last
name separator (`/`).
maxLength: 5000
nullable: true
type: string
country:
description: 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.
maxLength: 5000
nullable: true
type: string
emv_auth_data:
description: Authorization response cryptogram.
maxLength: 5000
nullable: true
type: string
exp_month:
description: Two-digit number representing the card's expiration month.
nullable: true
type: integer
exp_year:
description: Four-digit number representing the card's expiration year.
nullable: true
type: integer
fingerprint:
description: 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.
maxLength: 5000
nullable: true
type: string
funding:
description: Card funding type. Can be `credit`, `debit`, `prepaid`, or
`unknown`.
maxLength: 5000
nullable: true
type: string
generated_card:
description: ID of a card PaymentMethod generated from the card_present
PaymentMethod that may be attached to a Customer for future transactions.
Only present if it was possible to generate a card PaymentMethod.
maxLength: 5000
nullable: true
type: string
last4:
description: The last four digits of the card.
maxLength: 5000
nullable: true
type: string
network:
description: Identifies which network this charge was processed on. Can
be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`,
`mastercard`, `unionpay`, `visa`, or `unknown`.
maxLength: 5000
nullable: true
type: string
read_method:
description: How were card details read in this transaction. Can be contact_emv,
contactless_emv, magnetic_stripe_fallback, magnetic_stripe_track2, or
contactless_magstripe_mode
maxLength: 5000
nullable: true
type: string
receipt:
anyOf:
- "$ref": "#/components/schemas/payment_method_details_interac_present_receipt"
description: A collection of fields required to be displayed on receipts.
Only required for EMV transactions.
nullable: true
title: payment_method_details_interac_present
type: object
x-expandableFields:
- receipt
payment_method_details_interac_present_receipt:
description: ''
properties:
account_type:
description: For Interac transactions - the source account type of the funds
maxLength: 5000
type: string
application_cryptogram:
description: EMV tag 9F26, cryptogram generated by the integrated circuit
chip.
maxLength: 5000
nullable: true
type: string
application_preferred_name:
description: Mnenomic of the Application Identifier.
maxLength: 5000
nullable: true
type: string
authorization_code:
description: Identifier for this transaction.
maxLength: 5000
nullable: true
type: string
authorization_response_code:
description: EMV tag 8A. A code returned by the card issuer.
maxLength: 5000
nullable: true
type: string
cardholder_verification_method:
description: How the cardholder verified ownership of the card.
maxLength: 5000
nullable: true
type: string
dedicated_file_name:
description: EMV tag 84. Similar to the application identifier stored on
the integrated circuit chip.
maxLength: 5000
nullable: true
type: string
terminal_verification_results:
description: The outcome of a series of EMV functions performed by the card
reader.
maxLength: 5000
nullable: true
type: string
transaction_status_information:
description: An indication of various EMV functions performed during the
transaction.
maxLength: 5000
nullable: true
type: string
title: payment_method_details_interac_present_receipt
type: object
x-expandableFields: []
payment_method_details_klarna:
description: ''
properties: {}
title: payment_method_details_klarna
type: object
x-expandableFields: []
payment_method_details_multibanco:
description: ''
properties:
entity:
description: Entity number associated with this Multibanco payment.
maxLength: 5000
nullable: true
type: string
reference:
description: Reference number associated with this Multibanco payment.
maxLength: 5000
nullable: true
type: string
title: payment_method_details_multibanco
type: object
x-expandableFields: []
payment_method_details_p24:
description: ''
properties:
reference:
description: Unique reference for this Przelewy24 payment.
maxLength: 5000
nullable: true
type: string
verified_name:
description: |-
Owner's verified full name. Values are verified or provided by Przelewy24 directly
(if supported) at the time of authorization or settlement. They cannot be set or mutated.
Przelewy24 rarely provides this information so the attribute is usually empty.
maxLength: 5000
nullable: true
type: string
title: payment_method_details_p24
type: object
x-expandableFields: []
payment_method_details_sepa_debit:
description: ''
properties:
bank_code:
description: Bank code of bank associated with the bank account.
maxLength: 5000
nullable: true
type: string
branch_code:
description: Branch code of bank associated with the bank account.
maxLength: 5000
nullable: true
type: string
country:
description: Two-letter ISO code representing the country the bank account
is located in.
maxLength: 5000
nullable: true
type: string
fingerprint:
description: Uniquely identifies this particular bank account. You can use
this attribute to check whether two bank accounts are the same.
maxLength: 5000
nullable: true
type: string
last4:
description: Last four characters of the IBAN.
maxLength: 5000
nullable: true
type: string
mandate:
description: ID of the mandate used to make this payment.
maxLength: 5000
nullable: true
type: string
title: payment_method_details_sepa_debit
type: object
x-expandableFields: []
payment_method_details_sofort:
description: ''
properties:
bank_code:
description: Bank code of bank associated with the bank account.
maxLength: 5000
nullable: true
type: string
bank_name:
description: Name of the bank associated with the bank account.
maxLength: 5000
nullable: true
type: string
bic:
description: Bank Identifier Code of the bank associated with the bank account.
maxLength: 5000
nullable: true
type: string
country:
description: Two-letter ISO code representing the country the bank account
is located in.
maxLength: 5000
nullable: true
type: string
iban_last4:
description: Last four characters of the IBAN.
maxLength: 5000
nullable: true
type: string
verified_name:
description: |-
Owner's verified full name. Values are verified or provided by SOFORT directly
(if supported) at the time of authorization or settlement. They cannot be set or mutated.
maxLength: 5000
nullable: true
type: string
title: payment_method_details_sofort
type: object
x-expandableFields: []
payment_method_details_stripe_account:
description: ''
properties: {}
title: payment_method_details_stripe_account
type: object
x-expandableFields: []
payment_method_details_wechat:
description: ''
properties: {}
title: payment_method_details_wechat
type: object
x-expandableFields: []
payment_method_eps:
description: ''
properties: {}
title: payment_method_eps
type: object
x-expandableFields: []
payment_method_fpx:
description: ''
properties:
bank:
description: The customer's bank, if provided. Can be one of `affin_bank`,
`alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`,
`bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`,
`public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`,
or `pb_enterprise`.
enum:
- affin_bank
- alliance_bank
- ambank
- bank_islam
- bank_muamalat
- bank_rakyat
- bsn
- cimb
- deutsche_bank
- hong_leong_bank
- hsbc
- kfh
- maybank2e
- maybank2u
- ocbc
- pb_enterprise
- public_bank
- rhb
- standard_chartered
- uob
type: string
required:
- bank
title: payment_method_fpx
type: object
x-expandableFields: []
payment_method_giropay:
description: ''
properties: {}
title: payment_method_giropay
type: object
x-expandableFields: []
payment_method_ideal:
description: ''
properties:
bank:
description: The customer's bank, if provided. Can be one of `abn_amro`,
`asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `rabobank`,
`regiobank`, `sns_bank`, `triodos_bank`, or `van_lanschot`.
enum:
- abn_amro
- asn_bank
- bunq
- handelsbanken
- ing
- knab
- moneyou
- rabobank
- regiobank
- sns_bank
- triodos_bank
- van_lanschot
nullable: true
type: string
bic:
description: The Bank Identifier Code of the customer's bank, if the bank
was provided.
enum:
- ABNANL2A
- ASNBNL21
- BUNQNL2A
- FVLBNL22
- HANDNL2A
- INGBNL2A
- KNABNL2H
- MOYONL21
- RABONL2U
- RBRBNL21
- SNSBNL2A
- TRIONL2U
nullable: true
type: string
title: payment_method_ideal
type: object
x-expandableFields: []
payment_method_interac_present:
description: ''
properties: {}
title: payment_method_interac_present
type: object
x-expandableFields: []
payment_method_options_bancontact:
description: ''
properties:
preferred_language:
description: Preferred language of the Bancontact authorization page that
the customer is redirected to.
enum:
- de
- en
- fr
- nl
type: string
required:
- preferred_language
title: payment_method_options_bancontact
type: object
x-expandableFields: []
payment_method_options_card_installments:
description: ''
properties:
available_plans:
description: Installment plans that may be selected for this PaymentIntent.
items:
"$ref": "#/components/schemas/payment_method_details_card_installments_plan"
nullable: true
type: array
enabled:
description: Whether Installments are enabled for this PaymentIntent.
type: boolean
plan:
anyOf:
- "$ref": "#/components/schemas/payment_method_details_card_installments_plan"
description: Installment plan selected for this PaymentIntent.
nullable: true
required:
- enabled
title: payment_method_options_card_installments
type: object
x-expandableFields:
- available_plans
- plan
payment_method_p24:
description: ''
properties: {}
title: payment_method_p24
type: object
x-expandableFields: []
payment_method_sepa_debit:
description: ''
properties:
bank_code:
description: Bank code of bank associated with the bank account.
maxLength: 5000
nullable: true
type: string
branch_code:
description: Branch code of bank associated with the bank account.
maxLength: 5000
nullable: true
type: string
country:
description: Two-letter ISO code representing the country the bank account
is located in.
maxLength: 5000
nullable: true
type: string
fingerprint:
description: Uniquely identifies this particular bank account. You can use
this attribute to check whether two bank accounts are the same.
maxLength: 5000
nullable: true
type: string
last4:
description: Last four characters of the IBAN.
maxLength: 5000
nullable: true
type: string
title: payment_method_sepa_debit
type: object
x-expandableFields: []
payment_pages_checkout_session_line_item_resource_line_item_tax:
description: ''
properties:
amount:
description: Amount of tax for this line item.
type: integer
rate:
"$ref": "#/components/schemas/tax_rate"
required:
- amount
- rate
title: PaymentPagesCheckoutSessionLineItemResourceLineItemTax
type: object
x-expandableFields:
- rate
payment_pages_payment_page_resources_shipping_address_collection:
description: ''
properties:
allowed_countries:
description: |-
An array of two-letter ISO country codes representing which countries Checkout should provide as options for
shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`.
items:
enum:
- AC
- AD
- AE
- AF
- AG
- AI
- AL
- AM
- AO
- AQ
- AR
- AT
- AU
- AW
- AX
- AZ
- BA
- BB
- BD
- BE
- BF
- BG
- BH
- BI
- BJ
- BL
- BM
- BN
- BO
- BQ
- BR
- BS
- BT
- BV
- BW
- BY
- BZ
- CA
- CD
- CF
- CG
- CH
- CI
- CK
- CL
- CM
- CN
- CO
- CR
- CV
- CW
- CY
- CZ
- DE
- DJ
- DK
- DM
- DO
- DZ
- EC
- EE
- EG
- EH
- ER
- ES
- ET
- FI
- FJ
- FK
- FO
- FR
- GA
- GB
- GD
- GE
- GF
- GG
- GH
- GI
- GL
- GM
- GN
- GP
- GQ
- GR
- GS
- GT
- GU
- GW
- GY
- HK
- HN
- HR
- HT
- HU
- ID
- IE
- IL
- IM
- IN
- IO
- IQ
- IS
- IT
- JE
- JM
- JO
- JP
- KE
- KG
- KH
- KI
- KM
- KN
- KR
- KW
- KY
- KZ
- LA
- LB
- LC
- LI
- LK
- LR
- LS
- LT
- LU
- LV
- LY
- MA
- MC
- MD
- ME
- MF
- MG
- MK
- ML
- MM
- MN
- MO
- MQ
- MR
- MS
- MT
- MU
- MV
- MW
- MX
- MY
- MZ
- NA
- NC
- NE
- NG
- NI
- NL
- 'NO'
- NP
- NR
- NU
- NZ
- OM
- PA
- PE
- PF
- PG
- PH
- PK
- PL
- PM
- PN
- PR
- PS
- PT
- PY
- QA
- RE
- RO
- RS
- RU
- RW
- SA
- SB
- SC
- SE
- SG
- SH
- SI
- SJ
- SK
- SL
- SM
- SN
- SO
- SR
- SS
- ST
- SV
- SX
- SZ
- TA
- TC
- TD
- TF
- TG
- TH
- TJ
- TK
- TL
- TM
- TN
- TO
- TR
- TT
- TV
- TW
- TZ
- UA
- UG
- US
- UY
- UZ
- VA
- VC
- VE
- VG
- VN
- VU
- WF
- WS
- XK
- YE
- YT
- ZA
- ZM
- ZW
- ZZ
type: string
type: array
required:
- allowed_countries
title: PaymentPagesPaymentPageResourcesShippingAddressCollection
type: object
x-expandableFields: []
payment_source:
anyOf:
- "$ref": "#/components/schemas/account"
- "$ref": "#/components/schemas/alipay_account"
- "$ref": "#/components/schemas/bank_account"
- "$ref": "#/components/schemas/bitcoin_receiver"
- "$ref": "#/components/schemas/card"
- "$ref": "#/components/schemas/source"
title: Polymorphic
x-resourceId: payment_source
payout:
description: |-
A `Payout` object is created when you receive funds from Stripe, or when you
initiate a payout to either a bank account or debit card of a [connected
Stripe account](/docs/connect/payouts). You can retrieve individual payouts,
as well as list all payouts. Payouts are made on [varying
schedules](/docs/payouts#payout-schedule), depending on your country and
industry.
Related guide: [Receiving Payouts](https://stripe.com/docs/payouts).
properties:
amount:
description: Amount (in %s) to be transferred to your bank account or debit
card.
type: integer
arrival_date:
description: Date the payout is expected to arrive in the bank. This factors
in delays like weekends or bank holidays.
format: unix-time
type: integer
automatic:
description: Returns `true` if the payout was created by an [automated payout
schedule](https://stripe.com/docs/payouts#payout-schedule), and `false`
if it was [requested manually](https://stripe.com/docs/payouts#manual-payouts).
type: boolean
balance_transaction:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/balance_transaction"
description: ID of the balance transaction that describes the impact of
this payout on your account balance.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/balance_transaction"
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
description:
description: An arbitrary string attached to the object. Often useful for
displaying to users.
maxLength: 5000
nullable: true
type: string
destination:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/bank_account"
- "$ref": "#/components/schemas/card"
- "$ref": "#/components/schemas/deleted_bank_account"
- "$ref": "#/components/schemas/deleted_card"
description: ID of the bank account or card the payout was sent to.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/bank_account"
- "$ref": "#/components/schemas/card"
- "$ref": "#/components/schemas/deleted_bank_account"
- "$ref": "#/components/schemas/deleted_card"
failure_balance_transaction:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/balance_transaction"
description: If the payout failed or was canceled, this will be the ID of
the balance transaction that reversed the initial balance transaction,
and puts the funds from the failed payout back in your balance.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/balance_transaction"
failure_code:
description: Error code explaining reason for payout failure if available.
See [Types of payout failures](https://stripe.com/docs/api#payout_failures)
for a list of failure codes.
maxLength: 5000
nullable: true
type: string
failure_message:
description: Message to user further explaining reason for payout failure
if available.
maxLength: 5000
nullable: true
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
method:
description: The method used to send this payout, which can be `standard`
or `instant`. `instant` is only supported for payouts to debit cards.
(See [Instant payouts for marketplaces](https://stripe.com/blog/instant-payouts-for-marketplaces)
for more information.)
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- payout
type: string
source_type:
description: The source balance this payout came from. One of `card`, `fpx`,
or `bank_account`.
maxLength: 5000
type: string
statement_descriptor:
description: Extra information about a payout to be displayed on the user's
bank statement.
maxLength: 5000
nullable: true
type: string
status:
description: 'Current status of the payout: `paid`, `pending`, `in_transit`,
`canceled` or `failed`. A payout is `pending` until it is submitted to
the bank, when it becomes `in_transit`. The status then changes to `paid`
if the transaction goes through, or to `failed` or `canceled` (within
5 business days). Some failed payouts may initially show as `paid` but
then change to `failed`.'
maxLength: 5000
type: string
type:
description: Can be `bank_account` or `card`.
enum:
- bank_account
- card
type: string
required:
- amount
- arrival_date
- automatic
- created
- currency
- id
- livemode
- metadata
- method
- object
- source_type
- status
- type
title: Payout
type: object
x-expandableFields:
- balance_transaction
- destination
- failure_balance_transaction
x-resourceId: payout
period:
description: ''
properties:
end:
description: The end date of this usage period. All usage up to and including
this point in time is included.
format: unix-time
nullable: true
type: integer
start:
description: The start date of this usage period. All usage after this point
in time is included.
format: unix-time
nullable: true
type: integer
title: Period
type: object
x-expandableFields: []
person:
description: |-
This is an object representing a person associated with a Stripe account.
Related guide: [Handling Identity Verification with the API](https://stripe.com/docs/connect/identity-verification-api#person-information).
properties:
account:
maxLength: 5000
type: string
address:
"$ref": "#/components/schemas/address"
address_kana:
anyOf:
- "$ref": "#/components/schemas/legal_entity_japan_address"
nullable: true
address_kanji:
anyOf:
- "$ref": "#/components/schemas/legal_entity_japan_address"
nullable: true
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
dob:
"$ref": "#/components/schemas/legal_entity_dob"
email:
maxLength: 5000
nullable: true
type: string
first_name:
maxLength: 5000
nullable: true
type: string
first_name_kana:
maxLength: 5000
nullable: true
type: string
first_name_kanji:
maxLength: 5000
nullable: true
type: string
gender:
maxLength: 5000
nullable: true
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
id_number_provided:
type: boolean
last_name:
maxLength: 5000
nullable: true
type: string
last_name_kana:
maxLength: 5000
nullable: true
type: string
last_name_kanji:
maxLength: 5000
nullable: true
type: string
maiden_name:
maxLength: 5000
nullable: true
type: string
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- person
type: string
phone:
maxLength: 5000
nullable: true
type: string
relationship:
"$ref": "#/components/schemas/person_relationship"
requirements:
anyOf:
- "$ref": "#/components/schemas/person_requirements"
nullable: true
ssn_last_4_provided:
type: boolean
verification:
"$ref": "#/components/schemas/legal_entity_person_verification"
required:
- account
- created
- id
- object
title: Person
type: object
x-expandableFields:
- address
- address_kana
- address_kanji
- dob
- relationship
- requirements
- verification
x-resourceId: person
person_relationship:
description: ''
properties:
director:
description: Whether the person is a director of the account's legal entity.
Currently only required for accounts in the EU. Directors are typically
members of the governing board of the company, or responsible for ensuring
the company meets its regulatory obligations.
nullable: true
type: boolean
executive:
description: Whether the person has significant responsibility to control,
manage, or direct the organization.
nullable: true
type: boolean
owner:
description: Whether the person is an owner of the account’s legal entity.
nullable: true
type: boolean
percent_ownership:
description: The percent owned by the person of the account's legal entity.
nullable: true
type: number
representative:
description: Whether the person is authorized as the primary representative
of the account. This is the person nominated by the business to provide
information about themselves, and general information about the account.
There can only be one representative at any given time. At the time the
account is created, this person should be set to the person responsible
for opening the account.
nullable: true
type: boolean
title:
description: The person's title (e.g., CEO, Support Engineer).
maxLength: 5000
nullable: true
type: string
title: PersonRelationship
type: object
x-expandableFields: []
person_requirements:
description: ''
properties:
currently_due:
description: Fields that need to be collected to keep the person's account
enabled. If not collected by the account's `current_deadline`, these fields
appear in `past_due` as well, and the account is disabled.
items:
maxLength: 5000
type: string
type: array
errors:
description: The fields that need to be collected again because validation
or verification failed for some reason.
items:
"$ref": "#/components/schemas/account_requirements_error"
type: array
eventually_due:
description: Fields that need to be collected assuming all volume thresholds
are reached. As fields are needed, they are moved to `currently_due` and
the account's `current_deadline` is set.
items:
maxLength: 5000
type: string
type: array
past_due:
description: Fields that weren't collected by the account's `current_deadline`.
These fields need to be collected to enable payouts for the person's account.
items:
maxLength: 5000
type: string
type: array
pending_verification:
description: Fields that may become required depending on the results of
verification or review. An empty array unless an asynchronous verification
is pending. If verification fails, the fields in this array become required
and move to `currently_due` or `past_due`.
items:
maxLength: 5000
type: string
type: array
required:
- currently_due
- errors
- eventually_due
- past_due
- pending_verification
title: PersonRequirements
type: object
x-expandableFields:
- errors
plan:
description: |-
You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration.
Plans define the base price, currency, and billing cycle for recurring purchases of products.
[Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.
Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription) and more about [products and prices](https://stripe.com/docs/billing/prices-guide).
properties:
active:
description: Whether the plan can be used for new purchases.
type: boolean
aggregate_usage:
description: Specifies a usage aggregation strategy for plans of `usage_type=metered`.
Allowed values are `sum` for summing up all usage during a period, `last_during_period`
for using the last usage record reported within a period, `last_ever`
for using the last usage record ever (across period bounds) or `max` which
uses the usage record with the maximum reported usage during a period.
Defaults to `sum`.
enum:
- last_during_period
- last_ever
- max
- sum
nullable: true
type: string
amount:
description: The unit amount in %s to be charged, represented as a whole
integer if possible.
nullable: true
type: integer
amount_decimal:
description: The unit amount in %s to be charged, represented as a decimal
string with at most 12 decimal places.
format: decimal
nullable: true
type: string
billing_scheme:
description: Describes how to compute the price per period. Either `per_unit`
or `tiered`. `per_unit` indicates that the fixed amount (specified in
`amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`),
or per unit of total usage (for plans with `usage_type=metered`). `tiered`
indicates that the unit pricing will be computed using a tiering strategy
as defined using the `tiers` and `tiers_mode` attributes.
enum:
- per_unit
- tiered
type: string
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
interval:
description: The frequency at which a subscription is billed. One of `day`,
`week`, `month` or `year`.
enum:
- day
- month
- week
- year
type: string
interval_count:
description: The number of intervals (specified in the `interval` attribute)
between subscription billings. For example, `interval=month` and `interval_count=3`
bills every 3 months.
type: integer
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
nickname:
description: A brief description of the plan, hidden from customers.
maxLength: 5000
nullable: true
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- plan
type: string
product:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/product"
- "$ref": "#/components/schemas/deleted_product"
description: The product whose pricing this plan determines.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/product"
- "$ref": "#/components/schemas/deleted_product"
tiers:
description: Each element represents a pricing tier. This parameter requires
`billing_scheme` to be set to `tiered`. See also the documentation for
`billing_scheme`.
items:
"$ref": "#/components/schemas/plan_tier"
nullable: true
type: array
tiers_mode:
description: Defines if the tiering price should be `graduated` or `volume`
based. In `volume`-based tiering, the maximum quantity within a period
determines the per unit price. In `graduated` tiering, pricing can change
as the quantity grows.
enum:
- graduated
- volume
nullable: true
type: string
transform_usage:
anyOf:
- "$ref": "#/components/schemas/transform_usage"
description: Apply a transformation to the reported usage or set quantity
before computing the amount billed. Cannot be combined with `tiers`.
nullable: true
trial_period_days:
description: Default number of trial days when subscribing a customer to
this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).
nullable: true
type: integer
usage_type:
description: Configures how the quantity per period should be determined.
Can be either `metered` or `licensed`. `licensed` automatically bills
the `quantity` set when adding it to a subscription. `metered` aggregates
the total usage based on usage records. Defaults to `licensed`.
enum:
- licensed
- metered
type: string
required:
- active
- billing_scheme
- created
- currency
- id
- interval
- interval_count
- livemode
- metadata
- object
- usage_type
title: Plan
type: object
x-expandableFields:
- product
- tiers
- transform_usage
x-resourceId: plan
plan_tier:
description: ''
properties:
flat_amount:
description: Price for the entire tier.
nullable: true
type: integer
flat_amount_decimal:
description: Same as `flat_amount`, but contains a decimal value with at
most 12 decimal places.
format: decimal
nullable: true
type: string
unit_amount:
description: Per unit price for units relevant to the tier.
nullable: true
type: integer
unit_amount_decimal:
description: Same as `unit_amount`, but contains a decimal value with at
most 12 decimal places.
format: decimal
nullable: true
type: string
up_to:
description: Up to and including to this quantity will be contained in the
tier.
nullable: true
type: integer
title: PlanTier
type: object
x-expandableFields: []
platform_tax_fee:
description: ''
properties:
account:
description: The Connected account that incurred this charge.
maxLength: 5000
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- platform_tax_fee
type: string
source_transaction:
description: The payment object that caused this tax to be inflicted.
maxLength: 5000
type: string
type:
description: The type of tax (VAT).
maxLength: 5000
type: string
required:
- account
- id
- object
- source_transaction
- type
title: PlatformTax
type: object
x-expandableFields: []
price:
description: |-
Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products.
[Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.
For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once.
Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/billing/prices-guide).
properties:
active:
description: Whether the price can be used for new purchases.
type: boolean
billing_scheme:
description: Describes how to compute the price per period. Either `per_unit`
or `tiered`. `per_unit` indicates that the fixed amount (specified in
`unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity`
(for prices with `usage_type=licensed`), or per unit of total usage (for
prices with `usage_type=metered`). `tiered` indicates that the unit pricing
will be computed using a tiering strategy as defined using the `tiers`
and `tiers_mode` attributes.
enum:
- per_unit
- tiered
type: string
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
lookup_key:
description: A lookup key used to retrieve prices dynamically from a static
string.
maxLength: 5000
nullable: true
type: string
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
nickname:
description: A brief description of the plan, hidden from customers.
maxLength: 5000
nullable: true
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- price
type: string
product:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/product"
- "$ref": "#/components/schemas/deleted_product"
description: The ID of the product this price is associated with.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/product"
- "$ref": "#/components/schemas/deleted_product"
recurring:
anyOf:
- "$ref": "#/components/schemas/recurring"
description: The recurring components of a price such as `interval` and
`usage_type`.
nullable: true
tiers:
description: Each element represents a pricing tier. This parameter requires
`billing_scheme` to be set to `tiered`. See also the documentation for
`billing_scheme`.
items:
"$ref": "#/components/schemas/price_tier"
type: array
tiers_mode:
description: Defines if the tiering price should be `graduated` or `volume`
based. In `volume`-based tiering, the maximum quantity within a period
determines the per unit price. In `graduated` tiering, pricing can change
as the quantity grows.
enum:
- graduated
- volume
nullable: true
type: string
transform_quantity:
anyOf:
- "$ref": "#/components/schemas/transform_quantity"
description: Apply a transformation to the reported usage or set quantity
before computing the amount billed. Cannot be combined with `tiers`.
nullable: true
type:
description: One of `one_time` or `recurring` depending on whether the price
is for a one-time purchase or a recurring (subscription) purchase.
enum:
- one_time
- recurring
type: string
unit_amount:
description: The unit amount in %s to be charged, represented as a whole
integer if possible.
nullable: true
type: integer
unit_amount_decimal:
description: The unit amount in %s to be charged, represented as a decimal
string with at most 12 decimal places.
format: decimal
nullable: true
type: string
required:
- active
- billing_scheme
- created
- currency
- id
- livemode
- metadata
- object
- product
- type
title: Price
type: object
x-expandableFields:
- product
- recurring
- tiers
- transform_quantity
x-resourceId: price
price_tier:
description: ''
properties:
flat_amount:
description: Price for the entire tier.
nullable: true
type: integer
flat_amount_decimal:
description: Same as `flat_amount`, but contains a decimal value with at
most 12 decimal places.
format: decimal
nullable: true
type: string
unit_amount:
description: Per unit price for units relevant to the tier.
nullable: true
type: integer
unit_amount_decimal:
description: Same as `unit_amount`, but contains a decimal value with at
most 12 decimal places.
format: decimal
nullable: true
type: string
up_to:
description: Up to and including to this quantity will be contained in the
tier.
nullable: true
type: integer
title: PriceTier
type: object
x-expandableFields: []
product:
description: |-
Products describe the specific goods or services you offer to your customers.
For example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product.
They can be used in conjunction with [Prices](https://stripe.com/docs/api#prices) to configure pricing in Checkout and Subscriptions.
Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription) or accept [one-time payments with Checkout](https://stripe.com/docs/payments/checkout/client#create-products) and more about [Products and Prices](https://stripe.com/docs/billing/prices-guide)
properties:
active:
description: Whether the product is currently available for purchase.
type: boolean
attributes:
description: A list of up to 5 attributes that each SKU can provide values
for (e.g., `["color", "size"]`).
items:
maxLength: 5000
type: string
nullable: true
type: array
caption:
description: A short one-line description of the product, meant to be displayable
to the customer. Only applicable to products of `type=good`.
maxLength: 5000
nullable: true
type: string
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
deactivate_on:
description: An array of connect application identifiers that cannot purchase
this product. Only applicable to products of `type=good`.
items:
maxLength: 5000
type: string
type: array
description:
description: The product's description, meant to be displayable to the customer.
Use this field to optionally store a long form explanation of the product
being sold for your own rendering purposes.
maxLength: 5000
nullable: true
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
images:
description: A list of up to 8 URLs of images for this product, meant to
be displayable to the customer.
items:
maxLength: 5000
type: string
type: array
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
name:
description: The product's name, meant to be displayable to the customer.
Whenever this product is sold via a subscription, name will show up on
associated invoice line item descriptions.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- product
type: string
package_dimensions:
anyOf:
- "$ref": "#/components/schemas/package_dimensions"
description: The dimensions of this product for shipping purposes. A SKU
associated with this product can override this value by having its own
`package_dimensions`. Only applicable to products of `type=good`.
nullable: true
shippable:
description: Whether this product is a shipped good. Only applicable to
products of `type=good`.
nullable: true
type: boolean
statement_descriptor:
description: Extra information about a product which will appear on your
customer's credit card statement. In the case that multiple products are
billed at once, the first statement descriptor will be used.
maxLength: 5000
nullable: true
type: string
type:
description: The type of the product. The product is either of type `good`,
which is eligible for use with Orders and SKUs, or `service`, which is
eligible for use with Subscriptions and Plans.
enum:
- good
- service
type: string
unit_label:
description: A label that represents units of this product in Stripe and
on customers’ receipts and invoices. When set, this will be included in
associated invoice line item descriptions.
maxLength: 5000
nullable: true
type: string
updated:
description: Time at which the object was last updated. Measured in seconds
since the Unix epoch.
format: unix-time
type: integer
url:
description: A URL of a publicly-accessible webpage for this product. Only
applicable to products of `type=good`.
maxLength: 2048
nullable: true
type: string
required:
- active
- created
- id
- images
- livemode
- metadata
- name
- object
- type
- updated
title: Product
type: object
x-expandableFields:
- package_dimensions
x-resourceId: product
radar.early_fraud_warning:
description: |-
An early fraud warning indicates that the card issuer has notified us that a
charge may be fraudulent.
Related guide: [Early Fraud Warnings](https://stripe.com/docs/disputes/measuring#early-fraud-warnings).
properties:
actionable:
description: An EFW is actionable if it has not received a dispute and has
not been fully refunded. You may wish to proactively refund a charge that
receives an EFW, in order to avoid receiving a dispute later.
type: boolean
charge:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/charge"
description: ID of the charge this early fraud warning is for, optionally
expanded.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/charge"
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
fraud_type:
description: The type of fraud labelled by the issuer. One of `card_never_received`,
`fraudulent_card_application`, `made_with_counterfeit_card`, `made_with_lost_card`,
`made_with_stolen_card`, `misc`, `unauthorized_use_of_card`.
maxLength: 5000
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- radar.early_fraud_warning
type: string
required:
- actionable
- charge
- created
- fraud_type
- id
- livemode
- object
title: RadarEarlyFraudWarning
type: object
x-expandableFields:
- charge
x-resourceId: radar.early_fraud_warning
radar.value_list:
description: |-
Value lists allow you to group values together which can then be referenced in rules.
Related guide: [Default Stripe Lists](https://stripe.com/docs/radar/lists#managing-list-items).
properties:
alias:
description: The name of the value list for use in rules.
maxLength: 5000
type: string
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
created_by:
description: The name or email address of the user who created this value
list.
maxLength: 5000
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
item_type:
description: The type of items in the value list. One of `card_fingerprint`,
`card_bin`, `email`, `ip_address`, `country`, `string`, or `case_sensitive_string`.
enum:
- card_bin
- card_fingerprint
- case_sensitive_string
- country
- email
- ip_address
- string
type: string
list_items:
description: List of items contained within this value list.
properties:
data:
description: Details about each object.
items:
"$ref": "#/components/schemas/radar.value_list_item"
type: array
has_more:
description: True if this list has another page of items after this
one that can be fetched.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value. Always has the value `list`.
enum:
- list
type: string
url:
description: The URL where this list can be accessed.
maxLength: 5000
type: string
required:
- data
- has_more
- object
- url
title: RadarListListItemList
type: object
x-expandableFields:
- data
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
name:
description: The name of the value list.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- radar.value_list
type: string
required:
- alias
- created
- created_by
- id
- item_type
- list_items
- livemode
- metadata
- name
- object
title: RadarListList
type: object
x-expandableFields:
- list_items
x-resourceId: radar.value_list
radar.value_list_item:
description: |-
Value list items allow you to add specific values to a given Radar value list, which can then be used in rules.
Related guide: [Managing List Items](https://stripe.com/docs/radar/lists#managing-list-items).
properties:
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
created_by:
description: The name or email address of the user who added this item to
the value list.
maxLength: 5000
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- radar.value_list_item
type: string
value:
description: The value of the item.
maxLength: 5000
type: string
value_list:
description: The identifier of the value list this item belongs to.
maxLength: 5000
type: string
required:
- created
- created_by
- id
- livemode
- object
- value
- value_list
title: RadarListListItem
type: object
x-expandableFields: []
x-resourceId: radar.value_list_item
radar_review_resource_location:
description: ''
properties:
city:
description: The city where the payment originated.
maxLength: 5000
nullable: true
type: string
country:
description: Two-letter ISO code representing the country where the payment
originated.
maxLength: 5000
nullable: true
type: string
latitude:
description: The geographic latitude where the payment originated.
nullable: true
type: number
longitude:
description: The geographic longitude where the payment originated.
nullable: true
type: number
region:
description: The state/county/province/region where the payment originated.
maxLength: 5000
nullable: true
type: string
title: RadarReviewResourceLocation
type: object
x-expandableFields: []
radar_review_resource_session:
description: ''
properties:
browser:
description: The browser used in this browser session (e.g., `Chrome`).
maxLength: 5000
nullable: true
type: string
device:
description: Information about the device used for the browser session (e.g.,
`Samsung SM-G930T`).
maxLength: 5000
nullable: true
type: string
platform:
description: The platform for the browser session (e.g., `Macintosh`).
maxLength: 5000
nullable: true
type: string
version:
description: The version for the browser session (e.g., `61.0.3163.100`).
maxLength: 5000
nullable: true
type: string
title: RadarReviewResourceSession
type: object
x-expandableFields: []
recipient:
description: |-
With `Recipient` objects, you can transfer money from your Stripe account to a
third-party bank account or debit card. The API allows you to create, delete,
and update your recipients. You can retrieve individual recipients as well as
a list of all your recipients.
**`Recipient` objects have been deprecated in favor of
[Connect](https://stripe.com/docs/connect), specifically Connect's much more powerful
[Account objects](https://stripe.com/docs/api#account). Stripe accounts that don't already use
recipients can no longer begin doing so. Please use `Account` objects
instead. If you are already using recipients, please see our
[migration guide](https://stripe.com/docs/connect/recipient-account-migrations) for more information.**
properties:
active_account:
anyOf:
- "$ref": "#/components/schemas/bank_account"
description: Hash describing the current account on the recipient, if there
is one.
nullable: true
cards:
description: ''
nullable: true
properties:
data:
items:
"$ref": "#/components/schemas/card"
type: array
has_more:
description: True if this list has another page of items after this
one that can be fetched.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value. Always has the value `list`.
enum:
- list
type: string
url:
description: The URL where this list can be accessed.
maxLength: 5000
type: string
required:
- data
- has_more
- object
- url
title: CardList
type: object
x-expandableFields:
- data
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
default_card:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/card"
description: The default card to use for creating transfers to this recipient.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/card"
description:
description: An arbitrary string attached to the object. Often useful for
displaying to users.
maxLength: 5000
nullable: true
type: string
email:
maxLength: 5000
nullable: true
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
migrated_to:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/account"
description: 'The ID of the [Custom account](https://stripe.com/docs/connect/custom-accounts)
this recipient was migrated to. If set, the recipient can no longer be
updated, nor can transfers be made to it: use the Custom account instead.'
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/account"
name:
description: Full, legal name of the recipient.
maxLength: 5000
nullable: true
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- recipient
type: string
rolled_back_from:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/account"
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/account"
type:
description: Type of the recipient, one of `individual` or `corporation`.
maxLength: 5000
type: string
required:
- created
- id
- livemode
- metadata
- object
- type
title: TransferRecipient
type: object
x-expandableFields:
- active_account
- cards
- default_card
- migrated_to
- rolled_back_from
x-resourceId: recipient
recurring:
description: ''
properties:
aggregate_usage:
description: Specifies a usage aggregation strategy for prices of `usage_type=metered`.
Allowed values are `sum` for summing up all usage during a period, `last_during_period`
for using the last usage record reported within a period, `last_ever`
for using the last usage record ever (across period bounds) or `max` which
uses the usage record with the maximum reported usage during a period.
Defaults to `sum`.
enum:
- last_during_period
- last_ever
- max
- sum
nullable: true
type: string
interval:
description: The frequency at which a subscription is billed. One of `day`,
`week`, `month` or `year`.
enum:
- day
- month
- week
- year
type: string
interval_count:
description: The number of intervals (specified in the `interval` attribute)
between subscription billings. For example, `interval=month` and `interval_count=3`
bills every 3 months.
type: integer
usage_type:
description: Configures how the quantity per period should be determined.
Can be either `metered` or `licensed`. `licensed` automatically bills
the `quantity` set when adding it to a subscription. `metered` aggregates
the total usage based on usage records. Defaults to `licensed`.
enum:
- licensed
- metered
type: string
required:
- interval
- interval_count
- usage_type
title: Recurring
type: object
x-expandableFields: []
refund:
description: |-
`Refund` objects allow you to 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.
Related guide: [Refunds](https://stripe.com/docs/refunds).
properties:
amount:
description: Amount, in %s.
type: integer
balance_transaction:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/balance_transaction"
description: Balance transaction that describes the impact on your account
balance.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/balance_transaction"
charge:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/charge"
description: ID of the charge that was refunded.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/charge"
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
description:
description: An arbitrary string attached to the object. Often useful for
displaying to users. (Available on non-card refunds only)
maxLength: 5000
type: string
failure_balance_transaction:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/balance_transaction"
description: If the refund failed, this balance transaction describes the
adjustment made on your account balance that reverses the initial balance
transaction.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/balance_transaction"
failure_reason:
description: If the refund failed, the reason for refund failure if known.
Possible values are `lost_or_stolen_card`, `expired_or_canceled_card`,
or `unknown`.
maxLength: 5000
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- refund
type: string
payment_intent:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/payment_intent"
description: ID of the PaymentIntent that was refunded.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/payment_intent"
reason:
description: Reason for the refund, either user-provided (`duplicate`, `fraudulent`,
or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`).
maxLength: 5000
nullable: true
type: string
receipt_number:
description: This is the transaction number that appears on email receipts
sent for this refund.
maxLength: 5000
nullable: true
type: string
source_transfer_reversal:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/transfer_reversal"
description: The transfer reversal that is associated with the refund. Only
present if the charge came from another Stripe account. See the Connect
documentation for details.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/transfer_reversal"
status:
description: Status of the refund. For credit card refunds, this can be
`pending`, `succeeded`, or `failed`. For other types of refunds, it can
be `pending`, `succeeded`, `failed`, or `canceled`. Refer to our [refunds](https://stripe.com/docs/refunds#failed-refunds)
documentation for more details.
maxLength: 5000
nullable: true
type: string
transfer_reversal:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/transfer_reversal"
description: If the accompanying transfer was reversed, the transfer reversal
object. Only applicable if the charge was created using the destination
parameter.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/transfer_reversal"
required:
- amount
- created
- currency
- id
- metadata
- object
title: Refund
type: object
x-expandableFields:
- balance_transaction
- charge
- failure_balance_transaction
- payment_intent
- source_transfer_reversal
- transfer_reversal
x-resourceId: refund
reporting.report_run:
description: |-
The Report Run object represents an instance of a report type generated with
specific run parameters. Once the object is created, Stripe begins processing the report.
When the report has finished running, it will give you a reference to a file
where you can retrieve your results. For an overview, see
[API Access to Reports](https://stripe.com/docs/reporting/statements/api).
Note that reports can only be run based on your live-mode data (not test-mode
data), and thus related requests must be made with a
[live-mode API key](https://stripe.com/docs/keys#test-live-modes).
properties:
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
error:
description: |-
If something should go wrong during the run, a message about the failure (populated when
`status=failed`).
maxLength: 5000
nullable: true
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: 'Always `true`: reports can only be run on live-mode data.'
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- reporting.report_run
type: string
parameters:
"$ref": "#/components/schemas/financial_reporting_finance_report_run_run_parameters"
report_type:
description: The ID of the [report type](https://stripe.com/docs/reporting/statements/api#report-types)
to run, such as `"balance.summary.1"`.
maxLength: 5000
type: string
result:
anyOf:
- "$ref": "#/components/schemas/file"
description: |-
The file object representing the result of the report run (populated when
`status=succeeded`).
nullable: true
status:
description: |-
Status of this report run. This will be `pending` when the run is initially created.
When the run finishes, this will be set to `succeeded` and the `result` field will be populated.
Rarely, we may encounter an error, at which point this will be set to `failed` and the `error` field will be populated.
maxLength: 5000
type: string
succeeded_at:
description: |-
Timestamp at which this run successfully finished (populated when
`status=succeeded`). Measured in seconds since the Unix epoch.
format: unix-time
nullable: true
type: integer
required:
- created
- id
- livemode
- object
- parameters
- report_type
- status
title: reporting_report_run
type: object
x-expandableFields:
- parameters
- result
x-resourceId: reporting.report_run
reporting.report_type:
description: |-
The Report Type resource corresponds to a particular type of report, such as
the "Activity summary" or "Itemized payouts" reports. These objects are
identified by an ID belonging to a set of enumerated values. See
[API Access to Reports documentation](https://stripe.com/docs/reporting/statements/api)
for those Report Type IDs, along with required and optional parameters.
Note that reports can only be run based on your live-mode data (not test-mode
data), and thus related requests must be made with a
[live-mode API key](https://stripe.com/docs/keys#test-live-modes).
properties:
data_available_end:
description: Most recent time for which this Report Type is available. Measured
in seconds since the Unix epoch.
format: unix-time
type: integer
data_available_start:
description: Earliest time for which this Report Type is available. Measured
in seconds since the Unix epoch.
format: unix-time
type: integer
default_columns:
description: List of column names that are included by default when this
Report Type gets run. (If the Report Type doesn't support the `columns`
parameter, this will be null.)
items:
maxLength: 5000
type: string
nullable: true
type: array
id:
description: The [ID of the Report Type](https://stripe.com/docs/reporting/statements/api#available-report-types),
such as `balance.summary.1`.
maxLength: 5000
type: string
name:
description: Human-readable name of the Report Type
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- reporting.report_type
type: string
updated:
description: When this Report Type was latest updated. Measured in seconds
since the Unix epoch.
format: unix-time
type: integer
version:
description: Version of the Report Type. Different versions report with
the same ID will have the same purpose, but may take different run parameters
or have different result schemas.
type: integer
required:
- data_available_end
- data_available_start
- id
- name
- object
- updated
- version
title: reporting_report_type
type: object
x-expandableFields: []
x-resourceId: reporting.report_type
reserve_transaction:
description: ''
properties:
amount:
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
description:
description: An arbitrary string attached to the object. Often useful for
displaying to users.
maxLength: 5000
nullable: true
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- reserve_transaction
type: string
required:
- amount
- currency
- id
- object
title: ReserveTransaction
type: object
x-expandableFields: []
review:
description: |-
Reviews can be used to supplement automated fraud detection with human expertise.
Learn more about [Radar](/radar) and reviewing payments
[here](https://stripe.com/docs/radar/reviews).
properties:
billing_zip:
description: The ZIP or postal code of the card used, if applicable.
maxLength: 5000
nullable: true
type: string
charge:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/charge"
description: The charge associated with this review.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/charge"
closed_reason:
description: The reason the review was closed, or null if it has not yet
been closed. One of `approved`, `refunded`, `refunded_as_fraud`, or `disputed`.
enum:
- approved
- disputed
- refunded
- refunded_as_fraud
nullable: true
type: string
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
ip_address:
description: The IP address where the payment originated.
maxLength: 5000
nullable: true
type: string
ip_address_location:
anyOf:
- "$ref": "#/components/schemas/radar_review_resource_location"
description: Information related to the location of the payment. Note that
this information is an approximation and attempts to locate the nearest
population center - it should not be used to determine a specific address.
nullable: true
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- review
type: string
open:
description: If `true`, the review needs action.
type: boolean
opened_reason:
description: The reason the review was opened. One of `rule` or `manual`.
enum:
- manual
- rule
type: string
payment_intent:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/payment_intent"
description: The PaymentIntent ID associated with this review, if one exists.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/payment_intent"
reason:
description: The reason the review is currently open or closed. One of `rule`,
`manual`, `approved`, `refunded`, `refunded_as_fraud`, or `disputed`.
maxLength: 5000
type: string
session:
anyOf:
- "$ref": "#/components/schemas/radar_review_resource_session"
description: Information related to the browsing session of the user who
initiated the payment.
nullable: true
required:
- created
- id
- livemode
- object
- open
- opened_reason
- reason
title: RadarReview
type: object
x-expandableFields:
- charge
- ip_address_location
- payment_intent
- session
x-resourceId: review
rule:
description: ''
properties:
action:
description: The action taken on the payment.
maxLength: 5000
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
predicate:
description: The predicate to evaluate the payment against.
maxLength: 5000
type: string
required:
- action
- id
- predicate
title: RadarRule
type: object
x-expandableFields: []
scheduled_query_run:
description: |-
If you have [scheduled a Sigma query](https://stripe.com/docs/sigma/scheduled-queries), you'll
receive a `sigma.scheduled_query_run.created` webhook each time the query
runs. The webhook contains a `ScheduledQueryRun` object, which you can use to
retrieve the query results.
properties:
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
data_load_time:
description: When the query was run, Sigma contained a snapshot of your
Stripe data at this time.
format: unix-time
type: integer
error:
"$ref": "#/components/schemas/sigma_scheduled_query_run_error"
file:
anyOf:
- "$ref": "#/components/schemas/file"
description: The file object representing the results of the query.
nullable: true
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- scheduled_query_run
type: string
result_available_until:
description: Time at which the result expires and is no longer available
for download.
format: unix-time
type: integer
sql:
description: SQL for the query.
maxLength: 100000
type: string
status:
description: The query's execution status, which will be `completed` for
successful runs, and `canceled`, `failed`, or `timed_out` otherwise.
maxLength: 5000
type: string
title:
description: Title of the query.
maxLength: 5000
type: string
required:
- created
- data_load_time
- id
- livemode
- object
- result_available_until
- sql
- status
- title
title: ScheduledQueryRun
type: object
x-expandableFields:
- error
- file
x-resourceId: scheduled_query_run
setup_intent:
description: |-
A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.
For example, you could use a SetupIntent to set up and save your customer's card without immediately collecting a payment.
Later, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow.
Create a SetupIntent as soon as you're ready to collect your customer's payment credentials.
Do not maintain long-lived, unconfirmed SetupIntents as they may no longer be valid.
The SetupIntent then transitions through multiple [statuses](https://stripe.com/docs/payments/intents#intent-statuses) as it guides
you through the setup process.
Successful SetupIntents result in payment credentials that are optimized for future payments.
For example, cardholders in [certain regions](/guides/strong-customer-authentication) may need to be run through
[Strong Customer Authentication](https://stripe.com/docs/strong-customer-authentication) at the time of payment method collection
in order to streamline later [off-session payments](https://stripe.com/docs/payments/setup-intents).
If the SetupIntent is used with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer), upon success,
it will automatically attach the resulting payment method to that Customer.
We recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on
PaymentIntents to save payment methods in order to prevent saving invalid or unoptimized payment methods.
By using SetupIntents, you ensure that your customers experience the minimum set of required friction,
even as regulations change over time.
Related guide: [Setup Intents API](https://stripe.com/docs/payments/setup-intents).
properties:
application:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/application"
description: ID of the Connect application that created the SetupIntent.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/application"
cancellation_reason:
description: Reason for cancellation of this SetupIntent, one of `abandoned`,
`requested_by_customer`, or `duplicate`.
enum:
- abandoned
- duplicate
- requested_by_customer
nullable: true
type: string
client_secret:
description: |-
The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.
The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.
maxLength: 5000
nullable: true
type: string
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
customer:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/customer"
- "$ref": "#/components/schemas/deleted_customer"
description: |-
ID of the Customer this SetupIntent belongs to, if one exists.
If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/customer"
- "$ref": "#/components/schemas/deleted_customer"
description:
description: An arbitrary string attached to the object. Often useful for
displaying to users.
maxLength: 5000
nullable: true
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
last_setup_error:
anyOf:
- "$ref": "#/components/schemas/api_errors"
description: The error encountered in the previous SetupIntent confirmation.
nullable: true
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
mandate:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/mandate"
description: ID of the multi use Mandate generated by the SetupIntent.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/mandate"
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
next_action:
anyOf:
- "$ref": "#/components/schemas/setup_intent_next_action"
description: If present, this property tells you what actions you need to
take in order for your customer to continue payment setup.
nullable: true
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- setup_intent
type: string
on_behalf_of:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/account"
description: The account (if any) for which the setup is intended.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/account"
payment_method:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/payment_method"
description: ID of the payment method used with this SetupIntent.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/payment_method"
payment_method_options:
anyOf:
- "$ref": "#/components/schemas/setup_intent_payment_method_options"
description: Payment-method-specific configuration for this SetupIntent.
nullable: true
payment_method_types:
description: The list of payment method types (e.g. card) that this SetupIntent
is allowed to set up.
items:
maxLength: 5000
type: string
type: array
single_use_mandate:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/mandate"
description: ID of the single_use Mandate generated by the SetupIntent.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/mandate"
status:
description: "[Status](https://stripe.com/docs/payments/intents#intent-statuses)
of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`,
`requires_action`, `processing`, `canceled`, or `succeeded`."
enum:
- canceled
- processing
- requires_action
- requires_confirmation
- requires_payment_method
- succeeded
type: string
usage:
description: |-
Indicates how the payment method is intended to be used in the future.
Use `on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`.
maxLength: 5000
type: string
required:
- created
- id
- livemode
- object
- payment_method_types
- status
- usage
title: SetupIntent
type: object
x-expandableFields:
- application
- customer
- last_setup_error
- mandate
- next_action
- on_behalf_of
- payment_method
- payment_method_options
- single_use_mandate
x-resourceId: setup_intent
setup_intent_next_action:
description: ''
properties:
redirect_to_url:
"$ref": "#/components/schemas/setup_intent_next_action_redirect_to_url"
type:
description: Type of the next action to perform, one of `redirect_to_url`
or `use_stripe_sdk`.
maxLength: 5000
type: string
use_stripe_sdk:
description: When confirming a SetupIntent with Stripe.js, Stripe.js depends
on the contents of this dictionary to invoke authentication flows. The
shape of the contents is subject to change and is only intended to be
used by Stripe.js.
type: object
required:
- type
title: SetupIntentNextAction
type: object
x-expandableFields:
- redirect_to_url
setup_intent_next_action_redirect_to_url:
description: ''
properties:
return_url:
description: If the customer does not exit their browser while authenticating,
they will be redirected to this specified URL after completion.
maxLength: 5000
nullable: true
type: string
url:
description: The URL you must redirect your customer to in order to authenticate.
maxLength: 5000
nullable: true
type: string
title: SetupIntentNextActionRedirectToUrl
type: object
x-expandableFields: []
setup_intent_payment_method_options:
description: ''
properties:
card:
"$ref": "#/components/schemas/setup_intent_payment_method_options_card"
title: SetupIntentPaymentMethodOptions
type: object
x-expandableFields:
- card
setup_intent_payment_method_options_card:
description: ''
properties:
request_three_d_secure:
description: 'We strongly recommend that you rely on our SCA Engine to automatically
prompt your customers for authentication based on risk level and [other
requirements](https://stripe.com/docs/strong-customer-authentication).
However, if you wish to request 3D Secure based on logic from your own
fraud engine, provide this option. Permitted values include: `automatic`
or `any`. If not provided, defaults to `automatic`. Read our guide on
[manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds)
for more information on how this configuration interacts with Radar and
our SCA Engine.'
enum:
- any
- automatic
- challenge_only
nullable: true
type: string
title: setup_intent_payment_method_options_card
type: object
x-expandableFields: []
shipping:
description: ''
properties:
address:
"$ref": "#/components/schemas/address"
carrier:
description: The delivery service that shipped a physical product, such
as Fedex, UPS, USPS, etc.
maxLength: 5000
nullable: true
type: string
name:
description: Recipient name.
maxLength: 5000
nullable: true
type: string
phone:
description: Recipient phone (including extension).
maxLength: 5000
nullable: true
type: string
tracking_number:
description: 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.
maxLength: 5000
nullable: true
type: string
title: Shipping
type: object
x-expandableFields:
- address
shipping_method:
description: ''
properties:
amount:
description: A positive integer in the smallest currency unit (that is,
100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency)
representing the total amount for the line item.
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
delivery_estimate:
anyOf:
- "$ref": "#/components/schemas/delivery_estimate"
description: The estimated delivery date for the given shipping method.
Can be either a specific date or a range.
nullable: true
description:
description: An arbitrary string attached to the object. Often useful for
displaying to users.
maxLength: 5000
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
required:
- amount
- currency
- description
- id
title: ShippingMethod
type: object
x-expandableFields:
- delivery_estimate
sigma_scheduled_query_run_error:
description: ''
properties:
message:
description: Information about the run failure.
maxLength: 5000
type: string
required:
- message
title: SigmaScheduledQueryRunError
type: object
x-expandableFields: []
sku:
description: |-
Stores representations of [stock keeping units](http://en.wikipedia.org/wiki/Stock_keeping_unit).
SKUs describe specific product variations, taking into account any combination of: attributes,
currency, and cost. For example, a product may be a T-shirt, whereas a specific SKU represents
the `size: large`, `color: red` version of that shirt.
Can also be used to manage inventory.
Related guide: [Tax, Shipping, and Inventory](https://stripe.com/docs/orders).
properties:
active:
description: Whether the SKU is available for purchase.
type: boolean
attributes:
additionalProperties:
maxLength: 5000
type: string
description: 'A dictionary of attributes and values for the attributes defined
by the product. If, for example, a product''s attributes are `["size",
"gender"]`, a valid SKU has the following dictionary of attributes: `{"size":
"Medium", "gender": "Unisex"}`.'
type: object
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
image:
description: The URL of an image for this SKU, meant to be displayable to
the customer.
maxLength: 2048
nullable: true
type: string
inventory:
"$ref": "#/components/schemas/inventory"
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- sku
type: string
package_dimensions:
anyOf:
- "$ref": "#/components/schemas/package_dimensions"
description: The dimensions of this SKU for shipping purposes.
nullable: true
price:
description: The cost of the item as a positive integer in the smallest
currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100,
Japanese Yen being a zero-decimal currency).
type: integer
product:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/product"
description: The ID of the product this SKU is associated with. The product
must be currently active.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/product"
updated:
description: Time at which the object was last updated. Measured in seconds
since the Unix epoch.
format: unix-time
type: integer
required:
- active
- attributes
- created
- currency
- id
- inventory
- livemode
- metadata
- object
- price
- product
- updated
title: SKU
type: object
x-expandableFields:
- inventory
- package_dimensions
- product
x-resourceId: sku
source:
description: |-
`Source` objects allow you to accept a variety of payment methods. They
represent a customer's payment instrument, and can be used with the Stripe API
just like a `Card` object: once chargeable, they can be charged, or can be
attached to customers.
Related guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers).
properties:
ach_credit_transfer:
"$ref": "#/components/schemas/source_type_ach_credit_transfer"
ach_debit:
"$ref": "#/components/schemas/source_type_ach_debit"
alipay:
"$ref": "#/components/schemas/source_type_alipay"
amount:
description: A positive integer in the smallest currency unit (that is,
100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency)
representing the total amount associated with the source. This is the
amount for which the source will be chargeable once ready. Required for
`single_use` sources.
nullable: true
type: integer
au_becs_debit:
"$ref": "#/components/schemas/source_type_au_becs_debit"
bancontact:
"$ref": "#/components/schemas/source_type_bancontact"
card:
"$ref": "#/components/schemas/source_type_card"
card_present:
"$ref": "#/components/schemas/source_type_card_present"
client_secret:
description: The client secret of the source. Used for client-side retrieval
using a publishable key.
maxLength: 5000
type: string
code_verification:
"$ref": "#/components/schemas/source_code_verification_flow"
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
currency:
description: Three-letter [ISO code for the currency](https://stripe.com/docs/currencies)
associated with the source. This is the currency for which the source
will be chargeable once ready. Required for `single_use` sources.
nullable: true
type: string
customer:
description: The ID of the customer to which this source is attached. This
will not be present when the source has not been attached to a customer.
maxLength: 5000
type: string
eps:
"$ref": "#/components/schemas/source_type_eps"
flow:
description: The authentication `flow` of the source. `flow` is one of `redirect`,
`receiver`, `code_verification`, `none`.
maxLength: 5000
type: string
giropay:
"$ref": "#/components/schemas/source_type_giropay"
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
ideal:
"$ref": "#/components/schemas/source_type_ideal"
klarna:
"$ref": "#/components/schemas/source_type_klarna"
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
nullable: true
type: object
multibanco:
"$ref": "#/components/schemas/source_type_multibanco"
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- source
type: string
owner:
anyOf:
- "$ref": "#/components/schemas/source_owner"
description: Information about the owner of the payment instrument that
may be used or required by particular source types.
nullable: true
p24:
"$ref": "#/components/schemas/source_type_p24"
receiver:
"$ref": "#/components/schemas/source_receiver_flow"
redirect:
"$ref": "#/components/schemas/source_redirect_flow"
sepa_debit:
"$ref": "#/components/schemas/source_type_sepa_debit"
sofort:
"$ref": "#/components/schemas/source_type_sofort"
source_order:
"$ref": "#/components/schemas/source_order"
statement_descriptor:
description: Extra information about a source. This will appear on your
customer's statement every time you charge the source.
maxLength: 5000
nullable: true
type: string
status:
description: The status of the source, one of `canceled`, `chargeable`,
`consumed`, `failed`, or `pending`. Only `chargeable` sources can be used
to create a charge.
maxLength: 5000
type: string
three_d_secure:
"$ref": "#/components/schemas/source_type_three_d_secure"
type:
description: The `type` of the source. The `type` is a payment method, one
of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`,
`card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`,
`sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash
is included on the source with a name matching this value. It contains
additional information specific to the [payment method](https://stripe.com/docs/sources)
used.
enum:
- ach_credit_transfer
- ach_debit
- alipay
- au_becs_debit
- bancontact
- card
- card_present
- eps
- giropay
- ideal
- klarna
- multibanco
- p24
- sepa_debit
- sofort
- three_d_secure
- wechat
type: string
x-stripeBypassValidation: true
usage:
description: Either `reusable` or `single_use`. Whether this source should
be reusable or not. Some source types may or may not be reusable by construction,
while others may leave the option at creation. If an incompatible value
is passed, an error will be returned.
maxLength: 5000
nullable: true
type: string
wechat:
"$ref": "#/components/schemas/source_type_wechat"
required:
- client_secret
- created
- flow
- id
- livemode
- object
- status
- type
title: Source
type: object
x-expandableFields:
- code_verification
- owner
- receiver
- redirect
- source_order
x-resourceId: source
source_code_verification_flow:
description: ''
properties:
attempts_remaining:
description: The number of attempts remaining to authenticate the source
object with a verification code.
type: integer
status:
description: The status of the code verification, either `pending` (awaiting
verification, `attempts_remaining` should be greater than 0), `succeeded`
(successful verification) or `failed` (failed verification, cannot be
verified anymore as `attempts_remaining` should be 0).
maxLength: 5000
type: string
required:
- attempts_remaining
- status
title: SourceCodeVerificationFlow
type: object
x-expandableFields: []
source_mandate_notification:
description: |-
Source mandate notifications should be created when a notification related to
a source mandate must be sent to the payer. They will trigger a webhook or
deliver an email to the customer.
properties:
acss_debit:
"$ref": "#/components/schemas/source_mandate_notification_acss_debit_data"
amount:
description: A positive integer in the smallest currency unit (that is,
100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency)
representing the amount associated with the mandate notification. The
amount is expressed in the currency of the underlying source. Required
if the notification type is `debit_initiated`.
nullable: true
type: integer
bacs_debit:
"$ref": "#/components/schemas/source_mandate_notification_bacs_debit_data"
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- source_mandate_notification
type: string
reason:
description: The reason of the mandate notification. Valid reasons are `mandate_confirmed`
or `debit_initiated`.
maxLength: 5000
type: string
sepa_debit:
"$ref": "#/components/schemas/source_mandate_notification_sepa_debit_data"
source:
"$ref": "#/components/schemas/source"
status:
description: The status of the mandate notification. Valid statuses are
`pending` or `submitted`.
maxLength: 5000
type: string
type:
description: The type of source this mandate notification is attached to.
Should be the source type identifier code for the payment method, such
as `three_d_secure`.
maxLength: 5000
type: string
required:
- created
- id
- livemode
- object
- reason
- source
- status
- type
title: SourceMandateNotification
type: object
x-expandableFields:
- acss_debit
- bacs_debit
- sepa_debit
- source
x-resourceId: source_mandate_notification
source_mandate_notification_acss_debit_data:
description: ''
properties:
statement_descriptor:
description: The statement descriptor associate with the debit.
maxLength: 5000
type: string
title: SourceMandateNotificationAcssDebitData
type: object
x-expandableFields: []
source_mandate_notification_bacs_debit_data:
description: ''
properties:
last4:
description: Last 4 digits of the account number associated with the debit.
maxLength: 5000
type: string
title: SourceMandateNotificationBacsDebitData
type: object
x-expandableFields: []
source_mandate_notification_sepa_debit_data:
description: ''
properties:
creditor_identifier:
description: SEPA creditor ID.
maxLength: 5000
type: string
last4:
description: Last 4 digits of the account number associated with the debit.
maxLength: 5000
type: string
mandate_reference:
description: Mandate reference associated with the debit.
maxLength: 5000
type: string
title: SourceMandateNotificationSepaDebitData
type: object
x-expandableFields: []
source_order:
description: ''
properties:
amount:
description: A positive integer in the smallest currency unit (that is,
100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency)
representing the total amount for the order.
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
email:
description: The email address of the customer placing the order.
maxLength: 5000
type: string
items:
description: List of items constituting the order.
items:
"$ref": "#/components/schemas/source_order_item"
nullable: true
type: array
shipping:
"$ref": "#/components/schemas/shipping"
required:
- amount
- currency
title: SourceOrder
type: object
x-expandableFields:
- items
- shipping
source_order_item:
description: ''
properties:
amount:
description: The amount (price) for this order item.
nullable: true
type: integer
currency:
description: This currency of this order item. Required when `amount` is
present.
maxLength: 5000
nullable: true
type: string
description:
description: Human-readable description for this order item.
maxLength: 5000
nullable: true
type: string
parent:
description: The ID of the associated object for this line item. Expandable
if not null (e.g., expandable to a SKU).
maxLength: 5000
nullable: true
type: string
quantity:
description: The quantity of this order item. When type is `sku`, this is
the number of instances of the SKU to be ordered.
type: integer
type:
description: The type of this order item. Must be `sku`, `tax`, or `shipping`.
maxLength: 5000
nullable: true
type: string
title: SourceOrderItem
type: object
x-expandableFields: []
source_owner:
description: ''
properties:
address:
anyOf:
- "$ref": "#/components/schemas/address"
description: Owner's address.
nullable: true
email:
description: Owner's email address.
maxLength: 5000
nullable: true
type: string
name:
description: Owner's full name.
maxLength: 5000
nullable: true
type: string
phone:
description: Owner's phone number (including extension).
maxLength: 5000
nullable: true
type: string
verified_address:
anyOf:
- "$ref": "#/components/schemas/address"
description: Verified owner's address. Verified values are verified or provided
by the payment method directly (and if supported) at the time of authorization
or settlement. They cannot be set or mutated.
nullable: true
verified_email:
description: Verified owner's email address. Verified values are verified
or provided by the payment method directly (and if supported) at the time
of authorization or settlement. They cannot be set or mutated.
maxLength: 5000
nullable: true
type: string
verified_name:
description: Verified owner's full name. Verified values are verified or
provided by the payment method directly (and if supported) at the time
of authorization or settlement. They cannot be set or mutated.
maxLength: 5000
nullable: true
type: string
verified_phone:
description: Verified owner's phone number (including extension). Verified
values are verified or provided by the payment method directly (and if
supported) at the time of authorization or settlement. They cannot be
set or mutated.
maxLength: 5000
nullable: true
type: string
title: SourceOwner
type: object
x-expandableFields:
- address
- verified_address
source_receiver_flow:
description: ''
properties:
address:
description: The address of the receiver source. This is the value that
should be communicated to the customer to send their funds to.
maxLength: 5000
nullable: true
type: string
amount_charged:
description: The total amount that was moved to your balance. This is almost
always equal to the amount charged. In rare cases when customers deposit
excess funds and we are unable to refund those, those funds get moved
to your balance and show up in amount_charged as well. The amount charged
is expressed in the source's currency.
type: integer
amount_received:
description: The total amount received by the receiver source. `amount_received
= amount_returned + amount_charged` should be true for consumed sources
unless customers deposit excess funds. The amount received is expressed
in the source's currency.
type: integer
amount_returned:
description: The total amount that was returned to the customer. The amount
returned is expressed in the source's currency.
type: integer
refund_attributes_method:
description: Type of refund attribute method, one of `email`, `manual`,
or `none`.
maxLength: 5000
type: string
refund_attributes_status:
description: Type of refund attribute status, one of `missing`, `requested`,
or `available`.
maxLength: 5000
type: string
required:
- amount_charged
- amount_received
- amount_returned
- refund_attributes_method
- refund_attributes_status
title: SourceReceiverFlow
type: object
x-expandableFields: []
source_redirect_flow:
description: ''
properties:
failure_reason:
description: The failure reason for the redirect, either `user_abort` (the
customer aborted or dropped out of the redirect flow), `declined` (the
authentication failed or the transaction was declined), or `processing_error`
(the redirect failed due to a technical error). Present only if the redirect
status is `failed`.
maxLength: 5000
nullable: true
type: string
return_url:
description: The URL you provide to redirect the customer to after they
authenticated their payment.
maxLength: 5000
type: string
status:
description: The status of the redirect, either `pending` (ready to be used
by your customer to authenticate the transaction), `succeeded` (succesful
authentication, cannot be reused) or `not_required` (redirect should not
be used) or `failed` (failed authentication, cannot be reused).
maxLength: 5000
type: string
url:
description: The URL provided to you to redirect a customer to as part of
a `redirect` authentication flow.
maxLength: 2048
type: string
required:
- return_url
- status
- url
title: SourceRedirectFlow
type: object
x-expandableFields: []
source_transaction:
description: |-
Some payment methods have no required amount that a customer must send.
Customers can be instructed to send any amount, and it can be made up of
multiple transactions. As such, sources can have multiple associated
transactions.
properties:
ach_credit_transfer:
"$ref": "#/components/schemas/source_transaction_ach_credit_transfer_data"
amount:
description: A positive integer in the smallest currency unit (that is,
100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency)
representing the amount your customer has pushed to the receiver.
type: integer
chf_credit_transfer:
"$ref": "#/components/schemas/source_transaction_chf_credit_transfer_data"
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
gbp_credit_transfer:
"$ref": "#/components/schemas/source_transaction_gbp_credit_transfer_data"
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- source_transaction
type: string
paper_check:
"$ref": "#/components/schemas/source_transaction_paper_check_data"
sepa_credit_transfer:
"$ref": "#/components/schemas/source_transaction_sepa_credit_transfer_data"
source:
description: The ID of the source this transaction is attached to.
maxLength: 5000
type: string
status:
description: The status of the transaction, one of `succeeded`, `pending`,
or `failed`.
maxLength: 5000
type: string
type:
description: The type of source this transaction is attached to.
enum:
- ach_credit_transfer
- ach_debit
- alipay
- bancontact
- card
- card_present
- eps
- giropay
- ideal
- klarna
- multibanco
- p24
- sepa_debit
- sofort
- three_d_secure
- wechat
type: string
required:
- amount
- created
- currency
- id
- livemode
- object
- source
- status
- type
title: SourceTransaction
type: object
x-expandableFields:
- ach_credit_transfer
- chf_credit_transfer
- gbp_credit_transfer
- paper_check
- sepa_credit_transfer
x-resourceId: source_transaction
source_transaction_ach_credit_transfer_data:
description: ''
properties:
customer_data:
description: Customer data associated with the transfer.
maxLength: 5000
type: string
fingerprint:
description: Bank account fingerprint associated with the transfer.
maxLength: 5000
type: string
last4:
description: Last 4 digits of the account number associated with the transfer.
maxLength: 5000
type: string
routing_number:
description: Routing number associated with the transfer.
maxLength: 5000
type: string
title: SourceTransactionAchCreditTransferData
type: object
x-expandableFields: []
source_transaction_chf_credit_transfer_data:
description: ''
properties:
reference:
description: Reference associated with the transfer.
maxLength: 5000
type: string
sender_address_country:
description: Sender's country address.
maxLength: 5000
type: string
sender_address_line1:
description: Sender's line 1 address.
maxLength: 5000
type: string
sender_iban:
description: Sender's bank account IBAN.
maxLength: 5000
type: string
sender_name:
description: Sender's name.
maxLength: 5000
type: string
title: SourceTransactionChfCreditTransferData
type: object
x-expandableFields: []
source_transaction_gbp_credit_transfer_data:
description: ''
properties:
fingerprint:
description: Bank account fingerprint associated with the Stripe owned bank
account receiving the transfer.
maxLength: 5000
type: string
funding_method:
description: 'The credit transfer rails the sender used to push this transfer.
The possible rails are: Faster Payments, BACS, CHAPS, and wire transfers.
Currently only Faster Payments is supported.'
maxLength: 5000
type: string
last4:
description: Last 4 digits of sender account number associated with the
transfer.
maxLength: 5000
type: string
reference:
description: Sender entered arbitrary information about the transfer.
maxLength: 5000
type: string
sender_account_number:
description: Sender account number associated with the transfer.
maxLength: 5000
type: string
sender_name:
description: Sender name associated with the transfer.
maxLength: 5000
type: string
sender_sort_code:
description: Sender sort code associated with the transfer.
maxLength: 5000
type: string
title: SourceTransactionGbpCreditTransferData
type: object
x-expandableFields: []
source_transaction_paper_check_data:
description: ''
properties:
available_at:
description: Time at which the deposited funds will be available for use.
Measured in seconds since the Unix epoch.
maxLength: 5000
type: string
invoices:
description: Comma-separated list of invoice IDs associated with the paper
check.
maxLength: 5000
type: string
title: SourceTransactionPaperCheckData
type: object
x-expandableFields: []
source_transaction_sepa_credit_transfer_data:
description: ''
properties:
reference:
description: Reference associated with the transfer.
maxLength: 5000
type: string
sender_iban:
description: Sender's bank account IBAN.
maxLength: 5000
type: string
sender_name:
description: Sender's name.
maxLength: 5000
type: string
title: SourceTransactionSepaCreditTransferData
type: object
x-expandableFields: []
source_type_ach_credit_transfer:
properties:
account_number:
nullable: true
type: string
bank_name:
nullable: true
type: string
fingerprint:
nullable: true
type: string
refund_account_holder_name:
nullable: true
type: string
refund_account_holder_type:
nullable: true
type: string
refund_routing_number:
nullable: true
type: string
routing_number:
nullable: true
type: string
swift_code:
nullable: true
type: string
type: object
source_type_ach_debit:
properties:
bank_name:
nullable: true
type: string
country:
nullable: true
type: string
fingerprint:
nullable: true
type: string
last4:
nullable: true
type: string
routing_number:
nullable: true
type: string
type:
nullable: true
type: string
type: object
source_type_alipay:
properties:
data_string:
nullable: true
type: string
native_url:
nullable: true
type: string
statement_descriptor:
nullable: true
type: string
type: object
source_type_au_becs_debit:
properties:
bsb_number:
nullable: true
type: string
fingerprint:
nullable: true
type: string
last4:
nullable: true
type: string
type: object
source_type_bancontact:
properties:
bank_code:
nullable: true
type: string
bank_name:
nullable: true
type: string
bic:
nullable: true
type: string
iban_last4:
nullable: true
type: string
preferred_language:
nullable: true
type: string
statement_descriptor:
nullable: true
type: string
type: object
source_type_card:
properties:
address_line1_check:
nullable: true
type: string
address_zip_check:
nullable: true
type: string
brand:
nullable: true
type: string
country:
nullable: true
type: string
cvc_check:
nullable: true
type: string
dynamic_last4:
nullable: true
type: string
exp_month:
nullable: true
type: integer
exp_year:
nullable: true
type: integer
fingerprint:
type: string
funding:
nullable: true
type: string
last4:
nullable: true
type: string
name:
nullable: true
type: string
three_d_secure:
type: string
tokenization_method:
nullable: true
type: string
type: object
source_type_card_present:
properties:
application_cryptogram:
type: string
application_preferred_name:
type: string
authorization_code:
nullable: true
type: string
authorization_response_code:
type: string
brand:
nullable: true
type: string
country:
nullable: true
type: string
cvm_type:
type: string
data_type:
nullable: true
type: string
dedicated_file_name:
type: string
emv_auth_data:
type: string
evidence_customer_signature:
nullable: true
type: string
evidence_transaction_certificate:
nullable: true
type: string
exp_month:
nullable: true
type: integer
exp_year:
nullable: true
type: integer
fingerprint:
type: string
funding:
nullable: true
type: string
last4:
nullable: true
type: string
pos_device_id:
nullable: true
type: string
pos_entry_mode:
type: string
read_method:
nullable: true
type: string
reader:
nullable: true
type: string
terminal_verification_results:
type: string
transaction_status_information:
type: string
type: object
source_type_eps:
properties:
reference:
nullable: true
type: string
statement_descriptor:
nullable: true
type: string
type: object
source_type_giropay:
properties:
bank_code:
nullable: true
type: string
bank_name:
nullable: true
type: string
bic:
nullable: true
type: string
statement_descriptor:
nullable: true
type: string
type: object
source_type_ideal:
properties:
bank:
nullable: true
type: string
bic:
nullable: true
type: string
iban_last4:
nullable: true
type: string
statement_descriptor:
nullable: true
type: string
type: object
source_type_klarna:
properties:
background_image_url:
type: string
client_token:
nullable: true
type: string
first_name:
type: string
last_name:
type: string
locale:
type: string
logo_url:
type: string
page_title:
type: string
pay_later_asset_urls_descriptive:
type: string
pay_later_asset_urls_standard:
type: string
pay_later_name:
type: string
pay_later_redirect_url:
type: string
pay_now_asset_urls_descriptive:
type: string
pay_now_asset_urls_standard:
type: string
pay_now_name:
type: string
pay_now_redirect_url:
type: string
pay_over_time_asset_urls_descriptive:
type: string
pay_over_time_asset_urls_standard:
type: string
pay_over_time_name:
type: string
pay_over_time_redirect_url:
type: string
payment_method_categories:
type: string
purchase_country:
type: string
purchase_type:
type: string
redirect_url:
type: string
shipping_first_name:
type: string
shipping_last_name:
type: string
type: object
source_type_multibanco:
properties:
entity:
nullable: true
type: string
reference:
nullable: true
type: string
refund_account_holder_address_city:
nullable: true
type: string
refund_account_holder_address_country:
nullable: true
type: string
refund_account_holder_address_line1:
nullable: true
type: string
refund_account_holder_address_line2:
nullable: true
type: string
refund_account_holder_address_postal_code:
nullable: true
type: string
refund_account_holder_address_state:
nullable: true
type: string
refund_account_holder_name:
nullable: true
type: string
refund_iban:
nullable: true
type: string
type: object
source_type_p24:
properties:
reference:
nullable: true
type: string
type: object
source_type_sepa_debit:
properties:
bank_code:
nullable: true
type: string
branch_code:
nullable: true
type: string
country:
nullable: true
type: string
fingerprint:
nullable: true
type: string
last4:
nullable: true
type: string
mandate_reference:
nullable: true
type: string
mandate_url:
nullable: true
type: string
type: object
source_type_sofort:
properties:
bank_code:
nullable: true
type: string
bank_name:
nullable: true
type: string
bic:
nullable: true
type: string
country:
nullable: true
type: string
iban_last4:
nullable: true
type: string
preferred_language:
nullable: true
type: string
statement_descriptor:
nullable: true
type: string
type: object
source_type_three_d_secure:
properties:
address_line1_check:
nullable: true
type: string
address_zip_check:
nullable: true
type: string
authenticated:
nullable: true
type: boolean
brand:
nullable: true
type: string
card:
nullable: true
type: string
country:
nullable: true
type: string
customer:
nullable: true
type: string
cvc_check:
nullable: true
type: string
dynamic_last4:
nullable: true
type: string
exp_month:
nullable: true
type: integer
exp_year:
nullable: true
type: integer
fingerprint:
type: string
funding:
nullable: true
type: string
last4:
nullable: true
type: string
name:
nullable: true
type: string
three_d_secure:
type: string
tokenization_method:
nullable: true
type: string
type: object
source_type_wechat:
properties:
prepay_id:
type: string
qr_code_url:
nullable: true
type: string
statement_descriptor:
type: string
type: object
status_transitions:
description: ''
properties:
canceled:
description: The time that the order was canceled.
format: unix-time
nullable: true
type: integer
fulfiled:
description: The time that the order was fulfilled.
format: unix-time
nullable: true
type: integer
paid:
description: The time that the order was paid.
format: unix-time
nullable: true
type: integer
returned:
description: The time that the order was returned.
format: unix-time
nullable: true
type: integer
title: StatusTransitions
type: object
x-expandableFields: []
subscription:
description: |-
Subscriptions allow you to charge a customer on a recurring basis.
Related guide: [Creating Subscriptions](https://stripe.com/docs/billing/subscriptions/creating).
properties:
application_fee_percent:
description: A non-negative decimal between 0 and 100, with at most two
decimal places. This represents the percentage of the subscription invoice
subtotal that will be transferred to the application owner's Stripe account.
nullable: true
type: number
billing_cycle_anchor:
description: Determines the date of the first full invoice, and, for plans
with `month` or `year` intervals, the day of the month for subsequent
invoices.
format: unix-time
type: integer
billing_thresholds:
anyOf:
- "$ref": "#/components/schemas/subscription_billing_thresholds"
description: Define thresholds at which an invoice will be sent, and the
subscription advanced to a new billing period
nullable: true
cancel_at:
description: A date in the future at which the subscription will automatically
get canceled
format: unix-time
nullable: true
type: integer
cancel_at_period_end:
description: If the subscription has been canceled with the `at_period_end`
flag set to `true`, `cancel_at_period_end` on the subscription will be
true. You can use this attribute to determine whether a subscription that
has a status of active is scheduled to be canceled at the end of the current
period.
type: boolean
canceled_at:
description: If the subscription has been canceled, the date of that cancellation.
If the subscription was canceled with `cancel_at_period_end`, `canceled_at`
will still reflect the date of the initial cancellation request, not the
end of the subscription period when the subscription is automatically
moved to a canceled state.
format: unix-time
nullable: true
type: integer
collection_method:
description: Either `charge_automatically`, or `send_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.
enum:
- charge_automatically
- send_invoice
nullable: true
type: string
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
current_period_end:
description: End of the current period that the subscription has been invoiced
for. At the end of this period, a new invoice will be created.
format: unix-time
type: integer
current_period_start:
description: Start of the current period that the subscription has been
invoiced for.
format: unix-time
type: integer
customer:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/customer"
- "$ref": "#/components/schemas/deleted_customer"
description: ID of the customer who owns the subscription.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/customer"
- "$ref": "#/components/schemas/deleted_customer"
days_until_due:
description: Number of days a customer has to pay invoices generated by
this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`.
nullable: true
type: integer
default_payment_method:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/payment_method"
description: ID of the default payment method for the subscription. It must
belong to the customer associated with the subscription. If not set, invoices
will use the default payment method in the customer's invoice settings.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/payment_method"
default_source:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/alipay_account"
- "$ref": "#/components/schemas/bank_account"
- "$ref": "#/components/schemas/bitcoin_receiver"
- "$ref": "#/components/schemas/card"
- "$ref": "#/components/schemas/source"
description: 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 not set, defaults to the customer's default source.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/alipay_account"
- "$ref": "#/components/schemas/bank_account"
- "$ref": "#/components/schemas/bitcoin_receiver"
- "$ref": "#/components/schemas/card"
- "$ref": "#/components/schemas/source"
default_tax_rates:
description: The tax rates that will apply to any subscription item that
does not have `tax_rates` set. Invoices created will have their `default_tax_rates`
populated from the subscription.
items:
"$ref": "#/components/schemas/tax_rate"
nullable: true
type: array
discount:
anyOf:
- "$ref": "#/components/schemas/discount"
description: Describes the current discount applied to this subscription,
if there is one. When billing, a discount applied to a subscription overrides
a discount applied on a customer-wide basis.
nullable: true
ended_at:
description: If the subscription has ended, the date the subscription ended.
format: unix-time
nullable: true
type: integer
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
items:
description: List of subscription items, each with an attached plan.
properties:
data:
description: Details about each object.
items:
"$ref": "#/components/schemas/subscription_item"
type: array
has_more:
description: True if this list has another page of items after this
one that can be fetched.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value. Always has the value `list`.
enum:
- list
type: string
url:
description: The URL where this list can be accessed.
maxLength: 5000
type: string
required:
- data
- has_more
- object
- url
title: SubscriptionItemList
type: object
x-expandableFields:
- data
latest_invoice:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/invoice"
description: The most recent invoice this subscription has generated.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/invoice"
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
next_pending_invoice_item_invoice:
description: Specifies the approximate timestamp on which any pending invoice
items will be billed according to the schedule provided at `pending_invoice_item_interval`.
format: unix-time
nullable: true
type: integer
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- subscription
type: string
pause_collection:
anyOf:
- "$ref": "#/components/schemas/subscriptions_resource_pause_collection"
description: If specified, payment collection for this subscription will
be paused.
nullable: true
pending_invoice_item_interval:
anyOf:
- "$ref": "#/components/schemas/subscription_pending_invoice_item_interval"
description: Specifies an interval for how often to bill for any pending
invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice)
for the given subscription at the specified interval.
nullable: true
pending_setup_intent:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/setup_intent"
description: You can use this [SetupIntent](https://stripe.com/docs/api/setup_intents)
to collect user authentication when creating a subscription without immediate
payment or updating a subscription's payment method, allowing you to optimize
for off-session payments. Learn more in the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication#scenario-2).
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/setup_intent"
pending_update:
anyOf:
- "$ref": "#/components/schemas/subscriptions_resource_pending_update"
description: If specified, [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates)
that will be applied to the subscription once the `latest_invoice` has
been paid.
nullable: true
plan:
anyOf:
- "$ref": "#/components/schemas/plan"
description: Hash describing the plan the customer is subscribed to. Only
set if the subscription contains a single plan.
nullable: true
quantity:
description: The quantity of the plan to which the customer is subscribed.
For example, if your plan is $10/user/month, and your customer has 5 users,
you could pass 5 as the quantity to have the customer charged $50 (5 x
$10) monthly. Only set if the subscription contains a single plan.
nullable: true
type: integer
schedule:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/subscription_schedule"
description: The schedule attached to the subscription
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/subscription_schedule"
start_date:
description: Date when the subscription was first created. The date might
differ from the `created` date due to backdating.
format: unix-time
type: integer
status:
description: "Possible values are `incomplete`, `incomplete_expired`, `trialing`,
`active`, `past_due`, `canceled`, or `unpaid`. \n\nFor `collection_method=charge_automatically`
a subscription moves into `incomplete` if the initial payment attempt
fails. A subscription in this state can only have metadata and default_source
updated. Once the first invoice is paid, the subscription moves into an
`active` state. If the first invoice is not paid within 23 hours, the
subscription transitions to `incomplete_expired`. This is a terminal state,
the open invoice will be voided and no further invoices will be generated.
\n\nA subscription that is currently in a trial period is `trialing` and
moves to `active` when the trial period is over. \n\nIf subscription `collection_method=charge_automatically`
it becomes `past_due` when payment to renew it fails and `canceled` or
`unpaid` (depending on your subscriptions settings) when Stripe has exhausted
all payment retry attempts. \n\nIf subscription `collection_method=send_invoice`
it becomes `past_due` when its invoice is not paid by the due date, and
`canceled` or `unpaid` if it is still not paid by an additional deadline
after that. Note that when a subscription has a status of `unpaid`, no
subsequent invoices will be attempted (invoices will be created, but then
immediately automatically closed). After receiving updated payment information
from a customer, you may choose to reopen and pay their closed invoices."
enum:
- active
- canceled
- incomplete
- incomplete_expired
- past_due
- trialing
- unpaid
type: string
tax_percent:
description: If provided, each invoice created by this subscription will
apply the tax rate, increasing the amount billed to the customer.
nullable: true
type: number
transfer_data:
anyOf:
- "$ref": "#/components/schemas/subscription_transfer_data"
description: The account (if any) the subscription's payments will be attributed
to for tax reporting, and where funds from each payment will be transferred
to for each of the subscription's invoices.
nullable: true
trial_end:
description: If the subscription has a trial, the end of that trial.
format: unix-time
nullable: true
type: integer
trial_start:
description: If the subscription has a trial, the beginning of that trial.
format: unix-time
nullable: true
type: integer
required:
- billing_cycle_anchor
- cancel_at_period_end
- created
- current_period_end
- current_period_start
- customer
- id
- items
- livemode
- metadata
- object
- start_date
- status
title: Subscription
type: object
x-expandableFields:
- billing_thresholds
- customer
- default_payment_method
- default_source
- default_tax_rates
- discount
- items
- latest_invoice
- pause_collection
- pending_invoice_item_interval
- pending_setup_intent
- pending_update
- plan
- schedule
- transfer_data
x-resourceId: subscription
subscription_billing_thresholds:
description: ''
properties:
amount_gte:
description: Monetary threshold that triggers the subscription to create
an invoice
nullable: true
type: integer
reset_billing_cycle_anchor:
description: Indicates if the `billing_cycle_anchor` should be reset when
a threshold is reached. If true, `billing_cycle_anchor` will be updated
to the date/time the threshold was last reached; otherwise, the value
will remain unchanged. This value may not be `true` if the subscription
contains items with plans that have `aggregate_usage=last_ever`.
nullable: true
type: boolean
title: SubscriptionBillingThresholds
type: object
x-expandableFields: []
subscription_item:
description: |-
Subscription items allow you to create customer subscriptions with more than
one plan, making it easy to represent complex billing relationships.
properties:
billing_thresholds:
anyOf:
- "$ref": "#/components/schemas/subscription_item_billing_thresholds"
description: Define thresholds at which an invoice will be sent, and the
related subscription advanced to a new billing period
nullable: true
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
type: integer
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- subscription_item
type: string
plan:
"$ref": "#/components/schemas/plan"
price:
"$ref": "#/components/schemas/price"
quantity:
description: The [quantity](https://stripe.com/docs/subscriptions/quantities)
of the plan to which the customer should be subscribed.
type: integer
subscription:
description: The `subscription` this `subscription_item` belongs to.
maxLength: 5000
type: string
tax_rates:
description: The tax rates which apply to this `subscription_item`. When
set, the `default_tax_rates` on the subscription do not apply to this
`subscription_item`.
items:
"$ref": "#/components/schemas/tax_rate"
nullable: true
type: array
required:
- created
- id
- metadata
- object
- plan
- price
- subscription
title: SubscriptionItem
type: object
x-expandableFields:
- billing_thresholds
- plan
- price
- tax_rates
x-resourceId: subscription_item
subscription_item_billing_thresholds:
description: ''
properties:
usage_gte:
description: Usage threshold that triggers the subscription to create an
invoice
nullable: true
type: integer
title: SubscriptionItemBillingThresholds
type: object
x-expandableFields: []
subscription_pending_invoice_item_interval:
description: ''
properties:
interval:
description: Specifies invoicing frequency. Either `day`, `week`, `month`
or `year`.
enum:
- day
- month
- week
- year
type: string
interval_count:
description: The number of intervals between invoices. For example, `interval=month`
and `interval_count=3` bills every 3 months. Maximum of one year interval
allowed (1 year, 12 months, or 52 weeks).
type: integer
required:
- interval
- interval_count
title: SubscriptionPendingInvoiceItemInterval
type: object
x-expandableFields: []
subscription_schedule:
description: |-
A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.
Related guide: [Subscription Schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules).
properties:
canceled_at:
description: Time at which the subscription schedule was canceled. Measured
in seconds since the Unix epoch.
format: unix-time
nullable: true
type: integer
completed_at:
description: Time at which the subscription schedule was completed. Measured
in seconds since the Unix epoch.
format: unix-time
nullable: true
type: integer
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
current_phase:
anyOf:
- "$ref": "#/components/schemas/subscription_schedule_current_phase"
description: Object representing the start and end dates for the current
phase of the subscription schedule, if it is `active`.
nullable: true
customer:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/customer"
- "$ref": "#/components/schemas/deleted_customer"
description: ID of the customer who owns the subscription schedule.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/customer"
- "$ref": "#/components/schemas/deleted_customer"
default_settings:
"$ref": "#/components/schemas/subscription_schedules_resource_default_settings"
end_behavior:
description: Behavior of the subscription schedule and underlying subscription
when it ends.
enum:
- cancel
- none
- release
- renew
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
nullable: true
type: object
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- subscription_schedule
type: string
phases:
description: Configuration for the subscription schedule's phases.
items:
"$ref": "#/components/schemas/subscription_schedule_phase_configuration"
type: array
released_at:
description: Time at which the subscription schedule was released. Measured
in seconds since the Unix epoch.
format: unix-time
nullable: true
type: integer
released_subscription:
description: ID of the subscription once managed by the subscription schedule
(if it is released).
maxLength: 5000
nullable: true
type: string
status:
description: The present status of the subscription schedule. Possible values
are `not_started`, `active`, `completed`, `released`, and `canceled`.
You can read more about the different states in our [behavior guide](https://stripe.com/docs/billing/subscriptions/subscription-schedules).
enum:
- active
- canceled
- completed
- not_started
- released
type: string
subscription:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/subscription"
description: ID of the subscription managed by the subscription schedule.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/subscription"
required:
- created
- customer
- default_settings
- end_behavior
- id
- livemode
- object
- phases
- status
title: SubscriptionSchedule
type: object
x-expandableFields:
- current_phase
- customer
- default_settings
- phases
- subscription
x-resourceId: subscription_schedule
subscription_schedule_add_invoice_item:
description: An Add Invoice Item describes the prices and quantities that will
be added as pending invoice items when entering a phase.
properties:
price:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/price"
- "$ref": "#/components/schemas/deleted_price"
description: ID of the price used to generate the invoice item.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/price"
- "$ref": "#/components/schemas/deleted_price"
quantity:
description: The quantity of the invoice item.
nullable: true
type: integer
required:
- price
title: SubscriptionScheduleAddInvoiceItem
type: object
x-expandableFields:
- price
subscription_schedule_configuration_item:
description: A phase item describes the price and quantity of a phase.
properties:
billing_thresholds:
anyOf:
- "$ref": "#/components/schemas/subscription_item_billing_thresholds"
description: Define thresholds at which an invoice will be sent, and the
related subscription advanced to a new billing period
nullable: true
plan:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/plan"
- "$ref": "#/components/schemas/deleted_plan"
description: ID of the plan to which the customer should be subscribed.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/plan"
- "$ref": "#/components/schemas/deleted_plan"
price:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/price"
- "$ref": "#/components/schemas/deleted_price"
description: ID of the price to which the customer should be subscribed.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/price"
- "$ref": "#/components/schemas/deleted_price"
quantity:
description: Quantity of the plan to which the customer should be subscribed.
nullable: true
type: integer
tax_rates:
description: The tax rates which apply to this `phase_item`. When set, the
`default_tax_rates` on the phase do not apply to this `phase_item`.
items:
"$ref": "#/components/schemas/tax_rate"
nullable: true
type: array
required:
- plan
- price
title: SubscriptionScheduleConfigurationItem
type: object
x-expandableFields:
- billing_thresholds
- plan
- price
- tax_rates
subscription_schedule_current_phase:
description: ''
properties:
end_date:
description: The end of this phase of the subscription schedule.
format: unix-time
type: integer
start_date:
description: The start of this phase of the subscription schedule.
format: unix-time
type: integer
required:
- end_date
- start_date
title: SubscriptionScheduleCurrentPhase
type: object
x-expandableFields: []
subscription_schedule_phase_configuration:
description: A phase describes the plans, coupon, and trialing status of a subscription
for a predefined time period.
properties:
add_invoice_items:
description: A list of prices and quantities that will generate invoice
items appended to the first invoice for this phase.
items:
"$ref": "#/components/schemas/subscription_schedule_add_invoice_item"
type: array
application_fee_percent:
description: A non-negative decimal between 0 and 100, with at most two
decimal places. This represents the percentage of the subscription invoice
subtotal that will be transferred to the application owner's Stripe account
during this phase of the schedule.
nullable: true
type: number
billing_thresholds:
anyOf:
- "$ref": "#/components/schemas/subscription_billing_thresholds"
description: Define thresholds at which an invoice will be sent, and the
subscription advanced to a new billing period
nullable: true
collection_method:
description: Either `charge_automatically`, or `send_invoice`. When charging
automatically, Stripe will attempt to pay the underlying subscription
at the end of each billing cycle using the default source attached to
the customer. When sending an invoice, Stripe will email your customer
an invoice with payment instructions.
enum:
- charge_automatically
- send_invoice
nullable: true
type: string
coupon:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/coupon"
- "$ref": "#/components/schemas/deleted_coupon"
description: ID of the coupon to use during this phase of the subscription
schedule.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/coupon"
- "$ref": "#/components/schemas/deleted_coupon"
default_payment_method:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/payment_method"
description: ID of the default payment method for the subscription schedule.
It must belong to the customer associated with the subscription schedule.
If not set, invoices will use the default payment method in the customer's
invoice settings.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/payment_method"
default_tax_rates:
description: The default tax rates to apply to the subscription during this
phase of the subscription schedule.
items:
"$ref": "#/components/schemas/tax_rate"
nullable: true
type: array
end_date:
description: The end of this phase of the subscription schedule.
format: unix-time
type: integer
invoice_settings:
anyOf:
- "$ref": "#/components/schemas/invoice_setting_subscription_schedule_setting"
description: The subscription schedule's default invoice settings.
nullable: true
plans:
description: Plans to subscribe during this phase of the subscription schedule.
items:
"$ref": "#/components/schemas/subscription_schedule_configuration_item"
type: array
proration_behavior:
description: Controls whether or not the subscription schedule will prorate
when transitioning to this phase. Values are `create_prorations` and `none`.
enum:
- always_invoice
- create_prorations
- none
nullable: true
type: string
start_date:
description: The start of this phase of the subscription schedule.
format: unix-time
type: integer
tax_percent:
description: If provided, each invoice created during this phase of the
subscription schedule will apply the tax rate, increasing the amount billed
to the customer.
nullable: true
type: number
transfer_data:
anyOf:
- "$ref": "#/components/schemas/subscription_transfer_data"
description: The account (if any) the subscription's payments will be attributed
to for tax reporting, and where funds from each payment will be transferred
to for each of the subscription's invoices.
nullable: true
trial_end:
description: When the trial ends within the phase.
format: unix-time
nullable: true
type: integer
required:
- add_invoice_items
- end_date
- plans
- start_date
title: SubscriptionSchedulePhaseConfiguration
type: object
x-expandableFields:
- add_invoice_items
- billing_thresholds
- coupon
- default_payment_method
- default_tax_rates
- invoice_settings
- plans
- transfer_data
subscription_schedules_resource_default_settings:
description: ''
properties:
billing_thresholds:
anyOf:
- "$ref": "#/components/schemas/subscription_billing_thresholds"
description: Define thresholds at which an invoice will be sent, and the
subscription advanced to a new billing period
nullable: true
collection_method:
description: Either `charge_automatically`, or `send_invoice`. When charging
automatically, Stripe will attempt to pay the underlying subscription
at the end of each billing cycle using the default source attached to
the customer. When sending an invoice, Stripe will email your customer
an invoice with payment instructions.
enum:
- charge_automatically
- send_invoice
nullable: true
type: string
default_payment_method:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/payment_method"
description: ID of the default payment method for the subscription schedule.
If not set, invoices will use the default payment method in the customer's
invoice settings.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/payment_method"
invoice_settings:
anyOf:
- "$ref": "#/components/schemas/invoice_setting_subscription_schedule_setting"
description: The subscription schedule's default invoice settings.
nullable: true
transfer_data:
anyOf:
- "$ref": "#/components/schemas/subscription_transfer_data"
description: The account (if any) the subscription's payments will be attributed
to for tax reporting, and where funds from each payment will be transferred
to for each of the subscription's invoices.
nullable: true
title: SubscriptionSchedulesResourceDefaultSettings
type: object
x-expandableFields:
- billing_thresholds
- default_payment_method
- invoice_settings
- transfer_data
subscription_transfer_data:
description: ''
properties:
amount_percent:
description: A non-negative decimal between 0 and 100, with at most two
decimal places. This represents the percentage of the subscription invoice
subtotal that will be transferred to the destination account. By default,
the entire amount is transferred to the destination.
nullable: true
type: number
destination:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/account"
description: The account where funds from the payment will be transferred
to upon payment success.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/account"
required:
- destination
title: SubscriptionTransferData
type: object
x-expandableFields:
- destination
subscriptions_resource_pause_collection:
description: |-
The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription
should be paused.
properties:
behavior:
description: The payment collection behavior for this subscription while
paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
enum:
- keep_as_draft
- mark_uncollectible
- void
type: string
resumes_at:
description: The time after which the subscription will resume collecting
payments.
format: unix-time
nullable: true
type: integer
required:
- behavior
title: SubscriptionsResourcePauseCollection
type: object
x-expandableFields: []
subscriptions_resource_pending_update:
description: |-
Pending Updates store the changes pending from a previous update that will be applied
to the Subscription upon successful payment.
properties:
billing_cycle_anchor:
description: If the update is applied, determines the date of the first
full invoice, and, for plans with `month` or `year` intervals, the day
of the month for subsequent invoices.
format: unix-time
nullable: true
type: integer
expires_at:
description: The point after which the changes reflected by this update
will be discarded and no longer applied.
format: unix-time
type: integer
subscription_items:
description: List of subscription items, each with an attached plan, that
will be set if the update is applied.
items:
"$ref": "#/components/schemas/subscription_item"
nullable: true
type: array
trial_end:
description: Unix timestamp representing the end of the trial period the
customer will get before being charged for the first time, if the update
is applied.
format: unix-time
nullable: true
type: integer
trial_from_plan:
description: Indicates if a plan's `trial_period_days` should be applied
to the subscription. Setting `trial_end` per subscription is preferred,
and this defaults to `false`. Setting this flag to `true` together with
`trial_end` is not allowed.
nullable: true
type: boolean
required:
- expires_at
title: SubscriptionsResourcePendingUpdate
type: object
x-expandableFields:
- subscription_items
tax_deducted_at_source:
description: ''
properties:
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- tax_deducted_at_source
type: string
period_end:
description: The end of the invoicing period. This TDS applies to Stripe
fees collected during this invoicing period.
format: unix-time
type: integer
period_start:
description: The start of the invoicing period. This TDS applies to Stripe
fees collected during this invoicing period.
format: unix-time
type: integer
tax_deduction_account_number:
description: The TAN that was supplied to Stripe when TDS was assessed
maxLength: 5000
type: string
required:
- id
- object
- period_end
- period_start
- tax_deduction_account_number
title: TaxDeductedAtSource
type: object
x-expandableFields: []
tax_id:
description: |-
You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers).
A customer's tax IDs are displayed on invoices and credit notes issued for the customer.
Related guide: [Customer Tax Identification Numbers](https://stripe.com/docs/billing/taxes/tax-ids).
properties:
country:
description: Two-letter ISO code representing the country of the tax ID.
maxLength: 5000
nullable: true
type: string
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
customer:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/customer"
description: ID of the customer.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/customer"
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- tax_id
type: string
type:
description: Type of the tax ID, one of `ae_trn`, `au_abn`, `br_cnpj`, `br_cpf`,
`ca_bn`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `hk_br`, `id_npwp`,
`in_gst`, `jp_cn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`,
`no_vat`, `nz_gst`, `ru_inn`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`,
`tw_vat`, `us_ein`, or `za_vat`. Note that some legacy tax IDs have type
`unknown`
enum:
- ae_trn
- au_abn
- br_cnpj
- br_cpf
- ca_bn
- ca_qst
- ch_vat
- cl_tin
- es_cif
- eu_vat
- hk_br
- id_npwp
- in_gst
- jp_cn
- kr_brn
- li_uid
- mx_rfc
- my_frp
- my_itn
- my_sst
- no_vat
- nz_gst
- ru_inn
- sa_vat
- sg_gst
- sg_uen
- th_vat
- tw_vat
- unknown
- us_ein
- za_vat
type: string
value:
description: Value of the tax ID.
maxLength: 5000
type: string
verification:
"$ref": "#/components/schemas/tax_id_verification"
required:
- created
- customer
- id
- livemode
- object
- type
- value
- verification
title: tax_id
type: object
x-expandableFields:
- customer
- verification
x-resourceId: tax_id
tax_id_verification:
description: ''
properties:
status:
description: Verification status, one of `pending`, `verified`, `unverified`,
or `unavailable`.
enum:
- pending
- unavailable
- unverified
- verified
type: string
verified_address:
description: Verified address.
maxLength: 5000
nullable: true
type: string
verified_name:
description: Verified name.
maxLength: 5000
nullable: true
type: string
required:
- status
title: tax_id_verification
type: object
x-expandableFields: []
tax_rate:
description: |-
Tax rates can be applied to invoices and subscriptions to collect tax.
Related guide: [Tax Rates](https://stripe.com/docs/billing/taxes/tax-rates).
properties:
active:
description: Defaults to `true`. When set to `false`, this tax rate cannot
be applied to objects in the API, but will still be applied to subscriptions
and invoices that already have it set.
type: boolean
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
description:
description: An arbitrary string attached to the tax rate for your internal
use only. It will not be visible to your customers.
maxLength: 5000
nullable: true
type: string
display_name:
description: The display name of the tax rates as it will appear to your
customer on their receipt email, PDF, and the hosted invoice page.
maxLength: 5000
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
inclusive:
description: This specifies if the tax rate is inclusive or exclusive.
type: boolean
jurisdiction:
description: The jurisdiction for the tax rate.
maxLength: 5000
nullable: true
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- tax_rate
type: string
percentage:
description: This represents the tax rate percent out of 100.
type: number
required:
- active
- created
- display_name
- id
- inclusive
- livemode
- metadata
- object
- percentage
title: TaxRate
type: object
x-expandableFields: []
x-resourceId: tax_rate
terminal.connection_token:
description: |-
A Connection Token is used by the Stripe Terminal SDK to connect to a reader.
Related guide: [Fleet Management](https://stripe.com/docs/terminal/readers/fleet-management#create).
properties:
location:
description: The id of the location that this connection token is scoped
to.
maxLength: 5000
type: string
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- terminal.connection_token
type: string
secret:
description: Your application should pass this token to the Stripe Terminal
SDK.
maxLength: 5000
type: string
required:
- object
- secret
title: TerminalConnectionToken
type: object
x-expandableFields: []
x-resourceId: terminal.connection_token
terminal.location:
description: |-
A Location represents a grouping of readers.
Related guide: [Fleet Management](https://stripe.com/docs/terminal/readers/fleet-management#create).
properties:
address:
"$ref": "#/components/schemas/address"
display_name:
description: The display name of the location.
maxLength: 5000
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- terminal.location
type: string
required:
- address
- display_name
- id
- livemode
- metadata
- object
title: TerminalLocationLocation
type: object
x-expandableFields:
- address
x-resourceId: terminal.location
terminal.reader:
description: |-
A Reader represents a physical device for accepting payment details.
Related guide: [Connecting to a Reader](https://stripe.com/docs/terminal/readers/connecting).
properties:
device_sw_version:
description: The current software version of the reader.
maxLength: 5000
nullable: true
type: string
device_type:
description: Type of reader, one of `bbpos_chipper2x` or `verifone_P400`.
enum:
- bbpos_chipper2x
- verifone_P400
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
ip_address:
description: The local IP address of the reader.
maxLength: 5000
nullable: true
type: string
label:
description: Custom label given to the reader for easier identification.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
location:
description: The location identifier of the reader.
maxLength: 5000
nullable: true
type: string
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- terminal.reader
type: string
serial_number:
description: Serial number of the reader.
maxLength: 5000
type: string
status:
description: The networking status of the reader.
maxLength: 5000
nullable: true
type: string
required:
- device_type
- id
- label
- livemode
- metadata
- object
- serial_number
title: TerminalReaderReader
type: object
x-expandableFields: []
x-resourceId: terminal.reader
three_d_secure:
description: |-
Cardholder authentication via 3D Secure is initiated by creating a `3D Secure`
object. Once the object has been created, you can use it to authenticate the
cardholder and create a charge.
properties:
amount:
description: Amount of the charge that you will create when authentication
completes.
type: integer
authenticated:
description: True if the cardholder went through the authentication flow
and their bank indicated that authentication succeeded.
type: boolean
card:
"$ref": "#/components/schemas/card"
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
maxLength: 5000
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- three_d_secure
type: string
redirect_url:
description: If present, this is the URL that you should send the cardholder
to for authentication. If you are going to use Stripe.js to display the
authentication page in an iframe, you should use the value "_callback".
maxLength: 5000
nullable: true
type: string
status:
description: Possible values are `redirect_pending`, `succeeded`, or `failed`.
When the cardholder can be authenticated, the object starts with status
`redirect_pending`. When liability will be shifted to the cardholder's
bank (either because the cardholder was successfully authenticated, or
because the bank has not implemented 3D Secure, the object wlil be in
status `succeeded`. `failed` indicates that authentication was attempted
unsuccessfully.
maxLength: 5000
type: string
required:
- amount
- authenticated
- card
- created
- currency
- id
- livemode
- object
- status
title: ThreeDSecure
type: object
x-expandableFields:
- card
x-resourceId: three_d_secure
three_d_secure_details:
description: ''
properties:
authenticated:
description: Whether or not authentication was performed. 3D Secure will
succeed without authentication when the card is not enrolled.
type: boolean
authentication_flow:
description: |-
For authenticated transactions: how the customer was authenticated by
the issuing bank.
enum:
- challenge
- frictionless
nullable: true
type: string
result:
description: Indicates the outcome of 3D Secure authentication.
enum:
- attempt_acknowledged
- authenticated
- failed
- not_supported
- processing_error
type: string
result_reason:
description: |-
Additional information about why 3D Secure succeeded or failed based
on the `result`.
enum:
- abandoned
- bypassed
- canceled
- card_not_enrolled
- network_not_supported
- protocol_error
- rejected
nullable: true
type: string
succeeded:
description: Whether or not 3D Secure succeeded.
type: boolean
version:
description: The version of 3D Secure that was used.
enum:
- 1.0.2
- 2.1.0
- 2.2.0
type: string
required:
- result
- version
title: three_d_secure_details
type: object
x-expandableFields: []
three_d_secure_usage:
description: ''
properties:
supported:
description: Whether 3D Secure is supported on this card.
type: boolean
required:
- supported
title: three_d_secure_usage
type: object
x-expandableFields: []
token:
description: |-
Tokenization is the process Stripe uses to collect sensitive card or bank
account details, or personally identifiable information (PII), directly from
your customers in a secure manner. A token representing this information is
returned to your server to use. You should use our
[recommended payments integrations](https://stripe.com/docs/payments) to perform this process
client-side. This ensures that no sensitive card data touches your server,
and allows your integration to operate in a PCI-compliant way.
If you cannot use client-side tokenization, you can also create tokens using
the API with either your publishable or secret API key. Keep in mind that if
your integration uses this method, you are responsible for any PCI compliance
that may be required, and you must keep your secret API key safe. Unlike with
client-side tokenization, your customer's information is not sent directly to
Stripe, so we cannot determine how it is handled or stored.
Tokens cannot be stored or used more than once. To store card or bank account
information for later use, you can create [Customer](https://stripe.com/docs/api#customers)
objects or [Custom accounts](https://stripe.com/docs/api#external_accounts). Note that
[Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection,
supports only integrations that use client-side tokenization.
Related guide: [Accept a payment](https://stripe.com/docs/payments/accept-a-payment-charges#web-create-token)
properties:
bank_account:
"$ref": "#/components/schemas/bank_account"
card:
"$ref": "#/components/schemas/card"
client_ip:
description: IP address of the client that generated the token.
maxLength: 5000
nullable: true
type: string
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- token
type: string
type:
description: 'Type of the token: `account`, `bank_account`, `card`, or `pii`.'
maxLength: 5000
type: string
used:
description: Whether this token has already been used (tokens can be used
only once).
type: boolean
required:
- created
- id
- livemode
- object
- type
- used
title: Token
type: object
x-expandableFields:
- bank_account
- card
x-resourceId: token
topup:
description: |-
To top up your Stripe balance, you create a top-up object. You can retrieve
individual top-ups, as well as list all top-ups. Top-ups are identified by a
unique, random ID.
Related guide: [Topping Up your Platform Account](https://stripe.com/docs/connect/top-ups).
properties:
amount:
description: Amount transferred.
type: integer
balance_transaction:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/balance_transaction"
description: ID of the balance transaction that describes the impact of
this top-up on your account balance. May not be specified depending on
status of top-up.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/balance_transaction"
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
maxLength: 5000
type: string
description:
description: An arbitrary string attached to the object. Often useful for
displaying to users.
maxLength: 5000
nullable: true
type: string
expected_availability_date:
description: Date the funds are expected to arrive in your Stripe account
for payouts. This factors in delays like weekends or bank holidays. May
not be specified depending on status of top-up.
nullable: true
type: integer
failure_code:
description: Error code explaining reason for top-up failure if available
(see [the errors section](https://stripe.com/docs/api#errors) for a list
of codes).
maxLength: 5000
nullable: true
type: string
failure_message:
description: Message to user further explaining reason for top-up failure
if available.
maxLength: 5000
nullable: true
type: string
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- topup
type: string
source:
"$ref": "#/components/schemas/source"
statement_descriptor:
description: Extra information about a top-up. This will appear on your
source's bank statement. It must contain at least one letter.
maxLength: 5000
nullable: true
type: string
status:
description: The status of the top-up is either `canceled`, `failed`, `pending`,
`reversed`, or `succeeded`.
enum:
- canceled
- failed
- pending
- reversed
- succeeded
type: string
transfer_group:
description: A string that identifies this top-up as part of a group.
maxLength: 5000
nullable: true
type: string
required:
- amount
- created
- currency
- id
- livemode
- metadata
- object
- source
- status
title: Topup
type: object
x-expandableFields:
- balance_transaction
- source
x-resourceId: topup
transfer:
description: |-
A `Transfer` object is created when you move funds between Stripe accounts as
part of Connect.
Before April 6, 2017, transfers also represented movement of funds from a
Stripe account to a card or bank account. This behavior has since been split
out into a [Payout](https://stripe.com/docs/api#payout_object) object, with corresponding payout endpoints. For more
information, read about the
[transfer/payout split](https://stripe.com/docs/transfer-payout-split).
Related guide: [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/charges-transfers).
properties:
amount:
description: Amount in %s to be transferred.
type: integer
amount_reversed:
description: Amount in %s reversed (can be less than the amount attribute
on the transfer if a partial reversal was issued).
type: integer
balance_transaction:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/balance_transaction"
description: Balance transaction that describes the impact of this transfer
on your account balance.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/balance_transaction"
created:
description: Time that this record of the transfer was first created.
format: unix-time
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
description:
description: An arbitrary string attached to the object. Often useful for
displaying to users.
maxLength: 5000
nullable: true
type: string
destination:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/account"
description: ID of the Stripe account the transfer was sent to.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/account"
destination_payment:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/charge"
description: If the destination is a Stripe account, this will be the ID
of the payment that the destination account received for the transfer.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/charge"
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- transfer
type: string
reversals:
description: A list of reversals that have been applied to the transfer.
properties:
data:
description: Details about each object.
items:
"$ref": "#/components/schemas/transfer_reversal"
type: array
has_more:
description: True if this list has another page of items after this
one that can be fetched.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value. Always has the value `list`.
enum:
- list
type: string
url:
description: The URL where this list can be accessed.
maxLength: 5000
type: string
required:
- data
- has_more
- object
- url
title: TransferReversalList
type: object
x-expandableFields:
- data
reversed:
description: Whether the transfer has been fully reversed. If the transfer
is only partially reversed, this attribute will still be false.
type: boolean
source_transaction:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/charge"
description: ID of the charge or payment that was used to fund the transfer.
If null, the transfer was funded from the available balance.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/charge"
source_type:
description: The source balance this transfer came from. One of `card`,
`fpx`, or `bank_account`.
maxLength: 5000
nullable: true
type: string
transfer_group:
description: A string that identifies this transaction as part of a group.
See the [Connect documentation](https://stripe.com/docs/connect/charges-transfers#transfer-options)
for details.
maxLength: 5000
nullable: true
type: string
required:
- amount
- amount_reversed
- created
- currency
- id
- livemode
- metadata
- object
- reversals
- reversed
title: Transfer
type: object
x-expandableFields:
- balance_transaction
- destination
- destination_payment
- reversals
- source_transaction
x-resourceId: transfer
transfer_data:
description: ''
properties:
amount:
description: Amount intended to be collected by this PaymentIntent. A positive
integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)
(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](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts).
The amount value supports up to eight digits (e.g., a value of 99999999
for a USD charge of $999,999.99).
type: integer
destination:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/account"
description: |-
The account (if any) the payment will be attributed to for tax
reporting, and where funds from the payment will be transferred to upon
payment success.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/account"
required:
- destination
title: transfer_data
type: object
x-expandableFields:
- destination
transfer_reversal:
description: |-
[Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a
connected account, either entirely or partially, and can also specify whether
to refund any related application fees. Transfer reversals add to the
platform's balance and subtract from the destination account's balance.
Reversing a transfer that was made for a [destination
charge](/docs/connect/destination-charges) is allowed only up to the amount of
the charge. It is possible to reverse a
[transfer_group](https://stripe.com/docs/connect/charges-transfers#transfer-options)
transfer only if the destination account has enough balance to cover the
reversal.
Related guide: [Reversing Transfers](https://stripe.com/docs/connect/charges-transfers#reversing-transfers).
properties:
amount:
description: Amount, in %s.
type: integer
balance_transaction:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/balance_transaction"
description: Balance transaction that describes the impact on your account
balance.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/balance_transaction"
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
destination_payment_refund:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/refund"
description: Linked payment refund for the transfer reversal.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/refund"
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- transfer_reversal
type: string
source_refund:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/refund"
description: ID of the refund responsible for the transfer reversal.
nullable: true
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/refund"
transfer:
anyOf:
- maxLength: 5000
type: string
- "$ref": "#/components/schemas/transfer"
description: ID of the transfer that was reversed.
x-expansionResources:
oneOf:
- "$ref": "#/components/schemas/transfer"
required:
- amount
- created
- currency
- id
- metadata
- object
- transfer
title: TransferReversal
type: object
x-expandableFields:
- balance_transaction
- destination_payment_refund
- source_refund
- transfer
x-resourceId: transfer_reversal
transfer_schedule:
description: ''
properties:
delay_days:
description: The number of days charges for the account will be held before
being paid out.
type: integer
interval:
description: How frequently funds will be paid out. One of `manual` (payouts
only created via API call), `daily`, `weekly`, or `monthly`.
maxLength: 5000
type: string
monthly_anchor:
description: The day of the month funds will be paid out. Only shown if
`interval` is monthly. Payouts scheduled between the 29th and 31st of
the month are sent on the last day of shorter months.
type: integer
weekly_anchor:
description: The day of the week funds will be paid out, of the style 'monday',
'tuesday', etc. Only shown if `interval` is weekly.
maxLength: 5000
type: string
required:
- delay_days
- interval
title: TransferSchedule
type: object
x-expandableFields: []
transform_quantity:
description: ''
properties:
divide_by:
description: Divide usage by this number.
type: integer
round:
description: After division, either round the result `up` or `down`.
enum:
- down
- up
type: string
required:
- divide_by
- round
title: TransformQuantity
type: object
x-expandableFields: []
transform_usage:
description: ''
properties:
divide_by:
description: Divide usage by this number.
type: integer
round:
description: After division, either round the result `up` or `down`.
enum:
- down
- up
type: string
required:
- divide_by
- round
title: TransformUsage
type: object
x-expandableFields: []
usage_record:
description: |-
Usage records allow you to report customer usage and metrics to Stripe for
metered billing of subscription plans.
Related guide: [Metered Billing](https://stripe.com/docs/billing/subscriptions/metered-billing).
properties:
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- usage_record
type: string
quantity:
description: The usage quantity for the specified date.
type: integer
subscription_item:
description: The ID of the subscription item this usage record contains
data for.
maxLength: 5000
type: string
timestamp:
description: The timestamp when this usage occurred.
format: unix-time
type: integer
required:
- id
- livemode
- object
- quantity
- subscription_item
- timestamp
title: UsageRecord
type: object
x-expandableFields: []
x-resourceId: usage_record
usage_record_summary:
description: ''
properties:
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
invoice:
description: The invoice in which this usage period has been billed for.
maxLength: 5000
nullable: true
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- usage_record_summary
type: string
period:
"$ref": "#/components/schemas/period"
subscription_item:
description: The ID of the subscription item this summary is describing.
maxLength: 5000
type: string
total_usage:
description: The total usage within this usage period.
type: integer
required:
- id
- livemode
- object
- period
- subscription_item
- total_usage
title: UsageRecordSummary
type: object
x-expandableFields:
- period
x-resourceId: usage_record_summary
webhook_endpoint:
description: |-
You can configure [webhook endpoints](https://stripe.com/docs/webhooks/) via the API to be
notified about events that happen in your Stripe account or connected
accounts.
Most users configure webhooks from [the dashboard](https://dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints.
Related guide: [Setting up Webhooks](https://stripe.com/docs/webhooks/configure).
properties:
api_version:
description: The API version events are rendered as for this webhook endpoint.
maxLength: 5000
nullable: true
type: string
application:
description: The ID of the associated Connect application.
maxLength: 5000
nullable: true
type: string
created:
description: Time at which the object was created. Measured in seconds since
the Unix epoch.
format: unix-time
type: integer
description:
description: An optional description of what the wehbook is used for.
maxLength: 5000
nullable: true
type: string
enabled_events:
description: The list of events to enable for this endpoint. `['*']` indicates
that all events are enabled, except those that require explicit selection.
items:
maxLength: 5000
type: string
type: array
id:
description: Unique identifier for the object.
maxLength: 5000
type: string
livemode:
description: Has the value `true` if the object exists in live mode or the
value `false` if the object exists in test mode.
type: boolean
metadata:
additionalProperties:
maxLength: 500
type: string
description: 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.
type: object
object:
description: String representing the object's type. Objects of the same
type share the same value.
enum:
- webhook_endpoint
type: string
secret:
description: The endpoint's secret, used to generate [webhook signatures](https://stripe.com/docs/webhooks/signatures).
Only returned at creation.
maxLength: 5000
type: string
status:
description: The status of the webhook. It can be `enabled` or `disabled`.
maxLength: 5000
type: string
url:
description: The URL of the webhook endpoint.
maxLength: 5000
type: string
required:
- created
- enabled_events
- id
- livemode
- metadata
- object
- status
- url
title: NotificationWebhookEndpoint
type: object
x-expandableFields: []
x-resourceId: webhook_endpoint
securitySchemes:
basicAuth:
description: 'Basic HTTP authentication. Allowed headers-- Authorization: Basic
<api_key> | Authorization: Basic <base64 hash of `api_key:`>'
scheme: basic
type: http
bearerAuth:
bearerFormat: auth-scheme
description: 'Bearer HTTP authentication. Allowed headers-- Authorization: Bearer
<api_key>'
scheme: bearer
type: http
info:
contact:
email: [email protected]
name: Stripe Dev Platform Team
url: https://stripe.com
description: The Stripe REST API. Please see https://stripe.com/docs/api for more
details.
termsOfService: https://stripe.com/us/terms/
title: Stripe API
version: '2020-03-02'
x-stripeSpecFilename: spec3
openapi: 3.0.0
paths:
"/v1/3d_secure":
post:
description: "<p>Initiate 3D Secure authentication.</p>"
operationId: Post3dSecure
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
expand:
explode: true
style: deepObject
schema:
additionalProperties: false
properties:
amount:
description: Amount of the charge that you will create when authentication
completes.
type: integer
card:
description: The ID of a card token, or the ID of a card belonging
to the given customer.
maxLength: 5000
type: string
currency:
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
type: string
customer:
description: The customer associated with this 3D secure authentication.
maxLength: 5000
type: string
expand:
description: Specifies which fields in the response should be expanded.
items:
maxLength: 5000
type: string
type: array
return_url:
description: The URL that the cardholder's browser will be returned
to when authentication completes.
type: string
required:
- amount
- currency
- return_url
type: object
required: true
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/three_d_secure"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
"/v1/3d_secure/{three_d_secure}":
get:
description: "<p>Retrieves a 3D Secure object.</p>"
operationId: Get3dSecureThreeDSecure
parameters:
- description: Specifies which fields in the response should be expanded.
explode: true
in: query
name: expand
required: false
schema:
items:
maxLength: 5000
type: string
type: array
style: deepObject
- in: path
name: three_d_secure
required: true
schema:
maxLength: 5000
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties: {}
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/three_d_secure"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
"/v1/account":
delete:
description: |-
<p>With <a href="/docs/connect">Connect</a>, you can delete Custom or Express accounts you manage.</p>
<p>Accounts created using test-mode keys can be deleted at any time. Accounts created using live-mode keys can only be deleted once all balances are zero.</p>
<p>If you want to delete your own account, use the <a href="https://dashboard.stripe.com/account">account information tab in your account settings</a> instead.</p>
operationId: DeleteAccount
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties:
account:
maxLength: 5000
type: string
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/deleted_account"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
get:
description: "<p>Retrieves the details of an account.</p>"
operationId: GetAccount
parameters:
- description: Specifies which fields in the response should be expanded.
explode: true
in: query
name: expand
required: false
schema:
items:
maxLength: 5000
type: string
type: array
style: deepObject
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties: {}
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/account"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
post:
description: |-
<p>Updates a connected <a href="/docs/connect/accounts">Express or Custom account</a> by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked <strong>Custom Only</strong> below.) Parameters marked <strong>Custom and Express</strong> are supported by both account types.</p>
<p>To update your own account, use the <a href="https://dashboard.stripe.com/account">Dashboard</a>. Refer to our <a href="/docs/connect/updating-accounts">Connect</a> documentation to learn more about updating accounts.</p>
operationId: PostAccount
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
bank_account:
explode: true
style: deepObject
business_profile:
explode: true
style: deepObject
company:
explode: true
style: deepObject
expand:
explode: true
style: deepObject
individual:
explode: true
style: deepObject
metadata:
explode: true
style: deepObject
requested_capabilities:
explode: true
style: deepObject
settings:
explode: true
style: deepObject
tos_acceptance:
explode: true
style: deepObject
schema:
additionalProperties: false
properties:
account_token:
description: An [account token](https://stripe.com/docs/api#create_account_token),
used to securely provide details to the account.
maxLength: 5000
type: string
bank_account:
anyOf:
- properties:
account_holder_name:
maxLength: 5000
type: string
account_holder_type:
enum:
- company
- individual
maxLength: 5000
type: string
account_number:
maxLength: 5000
type: string
country:
maxLength: 5000
type: string
currency:
type: string
object:
enum:
- bank_account
maxLength: 5000
type: string
routing_number:
maxLength: 5000
type: string
required:
- account_number
- country
title: external_account_payout_bank_account
type: object
- maxLength: 5000
type: string
description: Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js),
or a dictionary containing a user's bank account details.
business_profile:
description: Business information about the account.
properties:
mcc:
maxLength: 4
type: string
name:
maxLength: 5000
type: string
product_description:
maxLength: 40000
type: string
support_address:
properties:
city:
maxLength: 100
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 200
type: string
line2:
maxLength: 200
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
title: address_specs
type: object
support_email:
type: string
support_phone:
maxLength: 5000
type: string
support_url:
type: string
url:
maxLength: 5000
type: string
title: business_profile_specs
type: object
business_type:
description: The business type.
enum:
- company
- government_entity
- individual
- non_profit
type: string
x-stripeBypassValidation: true
company:
description: Information about the company or business. This field
is null unless `business_type` is set to `company`, `government_entity`,
or `non_profit`.
properties:
address:
properties:
city:
maxLength: 100
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 200
type: string
line2:
maxLength: 200
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
title: address_specs
type: object
address_kana:
properties:
city:
maxLength: 5000
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 5000
type: string
line2:
maxLength: 5000
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
town:
maxLength: 5000
type: string
title: japan_address_kana_specs
type: object
address_kanji:
properties:
city:
maxLength: 5000
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 5000
type: string
line2:
maxLength: 5000
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
town:
maxLength: 5000
type: string
title: japan_address_kanji_specs
type: object
directors_provided:
type: boolean
executives_provided:
type: boolean
name:
maxLength: 100
type: string
name_kana:
maxLength: 100
type: string
name_kanji:
maxLength: 100
type: string
owners_provided:
type: boolean
phone:
maxLength: 5000
type: string
structure:
enum:
- ''
- government_instrumentality
- governmental_unit
- incorporated_non_profit
- limited_liability_partnership
- multi_member_llc
- private_company
- private_corporation
- private_partnership
- public_company
- public_corporation
- public_partnership
- sole_proprietorship
- tax_exempt_government_instrumentality
- unincorporated_association
- unincorporated_non_profit
type: string
x-stripeBypassValidation: true
tax_id:
maxLength: 5000
type: string
tax_id_registrar:
maxLength: 5000
type: string
vat_id:
maxLength: 5000
type: string
verification:
properties:
document:
properties:
back:
maxLength: 500
type: string
front:
maxLength: 500
type: string
title: verification_document_specs
type: object
title: verification_specs
type: object
title: company_specs
type: object
default_currency:
description: 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](https://stripe.com/docs/payouts).
type: string
email:
description: Email address of the account representative. For Standard
accounts, this is used to ask them to claim their Stripe account.
For Custom accounts, this only makes the account easier to identify
to platforms; Stripe does not email the account representative.
type: string
expand:
description: Specifies which fields in the response should be expanded.
items:
maxLength: 5000
type: string
type: array
external_account:
description: A card or bank account to attach to the account. You
can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js),
or a dictionary, as documented in the `external_account` parameter
for [bank account](https://stripe.com/docs/api#account_create_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 API.
maxLength: 5000
type: string
x-stripeBypassValidation: true
individual:
description: Information about the person represented by the account.
This field is null unless `business_type` is set to `individual`.
properties:
address:
properties:
city:
maxLength: 100
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 200
type: string
line2:
maxLength: 200
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
title: address_specs
type: object
address_kana:
properties:
city:
maxLength: 5000
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 5000
type: string
line2:
maxLength: 5000
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
town:
maxLength: 5000
type: string
title: japan_address_kana_specs
type: object
address_kanji:
properties:
city:
maxLength: 5000
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 5000
type: string
line2:
maxLength: 5000
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
town:
maxLength: 5000
type: string
title: japan_address_kanji_specs
type: object
dob:
anyOf:
- properties:
day:
type: integer
month:
type: integer
year:
type: integer
required:
- day
- month
- year
title: date_of_birth_specs
type: object
- enum:
- ''
type: string
email:
type: string
first_name:
maxLength: 100
type: string
first_name_kana:
maxLength: 5000
type: string
first_name_kanji:
maxLength: 5000
type: string
gender:
maxLength: 5000
type: string
id_number:
maxLength: 5000
type: string
last_name:
maxLength: 100
type: string
last_name_kana:
maxLength: 5000
type: string
last_name_kanji:
maxLength: 5000
type: string
maiden_name:
maxLength: 5000
type: string
metadata:
anyOf:
- additionalProperties:
type: string
type: object
- enum:
- ''
type: string
phone:
type: string
ssn_last_4:
maxLength: 5000
type: string
verification:
properties:
additional_document:
properties:
back:
maxLength: 500
type: string
front:
maxLength: 500
type: string
title: person_verification_document_specs
type: object
document:
properties:
back:
maxLength: 500
type: string
front:
maxLength: 500
type: string
title: person_verification_document_specs
type: object
title: person_verification_specs
type: object
title: individual_specs
type: object
metadata:
anyOf:
- additionalProperties:
type: string
type: object
- enum:
- ''
type: string
description: 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`.
requested_capabilities:
description: The set of capabilities you want to unlock for this
account. Each capability will be inactive until you have provided
its specific requirements and Stripe has verified them. An account
may have some of its requested capabilities be active and some
be inactive.
items:
enum:
- au_becs_debit_payments
- bacs_debit_payments
- card_issuing
- card_payments
- jcb_payments
- legacy_payments
- tax_reporting_us_1099_k
- tax_reporting_us_1099_misc
- transfers
maxLength: 5000
type: string
x-stripeBypassValidation: true
type: array
settings:
description: Options for customizing how the account functions within
Stripe.
properties:
branding:
properties:
icon:
maxLength: 5000
type: string
logo:
maxLength: 5000
type: string
primary_color:
maxLength: 5000
type: string
secondary_color:
maxLength: 5000
type: string
title: branding_settings_specs
type: object
card_payments:
properties:
decline_on:
properties:
avs_failure:
type: boolean
cvc_failure:
type: boolean
title: decline_charge_on_specs
type: object
statement_descriptor_prefix:
maxLength: 10
type: string
title: card_payments_settings_specs
type: object
payments:
properties:
statement_descriptor:
maxLength: 22
type: string
statement_descriptor_kana:
maxLength: 22
type: string
statement_descriptor_kanji:
maxLength: 22
type: string
title: payments_settings_specs
type: object
payouts:
properties:
debit_negative_balances:
type: boolean
schedule:
properties:
delay_days:
anyOf:
- enum:
- minimum
maxLength: 5000
type: string
- type: integer
interval:
enum:
- daily
- manual
- monthly
- weekly
maxLength: 5000
type: string
x-stripeBypassValidation: true
monthly_anchor:
type: integer
weekly_anchor:
enum:
- friday
- monday
- saturday
- sunday
- thursday
- tuesday
- wednesday
maxLength: 5000
type: string
title: transfer_schedule_specs
type: object
statement_descriptor:
maxLength: 22
type: string
title: payout_settings_specs
type: object
title: settings_specs
type: object
tos_acceptance:
description: Details on the account's acceptance of the [Stripe
Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance).
properties:
date:
format: unix-time
type: integer
ip:
type: string
user_agent:
maxLength: 5000
type: string
title: tos_acceptance_specs
type: object
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/account"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
"/v1/account/bank_accounts":
post:
description: "<p>Create an external account for a given account.</p>"
operationId: PostAccountBankAccounts
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
bank_account:
explode: true
style: deepObject
expand:
explode: true
style: deepObject
metadata:
explode: true
style: deepObject
schema:
additionalProperties: false
properties:
bank_account:
anyOf:
- properties:
account_holder_name:
maxLength: 5000
type: string
account_holder_type:
enum:
- company
- individual
maxLength: 5000
type: string
account_number:
maxLength: 5000
type: string
country:
maxLength: 5000
type: string
currency:
type: string
object:
enum:
- bank_account
maxLength: 5000
type: string
routing_number:
maxLength: 5000
type: string
required:
- account_number
- country
title: external_account_payout_bank_account
type: object
- maxLength: 5000
type: string
description: Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js),
or a dictionary containing a user's bank account details.
default_for_currency:
description: 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.
type: boolean
expand:
description: Specifies which fields in the response should be expanded.
items:
maxLength: 5000
type: string
type: array
external_account:
description: Please refer to full [documentation](https://stripe.com/docs/api)
instead.
maxLength: 5000
type: string
x-stripeBypassValidation: true
metadata:
additionalProperties:
type: string
description: 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`.
type: object
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/external_account"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
"/v1/account/bank_accounts/{id}":
delete:
description: "<p>Delete a specified external account for a given account.</p>"
operationId: DeleteAccountBankAccountsId
parameters:
- in: path
name: id
required: true
schema:
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties: {}
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/deleted_external_account"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
get:
description: "<p>Retrieve a specified external account for a given account.</p>"
operationId: GetAccountBankAccountsId
parameters:
- description: Specifies which fields in the response should be expanded.
explode: true
in: query
name: expand
required: false
schema:
items:
maxLength: 5000
type: string
type: array
style: deepObject
- in: path
name: id
required: true
schema:
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties: {}
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/external_account"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
post:
description: |-
<p>Updates the metadata, account holder name, and account holder type of a bank account belonging to a <a href="/docs/connect/custom-accounts">Custom account</a>, and optionally sets it as the default for its currency. Other bank account details are not editable by design.</p>
<p>You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.</p>
operationId: PostAccountBankAccountsId
parameters:
- in: path
name: id
required: true
schema:
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
expand:
explode: true
style: deepObject
metadata:
explode: true
style: deepObject
schema:
additionalProperties: false
properties:
account_holder_name:
description: The name of the person or business that owns the bank
account.
maxLength: 5000
type: string
account_holder_type:
description: The type of entity that holds the account. This can
be either `individual` or `company`.
enum:
- ''
- company
- individual
maxLength: 5000
type: string
address_city:
description: City/District/Suburb/Town/Village.
maxLength: 5000
type: string
address_country:
description: Billing address country, if provided when creating
card.
maxLength: 5000
type: string
address_line1:
description: Address line 1 (Street address/PO Box/Company name).
maxLength: 5000
type: string
address_line2:
description: Address line 2 (Apartment/Suite/Unit/Building).
maxLength: 5000
type: string
address_state:
description: State/County/Province/Region.
maxLength: 5000
type: string
address_zip:
description: ZIP or postal code.
maxLength: 5000
type: string
default_for_currency:
description: When set to true, this becomes the default external
account for its currency.
type: boolean
exp_month:
description: Two digit number representing the card’s expiration
month.
maxLength: 5000
type: string
exp_year:
description: Four digit number representing the card’s expiration
year.
maxLength: 5000
type: string
expand:
description: Specifies which fields in the response should be expanded.
items:
maxLength: 5000
type: string
type: array
metadata:
anyOf:
- additionalProperties:
type: string
type: object
- enum:
- ''
type: string
description: 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:
description: Cardholder name.
maxLength: 5000
type: string
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/external_account"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
"/v1/account/capabilities":
get:
description: "<p>Returns a list of capabilities associated with the account.
The capabilities are returned sorted by creation date, with the most recent
capability appearing first.</p>"
operationId: GetAccountCapabilities
parameters:
- description: Specifies which fields in the response should be expanded.
explode: true
in: query
name: expand
required: false
schema:
items:
maxLength: 5000
type: string
type: array
style: deepObject
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties: {}
type: object
required: false
responses:
'200':
content:
application/json:
schema:
description: ''
properties:
data:
items:
"$ref": "#/components/schemas/capability"
type: array
has_more:
description: True if this list has another page of items after
this one that can be fetched.
type: boolean
object:
description: String representing the object's type. Objects of
the same type share the same value. Always has the value `list`.
enum:
- list
type: string
url:
description: The URL where this list can be accessed.
maxLength: 5000
type: string
required:
- data
- has_more
- object
- url
title: ListAccountCapability
type: object
x-expandableFields:
- data
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
"/v1/account/capabilities/{capability}":
get:
description: "<p>Retrieves information about the specified Account Capability.</p>"
operationId: GetAccountCapabilitiesCapability
parameters:
- in: path
name: capability
required: true
schema:
type: string
style: simple
- description: Specifies which fields in the response should be expanded.
explode: true
in: query
name: expand
required: false
schema:
items:
maxLength: 5000
type: string
type: array
style: deepObject
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties: {}
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/capability"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
post:
description: "<p>Updates an existing Account Capability.</p>"
operationId: PostAccountCapabilitiesCapability
parameters:
- in: path
name: capability
required: true
schema:
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
expand:
explode: true
style: deepObject
schema:
additionalProperties: false
properties:
expand:
description: Specifies which fields in the response should be expanded.
items:
maxLength: 5000
type: string
type: array
requested:
description: Passing true requests the capability for the account,
if it is not already requested. A requested capability may not
immediately become active. Any requirements to activate the capability
are returned in the `requirements` arrays.
type: boolean
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/capability"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
"/v1/account/external_accounts":
get:
description: "<p>List external accounts for an account.</p>"
operationId: GetAccountExternalAccounts
parameters:
- description: A cursor for use in pagination. `ending_before` is an object
ID that defines your place in the list. For instance, if you make a list
request and receive 100 objects, starting with `obj_bar`, your subsequent
call can include `ending_before=obj_bar` in order to fetch the previous
page of the list.
in: query
name: ending_before
required: false
schema:
type: string
style: form
- description: Specifies which fields in the response should be expanded.
explode: true
in: query
name: expand
required: false
schema:
items:
maxLength: 5000
type: string
type: array
style: deepObject
- description: A limit on the number of objects to be returned. Limit can range
between 1 and 100, and the default is 10.
in: query
name: limit
required: false
schema:
type: integer
style: form
- description: A cursor for use in pagination. `starting_after` is an object
ID that defines your place in the list. For instance, if you make a list
request and receive 100 objects, ending with `obj_foo`, your subsequent
call can include `starting_after=obj_foo` in order to fetch the next page
of the list.
in: query
name: starting_after
required: false
schema:
type: string
style: form
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties: {}
type: object
required: false
responses:
'200':
content:
application/json:
schema:
description: ''
properties:
data:
description: The list contains all external accounts that have
been attached to the Stripe account. These may be bank accounts
or cards.
items:
anyOf:
- "$ref": "#/components/schemas/bank_account"
- "$ref": "#/components/schemas/card"
title: Polymorphic
type: array
has_more:
description: True if this list has another page of items after
this one that can be fetched.
type: boolean
object:
description: String representing the object's type. Objects of
the same type share the same value. Always has the value `list`.
enum:
- list
type: string
url:
description: The URL where this list can be accessed.
maxLength: 5000
type: string
required:
- data
- has_more
- object
- url
title: ExternalAccountList
type: object
x-expandableFields:
- data
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
post:
description: "<p>Create an external account for a given account.</p>"
operationId: PostAccountExternalAccounts
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
bank_account:
explode: true
style: deepObject
expand:
explode: true
style: deepObject
metadata:
explode: true
style: deepObject
schema:
additionalProperties: false
properties:
bank_account:
anyOf:
- properties:
account_holder_name:
maxLength: 5000
type: string
account_holder_type:
enum:
- company
- individual
maxLength: 5000
type: string
account_number:
maxLength: 5000
type: string
country:
maxLength: 5000
type: string
currency:
type: string
object:
enum:
- bank_account
maxLength: 5000
type: string
routing_number:
maxLength: 5000
type: string
required:
- account_number
- country
title: external_account_payout_bank_account
type: object
- maxLength: 5000
type: string
description: Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js),
or a dictionary containing a user's bank account details.
default_for_currency:
description: 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.
type: boolean
expand:
description: Specifies which fields in the response should be expanded.
items:
maxLength: 5000
type: string
type: array
external_account:
description: Please refer to full [documentation](https://stripe.com/docs/api)
instead.
maxLength: 5000
type: string
x-stripeBypassValidation: true
metadata:
additionalProperties:
type: string
description: 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`.
type: object
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/external_account"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
"/v1/account/external_accounts/{id}":
delete:
description: "<p>Delete a specified external account for a given account.</p>"
operationId: DeleteAccountExternalAccountsId
parameters:
- in: path
name: id
required: true
schema:
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties: {}
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/deleted_external_account"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
get:
description: "<p>Retrieve a specified external account for a given account.</p>"
operationId: GetAccountExternalAccountsId
parameters:
- description: Specifies which fields in the response should be expanded.
explode: true
in: query
name: expand
required: false
schema:
items:
maxLength: 5000
type: string
type: array
style: deepObject
- in: path
name: id
required: true
schema:
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties: {}
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/external_account"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
post:
description: |-
<p>Updates the metadata, account holder name, and account holder type of a bank account belonging to a <a href="/docs/connect/custom-accounts">Custom account</a>, and optionally sets it as the default for its currency. Other bank account details are not editable by design.</p>
<p>You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.</p>
operationId: PostAccountExternalAccountsId
parameters:
- in: path
name: id
required: true
schema:
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
expand:
explode: true
style: deepObject
metadata:
explode: true
style: deepObject
schema:
additionalProperties: false
properties:
account_holder_name:
description: The name of the person or business that owns the bank
account.
maxLength: 5000
type: string
account_holder_type:
description: The type of entity that holds the account. This can
be either `individual` or `company`.
enum:
- ''
- company
- individual
maxLength: 5000
type: string
address_city:
description: City/District/Suburb/Town/Village.
maxLength: 5000
type: string
address_country:
description: Billing address country, if provided when creating
card.
maxLength: 5000
type: string
address_line1:
description: Address line 1 (Street address/PO Box/Company name).
maxLength: 5000
type: string
address_line2:
description: Address line 2 (Apartment/Suite/Unit/Building).
maxLength: 5000
type: string
address_state:
description: State/County/Province/Region.
maxLength: 5000
type: string
address_zip:
description: ZIP or postal code.
maxLength: 5000
type: string
default_for_currency:
description: When set to true, this becomes the default external
account for its currency.
type: boolean
exp_month:
description: Two digit number representing the card’s expiration
month.
maxLength: 5000
type: string
exp_year:
description: Four digit number representing the card’s expiration
year.
maxLength: 5000
type: string
expand:
description: Specifies which fields in the response should be expanded.
items:
maxLength: 5000
type: string
type: array
metadata:
anyOf:
- additionalProperties:
type: string
type: object
- enum:
- ''
type: string
description: 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:
description: Cardholder name.
maxLength: 5000
type: string
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/external_account"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
"/v1/account/login_links":
post:
description: |-
<p>Creates a single-use login link for an Express account to access their Stripe dashboard.</p>
<p><strong>You may only create login links for <a href="/docs/connect/express-accounts">Express accounts</a> connected to your platform</strong>.</p>
operationId: PostAccountLoginLinks
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
expand:
explode: true
style: deepObject
schema:
additionalProperties: false
properties:
account:
maxLength: 5000
type: string
expand:
description: Specifies which fields in the response should be expanded.
items:
maxLength: 5000
type: string
type: array
redirect_url:
description: Where to redirect the user after they log out of their
dashboard.
type: string
required:
- account
type: object
required: true
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/login_link"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
"/v1/account/logout":
put:
description: |-
<p>Invalidates all sessions for a light account, for a platform to use during platform logout.</p>
<p><strong>You may only log out <a href="/docs/connect/express-accounts">Express accounts</a> connected to your platform</strong>.</p>
operationId: PutAccountLogout
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
expand:
explode: true
style: deepObject
schema:
additionalProperties: false
properties:
account:
maxLength: 5000
type: string
expand:
description: Specifies which fields in the response should be expanded.
items:
maxLength: 5000
type: string
type: array
required:
- account
type: object
required: true
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/light_account_logout"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
"/v1/account/people":
get:
description: "<p>Returns a list of people associated with the account’s legal
entity. The people are returned sorted by creation date, with the most recent
people appearing first.</p>"
operationId: GetAccountPeople
parameters:
- description: A cursor for use in pagination. `ending_before` is an object
ID that defines your place in the list. For instance, if you make a list
request and receive 100 objects, starting with `obj_bar`, your subsequent
call can include `ending_before=obj_bar` in order to fetch the previous
page of the list.
in: query
name: ending_before
required: false
schema:
maxLength: 5000
type: string
style: form
- description: Specifies which fields in the response should be expanded.
explode: true
in: query
name: expand
required: false
schema:
items:
maxLength: 5000
type: string
type: array
style: deepObject
- description: A limit on the number of objects to be returned. Limit can range
between 1 and 100, and the default is 10.
in: query
name: limit
required: false
schema:
type: integer
style: form
- description: Filters on the list of people returned based on the person's
relationship to the account's company.
explode: true
in: query
name: relationship
required: false
schema:
properties:
director:
type: boolean
executive:
type: boolean
owner:
type: boolean
representative:
type: boolean
title: all_people_relationship_specs
type: object
style: deepObject
- description: A cursor for use in pagination. `starting_after` is an object
ID that defines your place in the list. For instance, if you make a list
request and receive 100 objects, ending with `obj_foo`, your subsequent
call can include `starting_after=obj_foo` in order to fetch the next page
of the list.
in: query
name: starting_after
required: false
schema:
maxLength: 5000
type: string
style: form
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties: {}
type: object
required: false
responses:
'200':
content:
application/json:
schema:
description: ''
properties:
data:
items:
"$ref": "#/components/schemas/person"
type: array
has_more:
description: True if this list has another page of items after
this one that can be fetched.
type: boolean
object:
description: String representing the object's type. Objects of
the same type share the same value. Always has the value `list`.
enum:
- list
type: string
url:
description: The URL where this list can be accessed.
maxLength: 5000
type: string
required:
- data
- has_more
- object
- url
type: object
x-expandableFields:
- data
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
post:
description: "<p>Creates a new person.</p>"
operationId: PostAccountPeople
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
address:
explode: true
style: deepObject
address_kana:
explode: true
style: deepObject
address_kanji:
explode: true
style: deepObject
dob:
explode: true
style: deepObject
expand:
explode: true
style: deepObject
metadata:
explode: true
style: deepObject
relationship:
explode: true
style: deepObject
verification:
explode: true
style: deepObject
schema:
additionalProperties: false
properties:
account:
maxLength: 5000
type: string
address:
description: The person's address.
properties:
city:
maxLength: 100
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 200
type: string
line2:
maxLength: 200
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
title: address_specs
type: object
address_kana:
description: The Kana variation of the person's address (Japan only).
properties:
city:
maxLength: 5000
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 5000
type: string
line2:
maxLength: 5000
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
town:
maxLength: 5000
type: string
title: japan_address_kana_specs
type: object
address_kanji:
description: The Kanji variation of the person's address (Japan
only).
properties:
city:
maxLength: 5000
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 5000
type: string
line2:
maxLength: 5000
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
town:
maxLength: 5000
type: string
title: japan_address_kanji_specs
type: object
dob:
anyOf:
- properties:
day:
type: integer
month:
type: integer
year:
type: integer
required:
- day
- month
- year
title: date_of_birth_specs
type: object
- enum:
- ''
type: string
description: The person's date of birth.
email:
description: The person's email address.
type: string
expand:
description: Specifies which fields in the response should be expanded.
items:
maxLength: 5000
type: string
type: array
first_name:
description: The person's first name.
maxLength: 5000
type: string
first_name_kana:
description: The Kana variation of the person's first name (Japan
only).
maxLength: 5000
type: string
first_name_kanji:
description: The Kanji variation of the person's first name (Japan
only).
maxLength: 5000
type: string
gender:
description: The person's gender (International regulations require
either "male" or "female").
maxLength: 5000
type: string
id_number:
description: 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](https://stripe.com/docs/stripe.js#collecting-pii-data).
maxLength: 5000
type: string
last_name:
description: The person's last name.
maxLength: 5000
type: string
last_name_kana:
description: The Kana variation of the person's last name (Japan
only).
maxLength: 5000
type: string
last_name_kanji:
description: The Kanji variation of the person's last name (Japan
only).
maxLength: 5000
type: string
maiden_name:
description: The person's maiden name.
maxLength: 5000
type: string
metadata:
anyOf:
- additionalProperties:
type: string
type: object
- enum:
- ''
type: string
description: 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`.
person_token:
description: A [person token](https://stripe.com/docs/connect/account-tokens),
used to securely provide details to the person.
maxLength: 5000
type: string
phone:
description: The person's phone number.
type: string
relationship:
description: The relationship that this person has with the account's
legal entity.
properties:
director:
type: boolean
executive:
type: boolean
owner:
type: boolean
percent_ownership:
anyOf:
- type: number
- enum:
- ''
type: string
representative:
type: boolean
title:
maxLength: 5000
type: string
title: relationship_specs
type: object
ssn_last_4:
description: The last four digits of the person's Social Security
number (U.S. only).
type: string
verification:
description: The person's verification status.
properties:
additional_document:
properties:
back:
maxLength: 500
type: string
front:
maxLength: 500
type: string
title: person_verification_document_specs
type: object
document:
properties:
back:
maxLength: 500
type: string
front:
maxLength: 500
type: string
title: person_verification_document_specs
type: object
title: person_verification_specs
type: object
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/person"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
"/v1/account/people/{person}":
delete:
description: "<p>Deletes an existing person’s relationship to the account’s
legal entity. Any person with a relationship for an account can be deleted
through the API, except if the person is the <code>account_opener</code>.
If your integration is using the <code>executive</code> parameter, you cannot
delete the only verified <code>executive</code> on file.</p>"
operationId: DeleteAccountPeoplePerson
parameters:
- in: path
name: person
required: true
schema:
maxLength: 5000
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties: {}
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/deleted_person"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
get:
description: "<p>Retrieves an existing person.</p>"
operationId: GetAccountPeoplePerson
parameters:
- description: Specifies which fields in the response should be expanded.
explode: true
in: query
name: expand
required: false
schema:
items:
maxLength: 5000
type: string
type: array
style: deepObject
- in: path
name: person
required: true
schema:
maxLength: 5000
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties: {}
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/person"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
post:
description: "<p>Updates an existing person.</p>"
operationId: PostAccountPeoplePerson
parameters:
- in: path
name: person
required: true
schema:
maxLength: 5000
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
address:
explode: true
style: deepObject
address_kana:
explode: true
style: deepObject
address_kanji:
explode: true
style: deepObject
dob:
explode: true
style: deepObject
expand:
explode: true
style: deepObject
metadata:
explode: true
style: deepObject
relationship:
explode: true
style: deepObject
verification:
explode: true
style: deepObject
schema:
additionalProperties: false
properties:
account:
maxLength: 5000
type: string
address:
description: The person's address.
properties:
city:
maxLength: 100
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 200
type: string
line2:
maxLength: 200
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
title: address_specs
type: object
address_kana:
description: The Kana variation of the person's address (Japan only).
properties:
city:
maxLength: 5000
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 5000
type: string
line2:
maxLength: 5000
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
town:
maxLength: 5000
type: string
title: japan_address_kana_specs
type: object
address_kanji:
description: The Kanji variation of the person's address (Japan
only).
properties:
city:
maxLength: 5000
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 5000
type: string
line2:
maxLength: 5000
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
town:
maxLength: 5000
type: string
title: japan_address_kanji_specs
type: object
dob:
anyOf:
- properties:
day:
type: integer
month:
type: integer
year:
type: integer
required:
- day
- month
- year
title: date_of_birth_specs
type: object
- enum:
- ''
type: string
description: The person's date of birth.
email:
description: The person's email address.
type: string
expand:
description: Specifies which fields in the response should be expanded.
items:
maxLength: 5000
type: string
type: array
first_name:
description: The person's first name.
maxLength: 5000
type: string
first_name_kana:
description: The Kana variation of the person's first name (Japan
only).
maxLength: 5000
type: string
first_name_kanji:
description: The Kanji variation of the person's first name (Japan
only).
maxLength: 5000
type: string
gender:
description: The person's gender (International regulations require
either "male" or "female").
maxLength: 5000
type: string
id_number:
description: 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](https://stripe.com/docs/stripe.js#collecting-pii-data).
maxLength: 5000
type: string
last_name:
description: The person's last name.
maxLength: 5000
type: string
last_name_kana:
description: The Kana variation of the person's last name (Japan
only).
maxLength: 5000
type: string
last_name_kanji:
description: The Kanji variation of the person's last name (Japan
only).
maxLength: 5000
type: string
maiden_name:
description: The person's maiden name.
maxLength: 5000
type: string
metadata:
anyOf:
- additionalProperties:
type: string
type: object
- enum:
- ''
type: string
description: 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`.
person_token:
description: A [person token](https://stripe.com/docs/connect/account-tokens),
used to securely provide details to the person.
maxLength: 5000
type: string
phone:
description: The person's phone number.
type: string
relationship:
description: The relationship that this person has with the account's
legal entity.
properties:
director:
type: boolean
executive:
type: boolean
owner:
type: boolean
percent_ownership:
anyOf:
- type: number
- enum:
- ''
type: string
representative:
type: boolean
title:
maxLength: 5000
type: string
title: relationship_specs
type: object
ssn_last_4:
description: The last four digits of the person's Social Security
number (U.S. only).
type: string
verification:
description: The person's verification status.
properties:
additional_document:
properties:
back:
maxLength: 500
type: string
front:
maxLength: 500
type: string
title: person_verification_document_specs
type: object
document:
properties:
back:
maxLength: 500
type: string
front:
maxLength: 500
type: string
title: person_verification_document_specs
type: object
title: person_verification_specs
type: object
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/person"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
"/v1/account/persons":
get:
description: "<p>Returns a list of people associated with the account’s legal
entity. The people are returned sorted by creation date, with the most recent
people appearing first.</p>"
operationId: GetAccountPersons
parameters:
- description: A cursor for use in pagination. `ending_before` is an object
ID that defines your place in the list. For instance, if you make a list
request and receive 100 objects, starting with `obj_bar`, your subsequent
call can include `ending_before=obj_bar` in order to fetch the previous
page of the list.
in: query
name: ending_before
required: false
schema:
maxLength: 5000
type: string
style: form
- description: Specifies which fields in the response should be expanded.
explode: true
in: query
name: expand
required: false
schema:
items:
maxLength: 5000
type: string
type: array
style: deepObject
- description: A limit on the number of objects to be returned. Limit can range
between 1 and 100, and the default is 10.
in: query
name: limit
required: false
schema:
type: integer
style: form
- description: Filters on the list of people returned based on the person's
relationship to the account's company.
explode: true
in: query
name: relationship
required: false
schema:
properties:
director:
type: boolean
executive:
type: boolean
owner:
type: boolean
representative:
type: boolean
title: all_people_relationship_specs
type: object
style: deepObject
- description: A cursor for use in pagination. `starting_after` is an object
ID that defines your place in the list. For instance, if you make a list
request and receive 100 objects, ending with `obj_foo`, your subsequent
call can include `starting_after=obj_foo` in order to fetch the next page
of the list.
in: query
name: starting_after
required: false
schema:
maxLength: 5000
type: string
style: form
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties: {}
type: object
required: false
responses:
'200':
content:
application/json:
schema:
description: ''
properties:
data:
items:
"$ref": "#/components/schemas/person"
type: array
has_more:
description: True if this list has another page of items after
this one that can be fetched.
type: boolean
object:
description: String representing the object's type. Objects of
the same type share the same value. Always has the value `list`.
enum:
- list
type: string
url:
description: The URL where this list can be accessed.
maxLength: 5000
type: string
required:
- data
- has_more
- object
- url
type: object
x-expandableFields:
- data
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
post:
description: "<p>Creates a new person.</p>"
operationId: PostAccountPersons
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
address:
explode: true
style: deepObject
address_kana:
explode: true
style: deepObject
address_kanji:
explode: true
style: deepObject
dob:
explode: true
style: deepObject
expand:
explode: true
style: deepObject
metadata:
explode: true
style: deepObject
relationship:
explode: true
style: deepObject
verification:
explode: true
style: deepObject
schema:
additionalProperties: false
properties:
account:
maxLength: 5000
type: string
address:
description: The person's address.
properties:
city:
maxLength: 100
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 200
type: string
line2:
maxLength: 200
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
title: address_specs
type: object
address_kana:
description: The Kana variation of the person's address (Japan only).
properties:
city:
maxLength: 5000
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 5000
type: string
line2:
maxLength: 5000
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
town:
maxLength: 5000
type: string
title: japan_address_kana_specs
type: object
address_kanji:
description: The Kanji variation of the person's address (Japan
only).
properties:
city:
maxLength: 5000
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 5000
type: string
line2:
maxLength: 5000
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
town:
maxLength: 5000
type: string
title: japan_address_kanji_specs
type: object
dob:
anyOf:
- properties:
day:
type: integer
month:
type: integer
year:
type: integer
required:
- day
- month
- year
title: date_of_birth_specs
type: object
- enum:
- ''
type: string
description: The person's date of birth.
email:
description: The person's email address.
type: string
expand:
description: Specifies which fields in the response should be expanded.
items:
maxLength: 5000
type: string
type: array
first_name:
description: The person's first name.
maxLength: 5000
type: string
first_name_kana:
description: The Kana variation of the person's first name (Japan
only).
maxLength: 5000
type: string
first_name_kanji:
description: The Kanji variation of the person's first name (Japan
only).
maxLength: 5000
type: string
gender:
description: The person's gender (International regulations require
either "male" or "female").
maxLength: 5000
type: string
id_number:
description: 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](https://stripe.com/docs/stripe.js#collecting-pii-data).
maxLength: 5000
type: string
last_name:
description: The person's last name.
maxLength: 5000
type: string
last_name_kana:
description: The Kana variation of the person's last name (Japan
only).
maxLength: 5000
type: string
last_name_kanji:
description: The Kanji variation of the person's last name (Japan
only).
maxLength: 5000
type: string
maiden_name:
description: The person's maiden name.
maxLength: 5000
type: string
metadata:
anyOf:
- additionalProperties:
type: string
type: object
- enum:
- ''
type: string
description: 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`.
person_token:
description: A [person token](https://stripe.com/docs/connect/account-tokens),
used to securely provide details to the person.
maxLength: 5000
type: string
phone:
description: The person's phone number.
type: string
relationship:
description: The relationship that this person has with the account's
legal entity.
properties:
director:
type: boolean
executive:
type: boolean
owner:
type: boolean
percent_ownership:
anyOf:
- type: number
- enum:
- ''
type: string
representative:
type: boolean
title:
maxLength: 5000
type: string
title: relationship_specs
type: object
ssn_last_4:
description: The last four digits of the person's Social Security
number (U.S. only).
type: string
verification:
description: The person's verification status.
properties:
additional_document:
properties:
back:
maxLength: 500
type: string
front:
maxLength: 500
type: string
title: person_verification_document_specs
type: object
document:
properties:
back:
maxLength: 500
type: string
front:
maxLength: 500
type: string
title: person_verification_document_specs
type: object
title: person_verification_specs
type: object
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/person"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
"/v1/account/persons/{person}":
delete:
description: "<p>Deletes an existing person’s relationship to the account’s
legal entity. Any person with a relationship for an account can be deleted
through the API, except if the person is the <code>account_opener</code>.
If your integration is using the <code>executive</code> parameter, you cannot
delete the only verified <code>executive</code> on file.</p>"
operationId: DeleteAccountPersonsPerson
parameters:
- in: path
name: person
required: true
schema:
maxLength: 5000
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties: {}
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/deleted_person"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
get:
description: "<p>Retrieves an existing person.</p>"
operationId: GetAccountPersonsPerson
parameters:
- description: Specifies which fields in the response should be expanded.
explode: true
in: query
name: expand
required: false
schema:
items:
maxLength: 5000
type: string
type: array
style: deepObject
- in: path
name: person
required: true
schema:
maxLength: 5000
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties: {}
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/person"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
post:
description: "<p>Updates an existing person.</p>"
operationId: PostAccountPersonsPerson
parameters:
- in: path
name: person
required: true
schema:
maxLength: 5000
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
address:
explode: true
style: deepObject
address_kana:
explode: true
style: deepObject
address_kanji:
explode: true
style: deepObject
dob:
explode: true
style: deepObject
expand:
explode: true
style: deepObject
metadata:
explode: true
style: deepObject
relationship:
explode: true
style: deepObject
verification:
explode: true
style: deepObject
schema:
additionalProperties: false
properties:
account:
maxLength: 5000
type: string
address:
description: The person's address.
properties:
city:
maxLength: 100
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 200
type: string
line2:
maxLength: 200
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
title: address_specs
type: object
address_kana:
description: The Kana variation of the person's address (Japan only).
properties:
city:
maxLength: 5000
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 5000
type: string
line2:
maxLength: 5000
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
town:
maxLength: 5000
type: string
title: japan_address_kana_specs
type: object
address_kanji:
description: The Kanji variation of the person's address (Japan
only).
properties:
city:
maxLength: 5000
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 5000
type: string
line2:
maxLength: 5000
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
town:
maxLength: 5000
type: string
title: japan_address_kanji_specs
type: object
dob:
anyOf:
- properties:
day:
type: integer
month:
type: integer
year:
type: integer
required:
- day
- month
- year
title: date_of_birth_specs
type: object
- enum:
- ''
type: string
description: The person's date of birth.
email:
description: The person's email address.
type: string
expand:
description: Specifies which fields in the response should be expanded.
items:
maxLength: 5000
type: string
type: array
first_name:
description: The person's first name.
maxLength: 5000
type: string
first_name_kana:
description: The Kana variation of the person's first name (Japan
only).
maxLength: 5000
type: string
first_name_kanji:
description: The Kanji variation of the person's first name (Japan
only).
maxLength: 5000
type: string
gender:
description: The person's gender (International regulations require
either "male" or "female").
maxLength: 5000
type: string
id_number:
description: 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](https://stripe.com/docs/stripe.js#collecting-pii-data).
maxLength: 5000
type: string
last_name:
description: The person's last name.
maxLength: 5000
type: string
last_name_kana:
description: The Kana variation of the person's last name (Japan
only).
maxLength: 5000
type: string
last_name_kanji:
description: The Kanji variation of the person's last name (Japan
only).
maxLength: 5000
type: string
maiden_name:
description: The person's maiden name.
maxLength: 5000
type: string
metadata:
anyOf:
- additionalProperties:
type: string
type: object
- enum:
- ''
type: string
description: 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`.
person_token:
description: A [person token](https://stripe.com/docs/connect/account-tokens),
used to securely provide details to the person.
maxLength: 5000
type: string
phone:
description: The person's phone number.
type: string
relationship:
description: The relationship that this person has with the account's
legal entity.
properties:
director:
type: boolean
executive:
type: boolean
owner:
type: boolean
percent_ownership:
anyOf:
- type: number
- enum:
- ''
type: string
representative:
type: boolean
title:
maxLength: 5000
type: string
title: relationship_specs
type: object
ssn_last_4:
description: The last four digits of the person's Social Security
number (U.S. only).
type: string
verification:
description: The person's verification status.
properties:
additional_document:
properties:
back:
maxLength: 500
type: string
front:
maxLength: 500
type: string
title: person_verification_document_specs
type: object
document:
properties:
back:
maxLength: 500
type: string
front:
maxLength: 500
type: string
title: person_verification_document_specs
type: object
title: person_verification_specs
type: object
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/person"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
"/v1/account_links":
post:
description: "<p>Creates an AccountLink object that returns a single-use Stripe
URL that the user can redirect their user to in order to take them through
the Connect Onboarding flow.</p>"
operationId: PostAccountLinks
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
expand:
explode: true
style: deepObject
schema:
additionalProperties: false
properties:
account:
description: The identifier of the account to create an account
link for.
maxLength: 5000
type: string
collect:
description: Which information the platform needs to collect from
the user. One of `currently_due` or `eventually_due`. Default
is `currently_due`.
enum:
- currently_due
- eventually_due
type: string
expand:
description: Specifies which fields in the response should be expanded.
items:
maxLength: 5000
type: string
type: array
failure_url:
description: The URL that the user will be redirected to if the
account link is no longer valid.
type: string
success_url:
description: The URL that the user will be redirected to upon leaving
or completing the linked flow successfully.
type: string
type:
description: The type of account link the user is requesting. Possible
values are `custom_account_verification` or `custom_account_update`.
enum:
- custom_account_update
- custom_account_verification
type: string
x-stripeBypassValidation: true
required:
- account
- failure_url
- success_url
- type
type: object
required: true
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/account_link"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
"/v1/accounts":
get:
description: <p>Returns a list of accounts connected to your platform via <a
href="/docs/connect">Connect</a>. If you’re not a platform, the list is empty.</p>
operationId: GetAccounts
parameters:
- explode: true
in: query
name: created
required: false
schema:
anyOf:
- properties:
gt:
type: integer
gte:
type: integer
lt:
type: integer
lte:
type: integer
title: range_query_specs
type: object
- type: integer
style: deepObject
- description: A cursor for use in pagination. `ending_before` is an object
ID that defines your place in the list. For instance, if you make a list
request and receive 100 objects, starting with `obj_bar`, your subsequent
call can include `ending_before=obj_bar` in order to fetch the previous
page of the list.
in: query
name: ending_before
required: false
schema:
type: string
style: form
- description: Specifies which fields in the response should be expanded.
explode: true
in: query
name: expand
required: false
schema:
items:
maxLength: 5000
type: string
type: array
style: deepObject
- description: A limit on the number of objects to be returned. Limit can range
between 1 and 100, and the default is 10.
in: query
name: limit
required: false
schema:
type: integer
style: form
- description: A cursor for use in pagination. `starting_after` is an object
ID that defines your place in the list. For instance, if you make a list
request and receive 100 objects, ending with `obj_foo`, your subsequent
call can include `starting_after=obj_foo` in order to fetch the next page
of the list.
in: query
name: starting_after
required: false
schema:
type: string
style: form
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties: {}
type: object
required: false
responses:
'200':
content:
application/json:
schema:
description: ''
properties:
data:
items:
"$ref": "#/components/schemas/account"
type: array
has_more:
description: True if this list has another page of items after
this one that can be fetched.
type: boolean
object:
description: String representing the object's type. Objects of
the same type share the same value. Always has the value `list`.
enum:
- list
type: string
url:
description: The URL where this list can be accessed.
maxLength: 5000
pattern: "^/v1/accounts"
type: string
required:
- data
- has_more
- object
- url
type: object
x-expandableFields:
- data
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
post:
description: |-
<p>With <a href="/docs/connect">Connect</a>, you can create Stripe accounts for your users.
To do this, you’ll first need to <a href="https://dashboard.stripe.com/account/applications/settings">register your platform</a>.</p>
operationId: PostAccounts
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
bank_account:
explode: true
style: deepObject
business_profile:
explode: true
style: deepObject
company:
explode: true
style: deepObject
expand:
explode: true
style: deepObject
individual:
explode: true
style: deepObject
metadata:
explode: true
style: deepObject
requested_capabilities:
explode: true
style: deepObject
settings:
explode: true
style: deepObject
tos_acceptance:
explode: true
style: deepObject
schema:
additionalProperties: false
properties:
account_token:
description: An [account token](https://stripe.com/docs/api#create_account_token),
used to securely provide details to the account.
maxLength: 5000
type: string
bank_account:
anyOf:
- properties:
account_holder_name:
maxLength: 5000
type: string
account_holder_type:
enum:
- company
- individual
maxLength: 5000
type: string
account_number:
maxLength: 5000
type: string
country:
maxLength: 5000
type: string
currency:
type: string
object:
enum:
- bank_account
maxLength: 5000
type: string
routing_number:
maxLength: 5000
type: string
required:
- account_number
- country
title: external_account_payout_bank_account
type: object
- maxLength: 5000
type: string
description: Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js),
or a dictionary containing a user's bank account details.
business_profile:
description: Business information about the account.
properties:
mcc:
maxLength: 4
type: string
name:
maxLength: 5000
type: string
product_description:
maxLength: 40000
type: string
support_address:
properties:
city:
maxLength: 100
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 200
type: string
line2:
maxLength: 200
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
title: address_specs
type: object
support_email:
type: string
support_phone:
maxLength: 5000
type: string
support_url:
type: string
url:
maxLength: 5000
type: string
title: business_profile_specs
type: object
business_type:
description: The business type.
enum:
- company
- government_entity
- individual
- non_profit
type: string
x-stripeBypassValidation: true
company:
description: Information about the company or business. This field
is null unless `business_type` is set to `company`, `government_entity`,
or `non_profit`.
properties:
address:
properties:
city:
maxLength: 100
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 200
type: string
line2:
maxLength: 200
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
title: address_specs
type: object
address_kana:
properties:
city:
maxLength: 5000
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 5000
type: string
line2:
maxLength: 5000
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
town:
maxLength: 5000
type: string
title: japan_address_kana_specs
type: object
address_kanji:
properties:
city:
maxLength: 5000
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 5000
type: string
line2:
maxLength: 5000
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
town:
maxLength: 5000
type: string
title: japan_address_kanji_specs
type: object
directors_provided:
type: boolean
executives_provided:
type: boolean
name:
maxLength: 100
type: string
name_kana:
maxLength: 100
type: string
name_kanji:
maxLength: 100
type: string
owners_provided:
type: boolean
phone:
maxLength: 5000
type: string
structure:
enum:
- ''
- government_instrumentality
- governmental_unit
- incorporated_non_profit
- limited_liability_partnership
- multi_member_llc
- private_company
- private_corporation
- private_partnership
- public_company
- public_corporation
- public_partnership
- sole_proprietorship
- tax_exempt_government_instrumentality
- unincorporated_association
- unincorporated_non_profit
type: string
x-stripeBypassValidation: true
tax_id:
maxLength: 5000
type: string
tax_id_registrar:
maxLength: 5000
type: string
vat_id:
maxLength: 5000
type: string
verification:
properties:
document:
properties:
back:
maxLength: 500
type: string
front:
maxLength: 500
type: string
title: verification_document_specs
type: object
title: verification_specs
type: object
title: company_specs
type: object
country:
description: 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 `CA` as the country
for the account being created.
maxLength: 5000
type: string
default_currency:
description: 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](https://stripe.com/docs/payouts).
type: string
email:
description: 'The email address of the account holder. For Custom
accounts, this is only to make the account easier to identify
to you: Stripe will never directly email your users.'
type: string
expand:
description: Specifies which fields in the response should be expanded.
items:
maxLength: 5000
type: string
type: array
external_account:
description: A card or bank account to attach to the account. You
can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js),
or a dictionary, as documented in the `external_account` parameter
for [bank account](https://stripe.com/docs/api#account_create_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 API.
maxLength: 5000
type: string
x-stripeBypassValidation: true
individual:
description: Information about the person represented by the account.
This field is null unless `business_type` is set to `individual`.
properties:
address:
properties:
city:
maxLength: 100
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 200
type: string
line2:
maxLength: 200
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
title: address_specs
type: object
address_kana:
properties:
city:
maxLength: 5000
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 5000
type: string
line2:
maxLength: 5000
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
town:
maxLength: 5000
type: string
title: japan_address_kana_specs
type: object
address_kanji:
properties:
city:
maxLength: 5000
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 5000
type: string
line2:
maxLength: 5000
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
town:
maxLength: 5000
type: string
title: japan_address_kanji_specs
type: object
dob:
anyOf:
- properties:
day:
type: integer
month:
type: integer
year:
type: integer
required:
- day
- month
- year
title: date_of_birth_specs
type: object
- enum:
- ''
type: string
email:
type: string
first_name:
maxLength: 100
type: string
first_name_kana:
maxLength: 5000
type: string
first_name_kanji:
maxLength: 5000
type: string
gender:
maxLength: 5000
type: string
id_number:
maxLength: 5000
type: string
last_name:
maxLength: 100
type: string
last_name_kana:
maxLength: 5000
type: string
last_name_kanji:
maxLength: 5000
type: string
maiden_name:
maxLength: 5000
type: string
metadata:
anyOf:
- additionalProperties:
type: string
type: object
- enum:
- ''
type: string
phone:
type: string
ssn_last_4:
maxLength: 5000
type: string
verification:
properties:
additional_document:
properties:
back:
maxLength: 500
type: string
front:
maxLength: 500
type: string
title: person_verification_document_specs
type: object
document:
properties:
back:
maxLength: 500
type: string
front:
maxLength: 500
type: string
title: person_verification_document_specs
type: object
title: person_verification_specs
type: object
title: individual_specs
type: object
metadata:
anyOf:
- additionalProperties:
type: string
type: object
- enum:
- ''
type: string
description: 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`.
requested_capabilities:
description: The set of capabilities you want to unlock for this
account. Each capability will be inactive until you have provided
its specific requirements and Stripe has verified them. An account
may have some of its requested capabilities be active and some
be inactive.
items:
enum:
- au_becs_debit_payments
- bacs_debit_payments
- card_issuing
- card_payments
- jcb_payments
- legacy_payments
- tax_reporting_us_1099_k
- tax_reporting_us_1099_misc
- transfers
maxLength: 5000
type: string
x-stripeBypassValidation: true
type: array
settings:
description: Options for customizing how the account functions within
Stripe.
properties:
branding:
properties:
icon:
maxLength: 5000
type: string
logo:
maxLength: 5000
type: string
primary_color:
maxLength: 5000
type: string
secondary_color:
maxLength: 5000
type: string
title: branding_settings_specs
type: object
card_payments:
properties:
decline_on:
properties:
avs_failure:
type: boolean
cvc_failure:
type: boolean
title: decline_charge_on_specs
type: object
statement_descriptor_prefix:
maxLength: 10
type: string
title: card_payments_settings_specs
type: object
payments:
properties:
statement_descriptor:
maxLength: 22
type: string
statement_descriptor_kana:
maxLength: 22
type: string
statement_descriptor_kanji:
maxLength: 22
type: string
title: payments_settings_specs
type: object
payouts:
properties:
debit_negative_balances:
type: boolean
schedule:
properties:
delay_days:
anyOf:
- enum:
- minimum
maxLength: 5000
type: string
- type: integer
interval:
enum:
- daily
- manual
- monthly
- weekly
maxLength: 5000
type: string
x-stripeBypassValidation: true
monthly_anchor:
type: integer
weekly_anchor:
enum:
- friday
- monday
- saturday
- sunday
- thursday
- tuesday
- wednesday
maxLength: 5000
type: string
title: transfer_schedule_specs
type: object
statement_descriptor:
maxLength: 22
type: string
title: payout_settings_specs
type: object
title: settings_specs
type: object
tos_acceptance:
description: Details on the account's acceptance of the [Stripe
Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance).
properties:
date:
format: unix-time
type: integer
ip:
type: string
user_agent:
maxLength: 5000
type: string
title: tos_acceptance_specs
type: object
type:
description: The type of Stripe account to create. Currently must
be `custom`, as only [Custom accounts](https://stripe.com/docs/connect/custom-accounts)
may be created via the API.
enum:
- custom
- express
- standard
type: string
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/account"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
"/v1/accounts/{account}":
delete:
description: |-
<p>With <a href="/docs/connect">Connect</a>, you can delete Custom or Express accounts you manage.</p>
<p>Accounts created using test-mode keys can be deleted at any time. Accounts created using live-mode keys can only be deleted once all balances are zero.</p>
<p>If you want to delete your own account, use the <a href="https://dashboard.stripe.com/account">account information tab in your account settings</a> instead.</p>
operationId: DeleteAccountsAccount
parameters:
- in: path
name: account
required: true
schema:
maxLength: 5000
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties: {}
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/deleted_account"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
get:
description: "<p>Retrieves the details of an account.</p>"
operationId: GetAccountsAccount
parameters:
- in: path
name: account
required: true
schema:
maxLength: 5000
type: string
style: simple
- description: Specifies which fields in the response should be expanded.
explode: true
in: query
name: expand
required: false
schema:
items:
maxLength: 5000
type: string
type: array
style: deepObject
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties: {}
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/account"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
post:
description: |-
<p>Updates a connected <a href="/docs/connect/accounts">Express or Custom account</a> by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked <strong>Custom Only</strong> below.) Parameters marked <strong>Custom and Express</strong> are supported by both account types.</p>
<p>To update your own account, use the <a href="https://dashboard.stripe.com/account">Dashboard</a>. Refer to our <a href="/docs/connect/updating-accounts">Connect</a> documentation to learn more about updating accounts.</p>
operationId: PostAccountsAccount
parameters:
- in: path
name: account
required: true
schema:
maxLength: 5000
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
bank_account:
explode: true
style: deepObject
business_profile:
explode: true
style: deepObject
company:
explode: true
style: deepObject
expand:
explode: true
style: deepObject
individual:
explode: true
style: deepObject
metadata:
explode: true
style: deepObject
requested_capabilities:
explode: true
style: deepObject
settings:
explode: true
style: deepObject
tos_acceptance:
explode: true
style: deepObject
schema:
additionalProperties: false
properties:
account_token:
description: An [account token](https://stripe.com/docs/api#create_account_token),
used to securely provide details to the account.
maxLength: 5000
type: string
bank_account:
anyOf:
- properties:
account_holder_name:
maxLength: 5000
type: string
account_holder_type:
enum:
- company
- individual
maxLength: 5000
type: string
account_number:
maxLength: 5000
type: string
country:
maxLength: 5000
type: string
currency:
type: string
object:
enum:
- bank_account
maxLength: 5000
type: string
routing_number:
maxLength: 5000
type: string
required:
- account_number
- country
title: external_account_payout_bank_account
type: object
- maxLength: 5000
type: string
description: Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js),
or a dictionary containing a user's bank account details.
business_profile:
description: Business information about the account.
properties:
mcc:
maxLength: 4
type: string
name:
maxLength: 5000
type: string
product_description:
maxLength: 40000
type: string
support_address:
properties:
city:
maxLength: 100
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 200
type: string
line2:
maxLength: 200
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
title: address_specs
type: object
support_email:
type: string
support_phone:
maxLength: 5000
type: string
support_url:
type: string
url:
maxLength: 5000
type: string
title: business_profile_specs
type: object
business_type:
description: The business type.
enum:
- company
- government_entity
- individual
- non_profit
type: string
x-stripeBypassValidation: true
company:
description: Information about the company or business. This field
is null unless `business_type` is set to `company`, `government_entity`,
or `non_profit`.
properties:
address:
properties:
city:
maxLength: 100
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 200
type: string
line2:
maxLength: 200
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
title: address_specs
type: object
address_kana:
properties:
city:
maxLength: 5000
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 5000
type: string
line2:
maxLength: 5000
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
town:
maxLength: 5000
type: string
title: japan_address_kana_specs
type: object
address_kanji:
properties:
city:
maxLength: 5000
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 5000
type: string
line2:
maxLength: 5000
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
town:
maxLength: 5000
type: string
title: japan_address_kanji_specs
type: object
directors_provided:
type: boolean
executives_provided:
type: boolean
name:
maxLength: 100
type: string
name_kana:
maxLength: 100
type: string
name_kanji:
maxLength: 100
type: string
owners_provided:
type: boolean
phone:
maxLength: 5000
type: string
structure:
enum:
- ''
- government_instrumentality
- governmental_unit
- incorporated_non_profit
- limited_liability_partnership
- multi_member_llc
- private_company
- private_corporation
- private_partnership
- public_company
- public_corporation
- public_partnership
- sole_proprietorship
- tax_exempt_government_instrumentality
- unincorporated_association
- unincorporated_non_profit
type: string
x-stripeBypassValidation: true
tax_id:
maxLength: 5000
type: string
tax_id_registrar:
maxLength: 5000
type: string
vat_id:
maxLength: 5000
type: string
verification:
properties:
document:
properties:
back:
maxLength: 500
type: string
front:
maxLength: 500
type: string
title: verification_document_specs
type: object
title: verification_specs
type: object
title: company_specs
type: object
default_currency:
description: 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](https://stripe.com/docs/payouts).
type: string
email:
description: Email address of the account representative. For Standard
accounts, this is used to ask them to claim their Stripe account.
For Custom accounts, this only makes the account easier to identify
to platforms; Stripe does not email the account representative.
type: string
expand:
description: Specifies which fields in the response should be expanded.
items:
maxLength: 5000
type: string
type: array
external_account:
description: A card or bank account to attach to the account. You
can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js),
or a dictionary, as documented in the `external_account` parameter
for [bank account](https://stripe.com/docs/api#account_create_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 API.
maxLength: 5000
type: string
x-stripeBypassValidation: true
individual:
description: Information about the person represented by the account.
This field is null unless `business_type` is set to `individual`.
properties:
address:
properties:
city:
maxLength: 100
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 200
type: string
line2:
maxLength: 200
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
title: address_specs
type: object
address_kana:
properties:
city:
maxLength: 5000
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 5000
type: string
line2:
maxLength: 5000
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
town:
maxLength: 5000
type: string
title: japan_address_kana_specs
type: object
address_kanji:
properties:
city:
maxLength: 5000
type: string
country:
maxLength: 5000
type: string
line1:
maxLength: 5000
type: string
line2:
maxLength: 5000
type: string
postal_code:
maxLength: 5000
type: string
state:
maxLength: 5000
type: string
town:
maxLength: 5000
type: string
title: japan_address_kanji_specs
type: object
dob:
anyOf:
- properties:
day:
type: integer
month:
type: integer
year:
type: integer
required:
- day
- month
- year
title: date_of_birth_specs
type: object
- enum:
- ''
type: string
email:
type: string
first_name:
maxLength: 100
type: string
first_name_kana:
maxLength: 5000
type: string
first_name_kanji:
maxLength: 5000
type: string
gender:
maxLength: 5000
type: string
id_number:
maxLength: 5000
type: string
last_name:
maxLength: 100
type: string
last_name_kana:
maxLength: 5000
type: string
last_name_kanji:
maxLength: 5000
type: string
maiden_name:
maxLength: 5000
type: string
metadata:
anyOf:
- additionalProperties:
type: string
type: object
- enum:
- ''
type: string
phone:
type: string
ssn_last_4:
maxLength: 5000
type: string
verification:
properties:
additional_document:
properties:
back:
maxLength: 500
type: string
front:
maxLength: 500
type: string
title: person_verification_document_specs
type: object
document:
properties:
back:
maxLength: 500
type: string
front:
maxLength: 500
type: string
title: person_verification_document_specs
type: object
title: person_verification_specs
type: object
title: individual_specs
type: object
metadata:
anyOf:
- additionalProperties:
type: string
type: object
- enum:
- ''
type: string
description: 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`.
requested_capabilities:
description: The set of capabilities you want to unlock for this
account. Each capability will be inactive until you have provided
its specific requirements and Stripe has verified them. An account
may have some of its requested capabilities be active and some
be inactive.
items:
enum:
- au_becs_debit_payments
- bacs_debit_payments
- card_issuing
- card_payments
- jcb_payments
- legacy_payments
- tax_reporting_us_1099_k
- tax_reporting_us_1099_misc
- transfers
maxLength: 5000
type: string
x-stripeBypassValidation: true
type: array
settings:
description: Options for customizing how the account functions within
Stripe.
properties:
branding:
properties:
icon:
maxLength: 5000
type: string
logo:
maxLength: 5000
type: string
primary_color:
maxLength: 5000
type: string
secondary_color:
maxLength: 5000
type: string
title: branding_settings_specs
type: object
card_payments:
properties:
decline_on:
properties:
avs_failure:
type: boolean
cvc_failure:
type: boolean
title: decline_charge_on_specs
type: object
statement_descriptor_prefix:
maxLength: 10
type: string
title: card_payments_settings_specs
type: object
payments:
properties:
statement_descriptor:
maxLength: 22
type: string
statement_descriptor_kana:
maxLength: 22
type: string
statement_descriptor_kanji:
maxLength: 22
type: string
title: payments_settings_specs
type: object
payouts:
properties:
debit_negative_balances:
type: boolean
schedule:
properties:
delay_days:
anyOf:
- enum:
- minimum
maxLength: 5000
type: string
- type: integer
interval:
enum:
- daily
- manual
- monthly
- weekly
maxLength: 5000
type: string
x-stripeBypassValidation: true
monthly_anchor:
type: integer
weekly_anchor:
enum:
- friday
- monday
- saturday
- sunday
- thursday
- tuesday
- wednesday
maxLength: 5000
type: string
title: transfer_schedule_specs
type: object
statement_descriptor:
maxLength: 22
type: string
title: payout_settings_specs
type: object
title: settings_specs
type: object
tos_acceptance:
description: Details on the account's acceptance of the [Stripe
Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance).
properties:
date:
format: unix-time
type: integer
ip:
type: string
user_agent:
maxLength: 5000
type: string
title: tos_acceptance_specs
type: object
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/account"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
"/v1/accounts/{account}/bank_accounts":
post:
description: "<p>Create an external account for a given account.</p>"
operationId: PostAccountsAccountBankAccounts
parameters:
- in: path
name: account
required: true
schema:
maxLength: 5000
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
bank_account:
explode: true
style: deepObject
expand:
explode: true
style: deepObject
metadata:
explode: true
style: deepObject
schema:
additionalProperties: false
properties:
bank_account:
anyOf:
- properties:
account_holder_name:
maxLength: 5000
type: string
account_holder_type:
enum:
- company
- individual
maxLength: 5000
type: string
account_number:
maxLength: 5000
type: string
country:
maxLength: 5000
type: string
currency:
type: string
object:
enum:
- bank_account
maxLength: 5000
type: string
routing_number:
maxLength: 5000
type: string
required:
- account_number
- country
title: external_account_payout_bank_account
type: object
- maxLength: 5000
type: string
description: Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js),
or a dictionary containing a user's bank account details.
default_for_currency:
description: 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.
type: boolean
expand:
description: Specifies which fields in the response should be expanded.
items:
maxLength: 5000
type: string
type: array
external_account:
description: Please refer to full [documentation](https://stripe.com/docs/api)
instead.
maxLength: 5000
type: string
x-stripeBypassValidation: true
metadata:
additionalProperties:
type: string
description: 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`.
type: object
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/external_account"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
"/v1/accounts/{account}/bank_accounts/{id}":
delete:
description: "<p>Delete a specified external account for a given account.</p>"
operationId: DeleteAccountsAccountBankAccountsId
parameters:
- in: path
name: account
required: true
schema:
maxLength: 5000
type: string
style: simple
- in: path
name: id
required: true
schema:
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties: {}
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/deleted_external_account"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
get:
description: "<p>Retrieve a specified external account for a given account.</p>"
operationId: GetAccountsAccountBankAccountsId
parameters:
- in: path
name: account
required: true
schema:
maxLength: 5000
type: string
style: simple
- description: Specifies which fields in the response should be expanded.
explode: true
in: query
name: expand
required: false
schema:
items:
maxLength: 5000
type: string
type: array
style: deepObject
- in: path
name: id
required: true
schema:
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties: {}
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/external_account"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
post:
description: |-
<p>Updates the metadata, account holder name, and account holder type of a bank account belonging to a <a href="/docs/connect/custom-accounts">Custom account</a>, and optionally sets it as the default for its currency. Other bank account details are not editable by design.</p>
<p>You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.</p>
operationId: PostAccountsAccountBankAccountsId
parameters:
- in: path
name: account
required: true
schema:
maxLength: 5000
type: string
style: simple
- in: path
name: id
required: true
schema:
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
expand:
explode: true
style: deepObject
metadata:
explode: true
style: deepObject
schema:
additionalProperties: false
properties:
account_holder_name:
description: The name of the person or business that owns the bank
account.
maxLength: 5000
type: string
account_holder_type:
description: The type of entity that holds the account. This can
be either `individual` or `company`.
enum:
- ''
- company
- individual
maxLength: 5000
type: string
address_city:
description: City/District/Suburb/Town/Village.
maxLength: 5000
type: string
address_country:
description: Billing address country, if provided when creating
card.
maxLength: 5000
type: string
address_line1:
description: Address line 1 (Street address/PO Box/Company name).
maxLength: 5000
type: string
address_line2:
description: Address line 2 (Apartment/Suite/Unit/Building).
maxLength: 5000
type: string
address_state:
description: State/County/Province/Region.
maxLength: 5000
type: string
address_zip:
description: ZIP or postal code.
maxLength: 5000
type: string
default_for_currency:
description: When set to true, this becomes the default external
account for its currency.
type: boolean
exp_month:
description: Two digit number representing the card’s expiration
month.
maxLength: 5000
type: string
exp_year:
description: Four digit number representing the card’s expiration
year.
maxLength: 5000
type: string
expand:
description: Specifies which fields in the response should be expanded.
items:
maxLength: 5000
type: string
type: array
metadata:
anyOf:
- additionalProperties:
type: string
type: object
- enum:
- ''
type: string
description: 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:
description: Cardholder name.
maxLength: 5000
type: string
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/external_account"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
"/v1/accounts/{account}/capabilities":
get:
description: "<p>Returns a list of capabilities associated with the account.
The capabilities are returned sorted by creation date, with the most recent
capability appearing first.</p>"
operationId: GetAccountsAccountCapabilities
parameters:
- in: path
name: account
required: true
schema:
maxLength: 5000
type: string
style: simple
- description: Specifies which fields in the response should be expanded.
explode: true
in: query
name: expand
required: false
schema:
items:
maxLength: 5000
type: string
type: array
style: deepObject
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties: {}
type: object
required: false
responses:
'200':
content:
application/json:
schema:
description: ''
properties:
data:
items:
"$ref": "#/components/schemas/capability"
type: array
has_more:
description: True if this list has another page of items after
this one that can be fetched.
type: boolean
object:
description: String representing the object's type. Objects of
the same type share the same value. Always has the value `list`.
enum:
- list
type: string
url:
description: The URL where this list can be accessed.
maxLength: 5000
type: string
required:
- data
- has_more
- object
- url
title: ListAccountCapability
type: object
x-expandableFields:
- data
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
"/v1/accounts/{account}/capabilities/{capability}":
get:
description: "<p>Retrieves information about the specified Account Capability.</p>"
operationId: GetAccountsAccountCapabilitiesCapability
parameters:
- in: path
name: account
required: true
schema:
maxLength: 5000
type: string
style: simple
- in: path
name: capability
required: true
schema:
type: string
style: simple
- description: Specifies which fields in the response should be expanded.
explode: true
in: query
name: expand
required: false
schema:
items:
maxLength: 5000
type: string
type: array
style: deepObject
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties: {}
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/capability"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
post:
description: "<p>Updates an existing Account Capability.</p>"
operationId: PostAccountsAccountCapabilitiesCapability
parameters:
- in: path
name: account
required: true
schema:
maxLength: 5000
type: string
style: simple
- in: path
name: capability
required: true
schema:
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
expand:
explode: true
style: deepObject
schema:
additionalProperties: false
properties:
expand:
description: Specifies which fields in the response should be expanded.
items:
maxLength: 5000
type: string
type: array
requested:
description: Passing true requests the capability for the account,
if it is not already requested. A requested capability may not
immediately become active. Any requirements to activate the capability
are returned in the `requirements` arrays.
type: boolean
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/capability"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
"/v1/accounts/{account}/external_accounts":
get:
description: "<p>List external accounts for an account.</p>"
operationId: GetAccountsAccountExternalAccounts
parameters:
- in: path
name: account
required: true
schema:
maxLength: 5000
type: string
style: simple
- description: A cursor for use in pagination. `ending_before` is an object
ID that defines your place in the list. For instance, if you make a list
request and receive 100 objects, starting with `obj_bar`, your subsequent
call can include `ending_before=obj_bar` in order to fetch the previous
page of the list.
in: query
name: ending_before
required: false
schema:
type: string
style: form
- description: Specifies which fields in the response should be expanded.
explode: true
in: query
name: expand
required: false
schema:
items:
maxLength: 5000
type: string
type: array
style: deepObject
- description: A limit on the number of objects to be returned. Limit can range
between 1 and 100, and the default is 10.
in: query
name: limit
required: false
schema:
type: integer
style: form
- description: A cursor for use in pagination. `starting_after` is an object
ID that defines your place in the list. For instance, if you make a list
request and receive 100 objects, ending with `obj_foo`, your subsequent
call can include `starting_after=obj_foo` in order to fetch the next page
of the list.
in: query
name: starting_after
required: false
schema:
type: string
style: form
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties: {}
type: object
required: false
responses:
'200':
content:
application/json:
schema:
description: ''
properties:
data:
description: The list contains all external accounts that have
been attached to the Stripe account. These may be bank accounts
or cards.
items:
anyOf:
- "$ref": "#/components/schemas/bank_account"
- "$ref": "#/components/schemas/card"
title: Polymorphic
type: array
has_more:
description: True if this list has another page of items after
this one that can be fetched.
type: boolean
object:
description: String representing the object's type. Objects of
the same type share the same value. Always has the value `list`.
enum:
- list
type: string
url:
description: The URL where this list can be accessed.
maxLength: 5000
type: string
required:
- data
- has_more
- object
- url
title: ExternalAccountList
type: object
x-expandableFields:
- data
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
post:
description: "<p>Create an external account for a given account.</p>"
operationId: PostAccountsAccountExternalAccounts
parameters:
- in: path
name: account
required: true
schema:
maxLength: 5000
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
bank_account:
explode: true
style: deepObject
expand:
explode: true
style: deepObject
metadata:
explode: true
style: deepObject
schema:
additionalProperties: false
properties:
bank_account:
anyOf:
- properties:
account_holder_name:
maxLength: 5000
type: string
account_holder_type:
enum:
- company
- individual
maxLength: 5000
type: string
account_number:
maxLength: 5000
type: string
country:
maxLength: 5000
type: string
currency:
type: string
object:
enum:
- bank_account
maxLength: 5000
type: string
routing_number:
maxLength: 5000
type: string
required:
- account_number
- country
title: external_account_payout_bank_account
type: object
- maxLength: 5000
type: string
description: Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js),
or a dictionary containing a user's bank account details.
default_for_currency:
description: 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.
type: boolean
expand:
description: Specifies which fields in the response should be expanded.
items:
maxLength: 5000
type: string
type: array
external_account:
description: Please refer to full [documentation](https://stripe.com/docs/api)
instead.
maxLength: 5000
type: string
x-stripeBypassValidation: true
metadata:
additionalProperties:
type: string
description: 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`.
type: object
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/external_account"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
"/v1/accounts/{account}/external_accounts/{id}":
delete:
description: "<p>Delete a specified external account for a given account.</p>"
operationId: DeleteAccountsAccountExternalAccountsId
parameters:
- in: path
name: account
required: true
schema:
maxLength: 5000
type: string
style: simple
- in: path
name: id
required: true
schema:
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties: {}
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/deleted_external_account"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
get:
description: "<p>Retrieve a specified external account for a given account.</p>"
operationId: GetAccountsAccountExternalAccountsId
parameters:
- in: path
name: account
required: true
schema:
maxLength: 5000
type: string
style: simple
- description: Specifies which fields in the response should be expanded.
explode: true
in: query
name: expand
required: false
schema:
items:
maxLength: 5000
type: string
type: array
style: deepObject
- in: path
name: id
required: true
schema:
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties: {}
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/external_account"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
post:
description: |-
<p>Updates the metadata, account holder name, and account holder type of a bank account belonging to a <a href="/docs/connect/custom-accounts">Custom account</a>, and optionally sets it as the default for its currency. Other bank account details are not editable by design.</p>
<p>You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.</p>
operationId: PostAccountsAccountExternalAccountsId
parameters:
- in: path
name: account
required: true
schema:
maxLength: 5000
type: string
style: simple
- in: path
name: id
required: true
schema:
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
expand:
explode: true
style: deepObject
metadata:
explode: true
style: deepObject
schema:
additionalProperties: false
properties:
account_holder_name:
description: The name of the person or business that owns the bank
account.
maxLength: 5000
type: string
account_holder_type:
description: The type of entity that holds the account. This can
be either `individual` or `company`.
enum:
- ''
- company
- individual
maxLength: 5000
type: string
address_city:
description: City/District/Suburb/Town/Village.
maxLength: 5000
type: string
address_country:
description: Billing address country, if provided when creating
card.
maxLength: 5000
type: string
address_line1:
description: Address line 1 (Street address/PO Box/Company name).
maxLength: 5000
type: string
address_line2:
description: Address line 2 (Apartment/Suite/Unit/Building).
maxLength: 5000
type: string
address_state:
description: State/County/Province/Region.
maxLength: 5000
type: string
address_zip:
description: ZIP or postal code.
maxLength: 5000
type: string
default_for_currency:
description: When set to true, this becomes the default external
account for its currency.
type: boolean
exp_month:
description: Two digit number representing the card’s expiration
month.
maxLength: 5000
type: string
exp_year:
description: Four digit number representing the card’s expiration
year.
maxLength: 5000
type: string
expand:
description: Specifies which fields in the response should be expanded.
items:
maxLength: 5000
type: string
type: array
metadata:
anyOf:
- additionalProperties:
type: string
type: object
- enum:
- ''
type: string
description: 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:
description: Cardholder name.
maxLength: 5000
type: string
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/external_account"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
"/v1/accounts/{account}/login_links":
post:
description: |-
<p>Creates a single-use login link for an Express account to access their Stripe dashboard.</p>
<p><strong>You may only create login links for <a href="/docs/connect/express-accounts">Express accounts</a> connected to your platform</strong>.</p>
operationId: PostAccountsAccountLoginLinks
parameters:
- in: path
name: account
required: true
schema:
maxLength: 5000
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
expand:
explode: true
style: deepObject
schema:
additionalProperties: false
properties:
expand:
description: Specifies which fields in the response should be expanded.
items:
maxLength: 5000
type: string
type: array
redirect_url:
description: Where to redirect the user after they log out of their
dashboard.
type: string
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/login_link"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
"/v1/accounts/{account}/logout":
put:
description: |-
<p>Invalidates all sessions for a light account, for a platform to use during platform logout.</p>
<p><strong>You may only log out <a href="/docs/connect/express-accounts">Express accounts</a> connected to your platform</strong>.</p>
operationId: PutAccountsAccountLogout
parameters:
- in: path
name: account
required: true
schema:
maxLength: 5000
type: string
style: simple
requestBody:
content:
application/x-www-form-urlencoded:
encoding:
expand:
explode: true
style: deepObject
schema:
additionalProperties: false
properties:
expand:
description: Specifies which fields in the response should be expanded.
items:
maxLength: 5000
type: string
type: array
type: object
required: false
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/light_account_logout"
description: Successful response.
default:
content:
application/json:
schema:
"$ref": "#/components/schemas/error"
description: Error response.
"/v1/accounts/{account}/people":
get:
description: "<p>Returns a list of people associated with the account’s legal
entity. The people are returned sorted by creation date, with the most recent
people appearing first.</p>"
operationId: GetAccountsAccountPeople
parameters:
- in: path
name: account
required: true
schema:
maxLength: 5000
type: string
style: simple
- description: A cursor for use in pagination. `ending_before` is an object
ID that defines your place in the list. For instance, if you make a list
request and receive 100 objects, starting with `obj_bar`, your subsequent
call can include `ending_before=obj_bar` in order to fetch the previous
page of the list.
in: query
name: ending_before
required: false
schema:
maxLength: 5000
type: string
style: form
- description: Specifies which fields in the response should be expanded.
explode: true
in: query
name: expand
required: false
schema:
items:
maxLength: 5000
type: string
type: array
style: deepObject
- description: A limit on the number of objects to be returned. Limit can range
between 1 and 100, and the default is 10.
in: query
name: limit
required: false
schema:
type: integer
style: form
- description: Filters on the list of people returned based on the person's
relationship to the account's company.
explode: true
in: query
name: relationship
required: false
schema:
properties:
director:
type: boolean
executive:
type: boolean
owner:
type: boolean
representative:
type: boolean
title: all_people_relationship_specs
type: object
style: deepObject
- description: A cursor for use in pagination. `starting_after` is an object
ID that defines your place in the list. For instance, if you make a list
request and receive 100 objects, ending with `obj_foo`, your subsequent
call can include `starting_after=obj_foo` in order to fetch the next page
of the list.
in: query
name: starting_after
required: false
schema:
maxLength: 5000
type: string
style: form
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
additionalProperties: false
properties: {}
type: object
required: false
responses:
'200':
content:
application/json:
schema:
description: ''
properties:
data:
items:
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment