Created
September 2, 2021 07:53
-
-
Save Radiergummi/74e47a4e8e1ca766a27d053679eb6839 to your computer and use it in GitHub Desktop.
This file has been truncated, but you can view the full file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "$schema": "http://json-schema.org/draft-07/schema#", | |
| "definitions": { | |
| "Stripe.Account": { | |
| "description": "The Account object.", | |
| "properties": { | |
| "business_profile": { | |
| "$ref": "#/definitions/Stripe.Account.BusinessProfile", | |
| "description": "Business information about the account." | |
| }, | |
| "business_type": { | |
| "description": "The business type.", | |
| "enum": [ | |
| "company", | |
| "government_entity", | |
| "individual", | |
| "non_profit" | |
| ], | |
| "type": "string" | |
| }, | |
| "capabilities": { | |
| "$ref": "#/definitions/Stripe.Account.Capabilities" | |
| }, | |
| "charges_enabled": { | |
| "description": "Whether the account can create live charges.", | |
| "type": "boolean" | |
| }, | |
| "company": { | |
| "$ref": "#/definitions/Stripe.Account.Company" | |
| }, | |
| "controller": { | |
| "$ref": "#/definitions/Stripe.Account.Controller" | |
| }, | |
| "country": { | |
| "description": "The account's country.", | |
| "type": "string" | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "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" | |
| }, | |
| "deleted": { | |
| "type": "string" | |
| }, | |
| "details_submitted": { | |
| "description": "Whether account details have been submitted. Standard accounts cannot receive payouts before this is true.", | |
| "type": "boolean" | |
| }, | |
| "email": { | |
| "description": "An email address associated with the account. You can treat this as metadata: it is not used for authentication or messaging account holders.", | |
| "type": "string" | |
| }, | |
| "external_accounts": { | |
| "$ref": "#/definitions/Stripe.ApiList<Stripe.BankAccount|Stripe.Card>", | |
| "description": "External accounts (bank accounts and debit cards) currently attached to this account" | |
| }, | |
| "future_requirements": { | |
| "$ref": "#/definitions/Stripe.Account.FutureRequirements" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "individual": { | |
| "$ref": "#/definitions/Stripe.Person", | |
| "description": "This is an object representing a person associated with a Stripe account.\n\nA platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account.\nSee the [Standard onboarding](https://stripe.com/docs/connect/standard-accounts) or [Express onboarding documentation](https://stripe.com/docs/connect/express-accounts) for information about platform pre-filling and account onboarding steps.\n\nRelated guide: [Handling Identity Verification with the API](https://stripe.com/docs/connect/identity-verification-api#person-information)." | |
| }, | |
| "metadata": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "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": "#/definitions/Stripe.Account.Requirements" | |
| }, | |
| "settings": { | |
| "$ref": "#/definitions/Stripe.Account.Settings", | |
| "description": "Options for customizing how the account functions within Stripe." | |
| }, | |
| "tos_acceptance": { | |
| "$ref": "#/definitions/Stripe.Account.TosAcceptance" | |
| }, | |
| "type": { | |
| "$ref": "#/definitions/Stripe.Account.Type", | |
| "description": "The Stripe account type. Can be `standard`, `express`, or `custom`." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Account.BusinessProfile": { | |
| "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.", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "description": "The customer-facing business name.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "support_address": { | |
| "$ref": "#/definitions/Stripe.Address", | |
| "description": "A publicly available mailing address for sending support issues to." | |
| }, | |
| "support_email": { | |
| "description": "A publicly available email address for sending support issues to.", | |
| "type": "string" | |
| }, | |
| "support_phone": { | |
| "description": "A publicly available phone number to call with support issues.", | |
| "type": "string" | |
| }, | |
| "support_url": { | |
| "description": "A publicly available website for handling support issues.", | |
| "type": "string" | |
| }, | |
| "url": { | |
| "description": "The business's publicly available website.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Account.Capabilities": { | |
| "properties": { | |
| "acss_debit_payments": { | |
| "$ref": "#/definitions/Stripe.Account.Capabilities.AcssDebitPayments", | |
| "description": "The status of the Canadian pre-authorized debits payments capability of the account, or whether the account can directly process Canadian pre-authorized debits charges." | |
| }, | |
| "afterpay_clearpay_payments": { | |
| "$ref": "#/definitions/Stripe.Account.Capabilities.AfterpayClearpayPayments", | |
| "description": "The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges." | |
| }, | |
| "au_becs_debit_payments": { | |
| "$ref": "#/definitions/Stripe.Account.Capabilities.AuBecsDebitPayments", | |
| "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." | |
| }, | |
| "bacs_debit_payments": { | |
| "$ref": "#/definitions/Stripe.Account.Capabilities.BacsDebitPayments", | |
| "description": "The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges." | |
| }, | |
| "bancontact_payments": { | |
| "$ref": "#/definitions/Stripe.Account.Capabilities.BancontactPayments", | |
| "description": "The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges." | |
| }, | |
| "boleto_payments": { | |
| "$ref": "#/definitions/Stripe.Account.Capabilities.BoletoPayments", | |
| "description": "The status of the boleto payments capability of the account, or whether the account can directly process boleto charges." | |
| }, | |
| "card_issuing": { | |
| "$ref": "#/definitions/Stripe.Account.Capabilities.CardIssuing", | |
| "description": "The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards" | |
| }, | |
| "card_payments": { | |
| "$ref": "#/definitions/Stripe.Account.Capabilities.CardPayments", | |
| "description": "The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges." | |
| }, | |
| "cartes_bancaires_payments": { | |
| "$ref": "#/definitions/Stripe.Account.Capabilities.CartesBancairesPayments", | |
| "description": "The status of the Cartes Bancaires payments capability of the account, or whether the account can directly process Cartes Bancaires card charges in EUR currency." | |
| }, | |
| "eps_payments": { | |
| "$ref": "#/definitions/Stripe.Account.Capabilities.EpsPayments", | |
| "description": "The status of the EPS payments capability of the account, or whether the account can directly process EPS charges." | |
| }, | |
| "fpx_payments": { | |
| "$ref": "#/definitions/Stripe.Account.Capabilities.FpxPayments", | |
| "description": "The status of the FPX payments capability of the account, or whether the account can directly process FPX charges." | |
| }, | |
| "giropay_payments": { | |
| "$ref": "#/definitions/Stripe.Account.Capabilities.GiropayPayments", | |
| "description": "The status of the giropay payments capability of the account, or whether the account can directly process giropay charges." | |
| }, | |
| "grabpay_payments": { | |
| "$ref": "#/definitions/Stripe.Account.Capabilities.GrabpayPayments", | |
| "description": "The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges." | |
| }, | |
| "ideal_payments": { | |
| "$ref": "#/definitions/Stripe.Account.Capabilities.IdealPayments", | |
| "description": "The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges." | |
| }, | |
| "jcb_payments": { | |
| "$ref": "#/definitions/Stripe.Account.Capabilities.JcbPayments", | |
| "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." | |
| }, | |
| "legacy_payments": { | |
| "$ref": "#/definitions/Stripe.Account.Capabilities.LegacyPayments", | |
| "description": "The status of the legacy payments capability of the account." | |
| }, | |
| "oxxo_payments": { | |
| "$ref": "#/definitions/Stripe.Account.Capabilities.OxxoPayments", | |
| "description": "The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges." | |
| }, | |
| "p24_payments": { | |
| "$ref": "#/definitions/Stripe.Account.Capabilities.P24Payments", | |
| "description": "The status of the P24 payments capability of the account, or whether the account can directly process P24 charges." | |
| }, | |
| "sepa_debit_payments": { | |
| "$ref": "#/definitions/Stripe.Account.Capabilities.SepaDebitPayments", | |
| "description": "The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges." | |
| }, | |
| "sofort_payments": { | |
| "$ref": "#/definitions/Stripe.Account.Capabilities.SofortPayments", | |
| "description": "The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges." | |
| }, | |
| "tax_reporting_us_1099_k": { | |
| "$ref": "#/definitions/Stripe.Account.Capabilities.TaxReportingUs1099K", | |
| "description": "The status of the tax reporting 1099-K (US) capability of the account." | |
| }, | |
| "tax_reporting_us_1099_misc": { | |
| "$ref": "#/definitions/Stripe.Account.Capabilities.TaxReportingUs1099Misc", | |
| "description": "The status of the tax reporting 1099-MISC (US) capability of the account." | |
| }, | |
| "transfers": { | |
| "$ref": "#/definitions/Stripe.Account.Capabilities.Transfers", | |
| "description": "The status of the transfers capability of the account, or whether your platform can transfer funds to the account." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Account.Capabilities.AcssDebitPayments": { | |
| "enum": [ | |
| "active", | |
| "inactive", | |
| "pending" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Account.Capabilities.AfterpayClearpayPayments": { | |
| "enum": [ | |
| "active", | |
| "inactive", | |
| "pending" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Account.Capabilities.AuBecsDebitPayments": { | |
| "enum": [ | |
| "active", | |
| "inactive", | |
| "pending" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Account.Capabilities.BacsDebitPayments": { | |
| "enum": [ | |
| "active", | |
| "inactive", | |
| "pending" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Account.Capabilities.BancontactPayments": { | |
| "enum": [ | |
| "active", | |
| "inactive", | |
| "pending" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Account.Capabilities.BoletoPayments": { | |
| "enum": [ | |
| "active", | |
| "inactive", | |
| "pending" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Account.Capabilities.CardIssuing": { | |
| "enum": [ | |
| "active", | |
| "inactive", | |
| "pending" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Account.Capabilities.CardPayments": { | |
| "enum": [ | |
| "active", | |
| "inactive", | |
| "pending" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Account.Capabilities.CartesBancairesPayments": { | |
| "enum": [ | |
| "active", | |
| "inactive", | |
| "pending" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Account.Capabilities.EpsPayments": { | |
| "enum": [ | |
| "active", | |
| "inactive", | |
| "pending" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Account.Capabilities.FpxPayments": { | |
| "enum": [ | |
| "active", | |
| "inactive", | |
| "pending" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Account.Capabilities.GiropayPayments": { | |
| "enum": [ | |
| "active", | |
| "inactive", | |
| "pending" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Account.Capabilities.GrabpayPayments": { | |
| "enum": [ | |
| "active", | |
| "inactive", | |
| "pending" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Account.Capabilities.IdealPayments": { | |
| "enum": [ | |
| "active", | |
| "inactive", | |
| "pending" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Account.Capabilities.JcbPayments": { | |
| "enum": [ | |
| "active", | |
| "inactive", | |
| "pending" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Account.Capabilities.LegacyPayments": { | |
| "enum": [ | |
| "active", | |
| "inactive", | |
| "pending" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Account.Capabilities.OxxoPayments": { | |
| "enum": [ | |
| "active", | |
| "inactive", | |
| "pending" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Account.Capabilities.P24Payments": { | |
| "enum": [ | |
| "active", | |
| "inactive", | |
| "pending" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Account.Capabilities.SepaDebitPayments": { | |
| "enum": [ | |
| "active", | |
| "inactive", | |
| "pending" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Account.Capabilities.SofortPayments": { | |
| "enum": [ | |
| "active", | |
| "inactive", | |
| "pending" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Account.Capabilities.TaxReportingUs1099K": { | |
| "enum": [ | |
| "active", | |
| "inactive", | |
| "pending" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Account.Capabilities.TaxReportingUs1099Misc": { | |
| "enum": [ | |
| "active", | |
| "inactive", | |
| "pending" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Account.Capabilities.Transfers": { | |
| "enum": [ | |
| "active", | |
| "inactive", | |
| "pending" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Account.Company": { | |
| "properties": { | |
| "address": { | |
| "$ref": "#/definitions/Stripe.Address" | |
| }, | |
| "address_kana": { | |
| "$ref": "#/definitions/Stripe.Account.Company.AddressKana", | |
| "description": "The Kana variation of the company's primary address (Japan only)." | |
| }, | |
| "address_kanji": { | |
| "$ref": "#/definitions/Stripe.Account.Company.AddressKanji", | |
| "description": "The Kanji variation of the company's primary address (Japan only)." | |
| }, | |
| "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.", | |
| "type": "string" | |
| }, | |
| "name_kana": { | |
| "description": "The Kana variation of the company's legal name (Japan only).", | |
| "type": "string" | |
| }, | |
| "name_kanji": { | |
| "description": "The Kanji variation of the company's legal name (Japan only).", | |
| "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).", | |
| "type": "string" | |
| }, | |
| "structure": { | |
| "$ref": "#/definitions/Stripe.Account.Company.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." | |
| }, | |
| "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).", | |
| "type": "string" | |
| }, | |
| "vat_id_provided": { | |
| "description": "Whether the company's business VAT number was provided.", | |
| "type": "boolean" | |
| }, | |
| "verification": { | |
| "$ref": "#/definitions/Stripe.Account.Company.Verification", | |
| "description": "Information on the verification state of the company." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Account.Company.AddressKana": { | |
| "properties": { | |
| "city": { | |
| "description": "City/Ward.", | |
| "type": "string" | |
| }, | |
| "country": { | |
| "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", | |
| "type": "string" | |
| }, | |
| "line1": { | |
| "description": "Block/Building number.", | |
| "type": "string" | |
| }, | |
| "line2": { | |
| "description": "Building details.", | |
| "type": "string" | |
| }, | |
| "postal_code": { | |
| "description": "ZIP or postal code.", | |
| "type": "string" | |
| }, | |
| "state": { | |
| "description": "Prefecture.", | |
| "type": "string" | |
| }, | |
| "town": { | |
| "description": "Town/cho-me.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Account.Company.AddressKanji": { | |
| "properties": { | |
| "city": { | |
| "description": "City/Ward.", | |
| "type": "string" | |
| }, | |
| "country": { | |
| "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", | |
| "type": "string" | |
| }, | |
| "line1": { | |
| "description": "Block/Building number.", | |
| "type": "string" | |
| }, | |
| "line2": { | |
| "description": "Building details.", | |
| "type": "string" | |
| }, | |
| "postal_code": { | |
| "description": "ZIP or postal code.", | |
| "type": "string" | |
| }, | |
| "state": { | |
| "description": "Prefecture.", | |
| "type": "string" | |
| }, | |
| "town": { | |
| "description": "Town/cho-me.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Account.Company.Structure": { | |
| "enum": [ | |
| "free_zone_establishment", | |
| "free_zone_llc", | |
| "government_instrumentality", | |
| "governmental_unit", | |
| "incorporated_non_profit", | |
| "limited_liability_partnership", | |
| "llc", | |
| "multi_member_llc", | |
| "private_company", | |
| "private_corporation", | |
| "private_partnership", | |
| "public_company", | |
| "public_corporation", | |
| "public_partnership", | |
| "single_member_llc", | |
| "sole_establishment", | |
| "sole_proprietorship", | |
| "tax_exempt_government_instrumentality", | |
| "unincorporated_association", | |
| "unincorporated_non_profit" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Account.Company.Verification": { | |
| "properties": { | |
| "document": { | |
| "$ref": "#/definitions/Stripe.Account.Company.Verification.Document" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Account.Company.Verification.Document": { | |
| "properties": { | |
| "back": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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`." | |
| }, | |
| "details": { | |
| "description": "A user-displayable string describing the verification state of this document.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "front": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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`." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Account.Controller": { | |
| "properties": { | |
| "is_controller": { | |
| "description": "`true` if the Connect application retrieving the resource controls the account and can therefore exercise [platform controls](https://stripe.com/docs/connect/platform-controls-for-standard-accounts). Otherwise, this field is null.", | |
| "type": "boolean" | |
| }, | |
| "type": { | |
| "$ref": "#/definitions/Stripe.Account.Controller.Type", | |
| "description": "The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Account.Controller.Type": { | |
| "enum": [ | |
| "account", | |
| "application" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Account.FutureRequirements": { | |
| "properties": { | |
| "alternatives": { | |
| "description": "Fields that are due and can be satisfied by providing the corresponding alternative fields instead.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.Account.FutureRequirements.Alternative" | |
| }, | |
| "type": "array" | |
| }, | |
| "current_deadline": { | |
| "description": "Date on which `future_requirements` merges with the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on its enablement state prior to transitioning.", | |
| "type": "number" | |
| }, | |
| "currently_due": { | |
| "description": "Fields that need to be collected to keep the account enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash.", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "disabled_reason": { | |
| "description": "This is typed as a string for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is empty because fields in `future_requirements` will never disable the account.", | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "description": "Fields that are `currently_due` and need to be collected again because validation or verification failed.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.Account.FutureRequirements.Error" | |
| }, | |
| "type": "array" | |
| }, | |
| "eventually_due": { | |
| "description": "Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well.", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "past_due": { | |
| "description": "Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "pending_verification": { | |
| "description": "Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`.", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Account.FutureRequirements.Alternative": { | |
| "properties": { | |
| "alternative_fields_due": { | |
| "description": "Fields that can be provided to satisfy all fields in `original_fields_due`.", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "original_fields_due": { | |
| "description": "Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Account.FutureRequirements.Error": { | |
| "properties": { | |
| "code": { | |
| "$ref": "#/definitions/Stripe.Account.FutureRequirements.Error.Code", | |
| "description": "The code for the type of error." | |
| }, | |
| "reason": { | |
| "description": "An informative message that indicates the error type and provides additional details about the error.", | |
| "type": "string" | |
| }, | |
| "requirement": { | |
| "description": "The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Account.FutureRequirements.Error.Code": { | |
| "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_issue_or_expiry_date_missing", | |
| "verification_document_manipulated", | |
| "verification_document_missing_back", | |
| "verification_document_missing_front", | |
| "verification_document_name_mismatch", | |
| "verification_document_name_missing", | |
| "verification_document_nationality_mismatch", | |
| "verification_document_not_readable", | |
| "verification_document_not_signed", | |
| "verification_document_not_uploaded", | |
| "verification_document_photo_mismatch", | |
| "verification_document_too_large", | |
| "verification_document_type_not_supported", | |
| "verification_failed_address_match", | |
| "verification_failed_business_iec_number", | |
| "verification_failed_document_match", | |
| "verification_failed_id_number_match", | |
| "verification_failed_keyed_identity", | |
| "verification_failed_keyed_match", | |
| "verification_failed_name_match", | |
| "verification_failed_other", | |
| "verification_failed_tax_id_match", | |
| "verification_failed_tax_id_not_issued", | |
| "verification_missing_executives", | |
| "verification_missing_owners", | |
| "verification_requires_additional_memorandum_of_associations" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Account.Requirements": { | |
| "properties": { | |
| "alternatives": { | |
| "description": "Fields that are due and can be satisfied by providing the corresponding alternative fields instead.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.Account.Requirements.Alternative" | |
| }, | |
| "type": "array" | |
| }, | |
| "current_deadline": { | |
| "description": "Date by which the fields in `currently_due` must be collected to keep the account enabled. These fields may disable the account sooner if the next threshold is reached before they are collected.", | |
| "type": "number" | |
| }, | |
| "currently_due": { | |
| "description": "Fields that need to be collected to keep the account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "disabled_reason": { | |
| "description": "If the account is disabled, this string describes why. Can be `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.listed`, `rejected.terms_of_service`, `rejected.other`, `under_review`, or `other`.", | |
| "type": "string" | |
| }, | |
| "errors": { | |
| "description": "Fields that are `currently_due` and need to be collected again because validation or verification failed.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.Account.Requirements.Error" | |
| }, | |
| "type": "array" | |
| }, | |
| "eventually_due": { | |
| "description": "Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "past_due": { | |
| "description": "Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the account.", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "pending_verification": { | |
| "description": "Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`.", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Account.Requirements.Alternative": { | |
| "properties": { | |
| "alternative_fields_due": { | |
| "description": "Fields that can be provided to satisfy all fields in `original_fields_due`.", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "original_fields_due": { | |
| "description": "Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Account.Requirements.Error": { | |
| "properties": { | |
| "code": { | |
| "$ref": "#/definitions/Stripe.Account.Requirements.Error.Code", | |
| "description": "The code for the type of error." | |
| }, | |
| "reason": { | |
| "description": "An informative message that indicates the error type and provides additional details about the error.", | |
| "type": "string" | |
| }, | |
| "requirement": { | |
| "description": "The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Account.Requirements.Error.Code": { | |
| "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_issue_or_expiry_date_missing", | |
| "verification_document_manipulated", | |
| "verification_document_missing_back", | |
| "verification_document_missing_front", | |
| "verification_document_name_mismatch", | |
| "verification_document_name_missing", | |
| "verification_document_nationality_mismatch", | |
| "verification_document_not_readable", | |
| "verification_document_not_signed", | |
| "verification_document_not_uploaded", | |
| "verification_document_photo_mismatch", | |
| "verification_document_too_large", | |
| "verification_document_type_not_supported", | |
| "verification_failed_address_match", | |
| "verification_failed_business_iec_number", | |
| "verification_failed_document_match", | |
| "verification_failed_id_number_match", | |
| "verification_failed_keyed_identity", | |
| "verification_failed_keyed_match", | |
| "verification_failed_name_match", | |
| "verification_failed_other", | |
| "verification_failed_tax_id_match", | |
| "verification_failed_tax_id_not_issued", | |
| "verification_missing_executives", | |
| "verification_missing_owners", | |
| "verification_requires_additional_memorandum_of_associations" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Account.Settings": { | |
| "properties": { | |
| "bacs_debit_payments": { | |
| "$ref": "#/definitions/Stripe.Account.Settings.BacsDebitPayments" | |
| }, | |
| "branding": { | |
| "$ref": "#/definitions/Stripe.Account.Settings.Branding" | |
| }, | |
| "card_issuing": { | |
| "$ref": "#/definitions/Stripe.Account.Settings.CardIssuing" | |
| }, | |
| "card_payments": { | |
| "$ref": "#/definitions/Stripe.Account.Settings.CardPayments" | |
| }, | |
| "dashboard": { | |
| "$ref": "#/definitions/Stripe.Account.Settings.Dashboard" | |
| }, | |
| "payments": { | |
| "$ref": "#/definitions/Stripe.Account.Settings.Payments" | |
| }, | |
| "payouts": { | |
| "$ref": "#/definitions/Stripe.Account.Settings.Payouts" | |
| }, | |
| "sepa_debit_payments": { | |
| "$ref": "#/definitions/Stripe.Account.Settings.SepaDebitPayments" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Account.Settings.BacsDebitPayments": { | |
| "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.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Account.Settings.Branding": { | |
| "properties": { | |
| "icon": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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." | |
| }, | |
| "logo": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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." | |
| }, | |
| "primary_color": { | |
| "description": "A CSS hex color value representing the primary branding color for this account", | |
| "type": "string" | |
| }, | |
| "secondary_color": { | |
| "description": "A CSS hex color value representing the secondary branding color for this account", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Account.Settings.CardIssuing": { | |
| "properties": { | |
| "tos_acceptance": { | |
| "$ref": "#/definitions/Stripe.Account.Settings.CardIssuing.TosAcceptance" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Account.Settings.CardIssuing.TosAcceptance": { | |
| "properties": { | |
| "date": { | |
| "description": "The Unix timestamp marking when the account representative accepted the service agreement.", | |
| "type": "number" | |
| }, | |
| "ip": { | |
| "description": "The IP address from which the account representative accepted the service agreement.", | |
| "type": "string" | |
| }, | |
| "user_agent": { | |
| "description": "The user agent of the browser from which the account representative accepted the service agreement.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Account.Settings.CardPayments": { | |
| "properties": { | |
| "decline_on": { | |
| "$ref": "#/definitions/Stripe.Account.Settings.CardPayments.DeclineOn" | |
| }, | |
| "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.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Account.Settings.CardPayments.DeclineOn": { | |
| "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" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Account.Settings.Dashboard": { | |
| "properties": { | |
| "display_name": { | |
| "description": "The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts.", | |
| "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).", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Account.Settings.Payments": { | |
| "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.", | |
| "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)", | |
| "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)", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Account.Settings.Payouts": { | |
| "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": "#/definitions/Stripe.Account.Settings.Payouts.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.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Account.Settings.Payouts.Schedule": { | |
| "properties": { | |
| "delay_days": { | |
| "description": "The number of days charges for the account will be held before being paid out.", | |
| "type": "number" | |
| }, | |
| "interval": { | |
| "description": "How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`.", | |
| "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": "number" | |
| }, | |
| "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.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Account.Settings.SepaDebitPayments": { | |
| "properties": { | |
| "creditor_id": { | |
| "description": "SEPA creditor identifier that identifies the company making the payment.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Account.TosAcceptance": { | |
| "properties": { | |
| "date": { | |
| "description": "The Unix timestamp marking when the account representative accepted their service agreement", | |
| "type": "number" | |
| }, | |
| "ip": { | |
| "description": "The IP address from which the account representative accepted their service agreement", | |
| "type": "string" | |
| }, | |
| "service_agreement": { | |
| "description": "The user's service agreement type", | |
| "type": "string" | |
| }, | |
| "user_agent": { | |
| "description": "The user agent of the browser from which the account representative accepted their service agreement", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Account.Type": { | |
| "enum": [ | |
| "custom", | |
| "express", | |
| "standard" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.AccountLinksResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.AccountsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Address": { | |
| "description": "The Address object.", | |
| "properties": { | |
| "city": { | |
| "description": "City/District/Suburb/Town/Village.", | |
| "type": "string" | |
| }, | |
| "country": { | |
| "description": "2-letter country code.", | |
| "type": "string" | |
| }, | |
| "line1": { | |
| "description": "Address line 1 (Street address/PO Box/Company name).", | |
| "type": "string" | |
| }, | |
| "line2": { | |
| "description": "Address line 2 (Apartment/Suite/Unit/Building).", | |
| "type": "string" | |
| }, | |
| "postal_code": { | |
| "description": "ZIP or postal code.", | |
| "type": "string" | |
| }, | |
| "state": { | |
| "description": "State/County/Province/Region.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.AlipayAccount": { | |
| "description": "The AlipayAccount object.", | |
| "properties": { | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "customer": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Customer" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedCustomer" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The ID of the customer associated with this Alipay Account." | |
| }, | |
| "deleted": { | |
| "type": "string" | |
| }, | |
| "fingerprint": { | |
| "description": "Uniquely identifies the account and will be the same across all Alipay account objects that are linked to the same Alipay account.", | |
| "type": "string" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "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": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "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.", | |
| "type": "number" | |
| }, | |
| "payment_currency": { | |
| "description": "If the Alipay account object is not reusable, the exact currency that you can create a charge for.", | |
| "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.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.ApiList<Stripe.BankAccount|Stripe.Card>": { | |
| "description": "A container for paginated lists of objects.\nThe array of objects is on the `.data` property,\nand `.has_more` indicates whether there are additional objects beyond the end of this list.\n\nLearn more in Stripe's [pagination docs](https://stripe.com/docs/api/pagination?lang=node)\nor, when iterating over many items, try [auto-pagination](https://github.com/stripe/stripe-node#auto-pagination) instead.", | |
| "properties": { | |
| "data": { | |
| "items": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.BankAccount" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.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": { | |
| "enum": [ | |
| "list" | |
| ], | |
| "type": "string" | |
| }, | |
| "url": { | |
| "description": "The URL where this list can be accessed.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.ApiList<Stripe.BitcoinTransaction>": { | |
| "description": "A container for paginated lists of objects.\nThe array of objects is on the `.data` property,\nand `.has_more` indicates whether there are additional objects beyond the end of this list.\n\nLearn more in Stripe's [pagination docs](https://stripe.com/docs/api/pagination?lang=node)\nor, when iterating over many items, try [auto-pagination](https://github.com/stripe/stripe-node#auto-pagination) instead.", | |
| "properties": { | |
| "data": { | |
| "items": { | |
| "$ref": "#/definitions/Stripe.BitcoinTransaction" | |
| }, | |
| "type": "array" | |
| }, | |
| "has_more": { | |
| "description": "True if this list has another page of items after this one that can be fetched.", | |
| "type": "boolean" | |
| }, | |
| "object": { | |
| "enum": [ | |
| "list" | |
| ], | |
| "type": "string" | |
| }, | |
| "url": { | |
| "description": "The URL where this list can be accessed.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.ApiList<Stripe.Card>": { | |
| "description": "A container for paginated lists of objects.\nThe array of objects is on the `.data` property,\nand `.has_more` indicates whether there are additional objects beyond the end of this list.\n\nLearn more in Stripe's [pagination docs](https://stripe.com/docs/api/pagination?lang=node)\nor, when iterating over many items, try [auto-pagination](https://github.com/stripe/stripe-node#auto-pagination) instead.", | |
| "properties": { | |
| "data": { | |
| "items": { | |
| "$ref": "#/definitions/Stripe.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": { | |
| "enum": [ | |
| "list" | |
| ], | |
| "type": "string" | |
| }, | |
| "url": { | |
| "description": "The URL where this list can be accessed.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.ApiList<Stripe.Charge>": { | |
| "description": "A container for paginated lists of objects.\nThe array of objects is on the `.data` property,\nand `.has_more` indicates whether there are additional objects beyond the end of this list.\n\nLearn more in Stripe's [pagination docs](https://stripe.com/docs/api/pagination?lang=node)\nor, when iterating over many items, try [auto-pagination](https://github.com/stripe/stripe-node#auto-pagination) instead.", | |
| "properties": { | |
| "data": { | |
| "items": { | |
| "$ref": "#/definitions/Stripe.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": { | |
| "enum": [ | |
| "list" | |
| ], | |
| "type": "string" | |
| }, | |
| "url": { | |
| "description": "The URL where this list can be accessed.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.ApiList<Stripe.CustomerSource>": { | |
| "description": "A container for paginated lists of objects.\nThe array of objects is on the `.data` property,\nand `.has_more` indicates whether there are additional objects beyond the end of this list.\n\nLearn more in Stripe's [pagination docs](https://stripe.com/docs/api/pagination?lang=node)\nor, when iterating over many items, try [auto-pagination](https://github.com/stripe/stripe-node#auto-pagination) instead.", | |
| "properties": { | |
| "data": { | |
| "items": { | |
| "anyOf": [ | |
| { | |
| "description": "The resulting source of [a Connect platform debiting a connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account).", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "object": { | |
| "enum": [ | |
| "account" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.AlipayAccount" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.BankAccount" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.BitcoinReceiver" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Card" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Source" | |
| } | |
| ] | |
| }, | |
| "type": "array" | |
| }, | |
| "has_more": { | |
| "description": "True if this list has another page of items after this one that can be fetched.", | |
| "type": "boolean" | |
| }, | |
| "object": { | |
| "enum": [ | |
| "list" | |
| ], | |
| "type": "string" | |
| }, | |
| "url": { | |
| "description": "The URL where this list can be accessed.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.ApiList<Stripe.FeeRefund>": { | |
| "description": "A container for paginated lists of objects.\nThe array of objects is on the `.data` property,\nand `.has_more` indicates whether there are additional objects beyond the end of this list.\n\nLearn more in Stripe's [pagination docs](https://stripe.com/docs/api/pagination?lang=node)\nor, when iterating over many items, try [auto-pagination](https://github.com/stripe/stripe-node#auto-pagination) instead.", | |
| "properties": { | |
| "data": { | |
| "items": { | |
| "$ref": "#/definitions/Stripe.FeeRefund" | |
| }, | |
| "type": "array" | |
| }, | |
| "has_more": { | |
| "description": "True if this list has another page of items after this one that can be fetched.", | |
| "type": "boolean" | |
| }, | |
| "object": { | |
| "enum": [ | |
| "list" | |
| ], | |
| "type": "string" | |
| }, | |
| "url": { | |
| "description": "The URL where this list can be accessed.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.ApiList<Stripe.FileLink>": { | |
| "description": "A container for paginated lists of objects.\nThe array of objects is on the `.data` property,\nand `.has_more` indicates whether there are additional objects beyond the end of this list.\n\nLearn more in Stripe's [pagination docs](https://stripe.com/docs/api/pagination?lang=node)\nor, when iterating over many items, try [auto-pagination](https://github.com/stripe/stripe-node#auto-pagination) instead.", | |
| "properties": { | |
| "data": { | |
| "items": { | |
| "$ref": "#/definitions/Stripe.FileLink" | |
| }, | |
| "type": "array" | |
| }, | |
| "has_more": { | |
| "description": "True if this list has another page of items after this one that can be fetched.", | |
| "type": "boolean" | |
| }, | |
| "object": { | |
| "enum": [ | |
| "list" | |
| ], | |
| "type": "string" | |
| }, | |
| "url": { | |
| "description": "The URL where this list can be accessed.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.ApiList<Stripe.InvoiceLineItem>": { | |
| "description": "A container for paginated lists of objects.\nThe array of objects is on the `.data` property,\nand `.has_more` indicates whether there are additional objects beyond the end of this list.\n\nLearn more in Stripe's [pagination docs](https://stripe.com/docs/api/pagination?lang=node)\nor, when iterating over many items, try [auto-pagination](https://github.com/stripe/stripe-node#auto-pagination) instead.", | |
| "properties": { | |
| "data": { | |
| "items": { | |
| "$ref": "#/definitions/Stripe.InvoiceLineItem" | |
| }, | |
| "type": "array" | |
| }, | |
| "has_more": { | |
| "description": "True if this list has another page of items after this one that can be fetched.", | |
| "type": "boolean" | |
| }, | |
| "object": { | |
| "enum": [ | |
| "list" | |
| ], | |
| "type": "string" | |
| }, | |
| "url": { | |
| "description": "The URL where this list can be accessed.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.ApiList<Stripe.LineItem>": { | |
| "description": "A container for paginated lists of objects.\nThe array of objects is on the `.data` property,\nand `.has_more` indicates whether there are additional objects beyond the end of this list.\n\nLearn more in Stripe's [pagination docs](https://stripe.com/docs/api/pagination?lang=node)\nor, when iterating over many items, try [auto-pagination](https://github.com/stripe/stripe-node#auto-pagination) instead.", | |
| "properties": { | |
| "data": { | |
| "items": { | |
| "$ref": "#/definitions/Stripe.LineItem" | |
| }, | |
| "type": "array" | |
| }, | |
| "has_more": { | |
| "description": "True if this list has another page of items after this one that can be fetched.", | |
| "type": "boolean" | |
| }, | |
| "object": { | |
| "enum": [ | |
| "list" | |
| ], | |
| "type": "string" | |
| }, | |
| "url": { | |
| "description": "The URL where this list can be accessed.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.ApiList<Stripe.OrderReturn>": { | |
| "description": "A container for paginated lists of objects.\nThe array of objects is on the `.data` property,\nand `.has_more` indicates whether there are additional objects beyond the end of this list.\n\nLearn more in Stripe's [pagination docs](https://stripe.com/docs/api/pagination?lang=node)\nor, when iterating over many items, try [auto-pagination](https://github.com/stripe/stripe-node#auto-pagination) instead.", | |
| "properties": { | |
| "data": { | |
| "items": { | |
| "$ref": "#/definitions/Stripe.OrderReturn" | |
| }, | |
| "type": "array" | |
| }, | |
| "has_more": { | |
| "description": "True if this list has another page of items after this one that can be fetched.", | |
| "type": "boolean" | |
| }, | |
| "object": { | |
| "enum": [ | |
| "list" | |
| ], | |
| "type": "string" | |
| }, | |
| "url": { | |
| "description": "The URL where this list can be accessed.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.ApiList<Stripe.Refund>": { | |
| "description": "A container for paginated lists of objects.\nThe array of objects is on the `.data` property,\nand `.has_more` indicates whether there are additional objects beyond the end of this list.\n\nLearn more in Stripe's [pagination docs](https://stripe.com/docs/api/pagination?lang=node)\nor, when iterating over many items, try [auto-pagination](https://github.com/stripe/stripe-node#auto-pagination) instead.", | |
| "properties": { | |
| "data": { | |
| "items": { | |
| "$ref": "#/definitions/Stripe.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": { | |
| "enum": [ | |
| "list" | |
| ], | |
| "type": "string" | |
| }, | |
| "url": { | |
| "description": "The URL where this list can be accessed.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.ApiList<Stripe.Subscription>": { | |
| "description": "A container for paginated lists of objects.\nThe array of objects is on the `.data` property,\nand `.has_more` indicates whether there are additional objects beyond the end of this list.\n\nLearn more in Stripe's [pagination docs](https://stripe.com/docs/api/pagination?lang=node)\nor, when iterating over many items, try [auto-pagination](https://github.com/stripe/stripe-node#auto-pagination) instead.", | |
| "properties": { | |
| "data": { | |
| "items": { | |
| "$ref": "#/definitions/Stripe.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": { | |
| "enum": [ | |
| "list" | |
| ], | |
| "type": "string" | |
| }, | |
| "url": { | |
| "description": "The URL where this list can be accessed.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.ApiList<Stripe.SubscriptionItem>": { | |
| "description": "A container for paginated lists of objects.\nThe array of objects is on the `.data` property,\nand `.has_more` indicates whether there are additional objects beyond the end of this list.\n\nLearn more in Stripe's [pagination docs](https://stripe.com/docs/api/pagination?lang=node)\nor, when iterating over many items, try [auto-pagination](https://github.com/stripe/stripe-node#auto-pagination) instead.", | |
| "properties": { | |
| "data": { | |
| "items": { | |
| "$ref": "#/definitions/Stripe.SubscriptionItem" | |
| }, | |
| "type": "array" | |
| }, | |
| "has_more": { | |
| "description": "True if this list has another page of items after this one that can be fetched.", | |
| "type": "boolean" | |
| }, | |
| "object": { | |
| "enum": [ | |
| "list" | |
| ], | |
| "type": "string" | |
| }, | |
| "url": { | |
| "description": "The URL where this list can be accessed.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.ApiList<Stripe.TaxId>": { | |
| "description": "A container for paginated lists of objects.\nThe array of objects is on the `.data` property,\nand `.has_more` indicates whether there are additional objects beyond the end of this list.\n\nLearn more in Stripe's [pagination docs](https://stripe.com/docs/api/pagination?lang=node)\nor, when iterating over many items, try [auto-pagination](https://github.com/stripe/stripe-node#auto-pagination) instead.", | |
| "properties": { | |
| "data": { | |
| "items": { | |
| "$ref": "#/definitions/Stripe.TaxId" | |
| }, | |
| "type": "array" | |
| }, | |
| "has_more": { | |
| "description": "True if this list has another page of items after this one that can be fetched.", | |
| "type": "boolean" | |
| }, | |
| "object": { | |
| "enum": [ | |
| "list" | |
| ], | |
| "type": "string" | |
| }, | |
| "url": { | |
| "description": "The URL where this list can be accessed.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.ApiList<Stripe.TransferReversal>": { | |
| "description": "A container for paginated lists of objects.\nThe array of objects is on the `.data` property,\nand `.has_more` indicates whether there are additional objects beyond the end of this list.\n\nLearn more in Stripe's [pagination docs](https://stripe.com/docs/api/pagination?lang=node)\nor, when iterating over many items, try [auto-pagination](https://github.com/stripe/stripe-node#auto-pagination) instead.", | |
| "properties": { | |
| "data": { | |
| "items": { | |
| "$ref": "#/definitions/Stripe.TransferReversal" | |
| }, | |
| "type": "array" | |
| }, | |
| "has_more": { | |
| "description": "True if this list has another page of items after this one that can be fetched.", | |
| "type": "boolean" | |
| }, | |
| "object": { | |
| "enum": [ | |
| "list" | |
| ], | |
| "type": "string" | |
| }, | |
| "url": { | |
| "description": "The URL where this list can be accessed.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.ApplePayDomainsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Application": { | |
| "description": "The Application object.", | |
| "properties": { | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "description": "The name of the application.", | |
| "type": "string" | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "application" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.ApplicationFee": { | |
| "description": "The ApplicationFee object.", | |
| "properties": { | |
| "account": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Account" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the Stripe account this fee was taken from." | |
| }, | |
| "amount": { | |
| "description": "Amount earned, in %s.", | |
| "type": "number" | |
| }, | |
| "amount_refunded": { | |
| "description": "Amount in %s refunded (can be less than the amount attribute on the fee if a partial refund was issued)", | |
| "type": "number" | |
| }, | |
| "application": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Application" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the Connect application that earned the fee." | |
| }, | |
| "balance_transaction": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.BalanceTransaction" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds)." | |
| }, | |
| "charge": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Charge" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the charge that the application fee was taken from." | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "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.", | |
| "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": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Charge" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter." | |
| }, | |
| "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": { | |
| "$ref": "#/definitions/Stripe.ApiList<Stripe.FeeRefund>", | |
| "description": "A list of refunds that have been applied to the fee." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.ApplicationFeesResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.BalanceResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.BalanceTransaction": { | |
| "description": "The BalanceTransaction object.", | |
| "properties": { | |
| "amount": { | |
| "description": "Gross amount of the transaction, in %s.", | |
| "type": "number" | |
| }, | |
| "available_on": { | |
| "description": "The date the transaction's net funds will become available in the Stripe balance.", | |
| "type": "number" | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "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.", | |
| "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`.", | |
| "type": "number" | |
| }, | |
| "fee": { | |
| "description": "Fees (in %s) paid for this transaction.", | |
| "type": "number" | |
| }, | |
| "fee_details": { | |
| "description": "Detailed breakdown of fees (in %s) paid for this transaction.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.BalanceTransaction.FeeDetail" | |
| }, | |
| "type": "array" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "net": { | |
| "description": "Net amount of the transaction, in %s.", | |
| "type": "number" | |
| }, | |
| "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.", | |
| "type": "string" | |
| }, | |
| "source": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.ApplicationFee" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Charge" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.ConnectCollectionTransfer" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Dispute" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.FeeRefund" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Issuing.Authorization" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Issuing.Dispute" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Issuing.Transaction" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Payout" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.PlatformTaxFee" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Refund" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.ReserveTransaction" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.TaxDeductedAtSource" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Topup" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.TransferReversal" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Transfer" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The Stripe object to which this transaction is related." | |
| }, | |
| "status": { | |
| "description": "If the transaction's net funds are available in the Stripe balance yet. Either `available` or `pending`.", | |
| "type": "string" | |
| }, | |
| "type": { | |
| "$ref": "#/definitions/Stripe.BalanceTransaction.Type", | |
| "description": "Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `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." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.BalanceTransaction.FeeDetail": { | |
| "properties": { | |
| "amount": { | |
| "description": "Amount of the fee, in cents.", | |
| "type": "number" | |
| }, | |
| "application": { | |
| "description": "ID of the Connect application that earned the fee.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "type": { | |
| "description": "Type of the fee, one of: `application_fee`, `stripe_fee` or `tax`.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.BalanceTransaction.Type": { | |
| "enum": [ | |
| "adjustment", | |
| "advance", | |
| "advance_funding", | |
| "anticipation_repayment", | |
| "application_fee", | |
| "application_fee_refund", | |
| "charge", | |
| "connect_collection_transfer", | |
| "contribution", | |
| "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" | |
| }, | |
| "Stripe.BalanceTransactionsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.BankAccount": { | |
| "description": "The BankAccount object.", | |
| "properties": { | |
| "account": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Account" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The ID of the account that the bank account is associated with." | |
| }, | |
| "account_holder_name": { | |
| "description": "The name of the person or business that owns the bank account.", | |
| "type": "string" | |
| }, | |
| "account_holder_type": { | |
| "description": "The type of entity that holds the account. This can be either `individual` or `company`.", | |
| "type": "string" | |
| }, | |
| "account_type": { | |
| "description": "The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.", | |
| "type": "string" | |
| }, | |
| "available_payout_methods": { | |
| "description": "A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout.", | |
| "items": { | |
| "enum": [ | |
| "instant", | |
| "standard" | |
| ], | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "bank_name": { | |
| "description": "Name of the bank associated with the routing number (e.g., `WELLS FARGO`).", | |
| "type": "string" | |
| }, | |
| "country": { | |
| "description": "Two-letter ISO code representing the country the bank account is located in.", | |
| "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": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Customer" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedCustomer" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The ID of the customer that the bank account is associated with." | |
| }, | |
| "default_for_currency": { | |
| "description": "Whether this bank account is the default external account for its currency.", | |
| "type": "boolean" | |
| }, | |
| "deleted": { | |
| "type": "string" | |
| }, | |
| "fingerprint": { | |
| "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", | |
| "type": "string" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "last4": { | |
| "description": "The last four digits of the bank account number.", | |
| "type": "string" | |
| }, | |
| "metadata": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "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.", | |
| "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.\n\nFor 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.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.BillingPortal.ConfigurationsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.BillingPortal.SessionsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.BitcoinReceiver": { | |
| "description": "The BitcoinReceiver object.", | |
| "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": "number" | |
| }, | |
| "amount_received": { | |
| "description": "The amount of `currency` to which `bitcoin_amount_received` has been converted.", | |
| "type": "number" | |
| }, | |
| "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": "number" | |
| }, | |
| "bitcoin_amount_received": { | |
| "description": "The amount of bitcoin that has been sent by the customer to this receiver.", | |
| "type": "number" | |
| }, | |
| "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).", | |
| "type": "string" | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "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.", | |
| "type": "string" | |
| }, | |
| "deleted": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "description": "An arbitrary string attached to the object. Often useful for displaying to users.", | |
| "type": "string" | |
| }, | |
| "email": { | |
| "description": "The customer's email address, set by the API call that creates the receiver.", | |
| "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.", | |
| "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.", | |
| "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": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "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.", | |
| "type": "string" | |
| }, | |
| "refund_address": { | |
| "description": "The refund address of this bitcoin receiver.", | |
| "type": "string" | |
| }, | |
| "transactions": { | |
| "$ref": "#/definitions/Stripe.ApiList<Stripe.BitcoinTransaction>", | |
| "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." | |
| }, | |
| "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.", | |
| "type": "boolean" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.BitcoinTransaction": { | |
| "description": "The BitcoinTransaction object.", | |
| "properties": { | |
| "amount": { | |
| "description": "The amount of `currency` that the transaction was converted to in real-time.", | |
| "type": "number" | |
| }, | |
| "bitcoin_amount": { | |
| "description": "The amount of bitcoin contained in the transaction.", | |
| "type": "number" | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "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.", | |
| "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.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Card": { | |
| "description": "The Card object.", | |
| "properties": { | |
| "account": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Account" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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." | |
| }, | |
| "address_city": { | |
| "description": "City/District/Suburb/Town/Village.", | |
| "type": "string" | |
| }, | |
| "address_country": { | |
| "description": "Billing address country, if provided when creating card.", | |
| "type": "string" | |
| }, | |
| "address_line1": { | |
| "description": "Address line 1 (Street address/PO Box/Company name).", | |
| "type": "string" | |
| }, | |
| "address_line1_check": { | |
| "description": "If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.", | |
| "type": "string" | |
| }, | |
| "address_line2": { | |
| "description": "Address line 2 (Apartment/Suite/Unit/Building).", | |
| "type": "string" | |
| }, | |
| "address_state": { | |
| "description": "State/County/Province/Region.", | |
| "type": "string" | |
| }, | |
| "address_zip": { | |
| "description": "ZIP or postal code.", | |
| "type": "string" | |
| }, | |
| "address_zip_check": { | |
| "description": "If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.", | |
| "type": "string" | |
| }, | |
| "available_payout_methods": { | |
| "description": "A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout.", | |
| "items": { | |
| "enum": [ | |
| "instant", | |
| "standard" | |
| ], | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "brand": { | |
| "description": "Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "currency": { | |
| "description": "Three-letter [ISO code for currency](https://stripe.com/docs/payouts). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency.", | |
| "type": "string" | |
| }, | |
| "customer": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Customer" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedCustomer" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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." | |
| }, | |
| "cvc_check": { | |
| "description": "If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge).", | |
| "type": "string" | |
| }, | |
| "default_for_currency": { | |
| "description": "Whether this card is the default external account for its currency.", | |
| "type": "boolean" | |
| }, | |
| "deleted": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "description": "A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)", | |
| "type": "string" | |
| }, | |
| "dynamic_last4": { | |
| "description": "(For tokenized numbers only.) The last four digits of the device account number.", | |
| "type": "string" | |
| }, | |
| "exp_month": { | |
| "description": "Two-digit number representing the card's expiration month.", | |
| "type": "number" | |
| }, | |
| "exp_year": { | |
| "description": "Four-digit number representing the card's expiration year.", | |
| "type": "number" | |
| }, | |
| "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.\n\n*Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*", | |
| "type": "string" | |
| }, | |
| "funding": { | |
| "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", | |
| "type": "string" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "iin": { | |
| "description": "Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)", | |
| "type": "string" | |
| }, | |
| "issuer": { | |
| "description": "The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)", | |
| "type": "string" | |
| }, | |
| "last4": { | |
| "description": "The last four digits of the card.", | |
| "type": "string" | |
| }, | |
| "metadata": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "name": { | |
| "description": "Cardholder name.", | |
| "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": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Recipient" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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." | |
| }, | |
| "tokenization_method": { | |
| "description": "If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge": { | |
| "description": "The Charge object.", | |
| "properties": { | |
| "alternate_statement_descriptors": { | |
| "$ref": "#/definitions/Stripe.Charge.AlternateStatementDescriptors" | |
| }, | |
| "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": "number" | |
| }, | |
| "amount_captured": { | |
| "description": "Amount in %s captured (can be less than the amount attribute on the charge if a partial capture was made).", | |
| "type": "number" | |
| }, | |
| "amount_refunded": { | |
| "description": "Amount in %s refunded (can be less than the amount attribute on the charge if a partial refund was issued).", | |
| "type": "number" | |
| }, | |
| "application": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Application" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the Connect application that created the charge." | |
| }, | |
| "application_fee": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.ApplicationFee" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details." | |
| }, | |
| "application_fee_amount": { | |
| "description": "The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details.", | |
| "type": "number" | |
| }, | |
| "authorization_code": { | |
| "description": "Authorization code on the charge.", | |
| "type": "string" | |
| }, | |
| "balance_transaction": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.BalanceTransaction" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes)." | |
| }, | |
| "billing_details": { | |
| "$ref": "#/definitions/Stripe.Charge.BillingDetails" | |
| }, | |
| "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.", | |
| "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.", | |
| "type": "number" | |
| }, | |
| "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": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Customer" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedCustomer" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the customer this charge is for if one exists." | |
| }, | |
| "description": { | |
| "description": "An arbitrary string attached to the object. Often useful for displaying to users.", | |
| "type": "string" | |
| }, | |
| "destination": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Account" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request." | |
| }, | |
| "dispute": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Dispute" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "Details about the dispute if the charge has been disputed." | |
| }, | |
| "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).", | |
| "type": "string" | |
| }, | |
| "failure_message": { | |
| "description": "Message to user further explaining reason for charge failure if available.", | |
| "type": "string" | |
| }, | |
| "fraud_details": { | |
| "$ref": "#/definitions/Stripe.Charge.FraudDetails", | |
| "description": "Information on fraud assessments for the charge." | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "invoice": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Invoice" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the invoice this charge is for if one exists." | |
| }, | |
| "level3": { | |
| "$ref": "#/definitions/Stripe.Charge.Level3" | |
| }, | |
| "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": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "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": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Account" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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." | |
| }, | |
| "order": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Order" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the order this charge is for if one exists." | |
| }, | |
| "outcome": { | |
| "$ref": "#/definitions/Stripe.Charge.Outcome", | |
| "description": "Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details." | |
| }, | |
| "paid": { | |
| "description": "`true` if the charge succeeded, or was successfully authorized for later capture.", | |
| "type": "boolean" | |
| }, | |
| "payment_intent": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.PaymentIntent" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the PaymentIntent associated with this charge, if one exists." | |
| }, | |
| "payment_method": { | |
| "description": "ID of the payment method used in this charge.", | |
| "type": "string" | |
| }, | |
| "payment_method_details": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails", | |
| "description": "Details about the payment method at the time of the transaction." | |
| }, | |
| "receipt_email": { | |
| "description": "This is the email address that the receipt for this charge was sent to.", | |
| "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.", | |
| "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.", | |
| "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": { | |
| "$ref": "#/definitions/Stripe.ApiList<Stripe.Refund>", | |
| "description": "A list of refunds that have been applied to the charge." | |
| }, | |
| "review": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Review" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the review associated with this charge if one exists." | |
| }, | |
| "shipping": { | |
| "$ref": "#/definitions/Stripe.Charge.Shipping", | |
| "description": "Shipping information for the charge." | |
| }, | |
| "source": { | |
| "anyOf": [ | |
| { | |
| "description": "The resulting source of [a Connect platform debiting a connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account).", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "object": { | |
| "enum": [ | |
| "account" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.AlipayAccount" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.BankAccount" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.BitcoinReceiver" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Card" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Source" | |
| } | |
| ], | |
| "description": "This is a legacy field that will be removed in the future. It contains the Source, Card, or BankAccount object used for the charge. For details about the payment method used for this charge, refer to `payment_method` or `payment_method_details` instead." | |
| }, | |
| "source_transfer": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Transfer" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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." | |
| }, | |
| "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.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "status": { | |
| "description": "The status of the payment is either `succeeded`, `pending`, or `failed`.", | |
| "type": "string" | |
| }, | |
| "transfer": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Transfer" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter)." | |
| }, | |
| "transfer_data": { | |
| "$ref": "#/definitions/Stripe.Charge.TransferData", | |
| "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." | |
| }, | |
| "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.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.AlternateStatementDescriptors": { | |
| "properties": { | |
| "kana": { | |
| "description": "The Kana variation of the descriptor.", | |
| "type": "string" | |
| }, | |
| "kanji": { | |
| "description": "The Kanji variation of the descriptor.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.BillingDetails": { | |
| "properties": { | |
| "address": { | |
| "$ref": "#/definitions/Stripe.Address", | |
| "description": "Billing address." | |
| }, | |
| "email": { | |
| "description": "Email address.", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "description": "Full name.", | |
| "type": "string" | |
| }, | |
| "phone": { | |
| "description": "Billing phone number (including extension).", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.FraudDetails": { | |
| "properties": { | |
| "stripe_report": { | |
| "description": "Assessments from Stripe. If set, the value is `fraudulent`.", | |
| "type": "string" | |
| }, | |
| "user_report": { | |
| "description": "Assessments reported by you. If set, possible values of are `safe` and `fraudulent`.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.Level3": { | |
| "properties": { | |
| "customer_reference": { | |
| "type": "string" | |
| }, | |
| "line_items": { | |
| "items": { | |
| "$ref": "#/definitions/Stripe.Charge.Level3.LineItem" | |
| }, | |
| "type": "array" | |
| }, | |
| "merchant_reference": { | |
| "type": "string" | |
| }, | |
| "shipping_address_zip": { | |
| "type": "string" | |
| }, | |
| "shipping_amount": { | |
| "type": "number" | |
| }, | |
| "shipping_from_zip": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.Level3.LineItem": { | |
| "properties": { | |
| "discount_amount": { | |
| "type": "number" | |
| }, | |
| "product_code": { | |
| "type": "string" | |
| }, | |
| "product_description": { | |
| "type": "string" | |
| }, | |
| "quantity": { | |
| "type": "number" | |
| }, | |
| "tax_amount": { | |
| "type": "number" | |
| }, | |
| "unit_cost": { | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.Outcome": { | |
| "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.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "risk_level": { | |
| "description": "Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are `normal`, `elevated`, `highest`. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value `not_assessed`. In the event of an error in the evaluation, this field will have the value `unknown`. This field is only available with Radar.", | |
| "type": "string" | |
| }, | |
| "risk_score": { | |
| "description": "Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are between 0 and 100. For non-card payments, card-based payments predating the public assignment of risk scores, or in the event of an error during evaluation, this field will not be present. This field is only available with Radar for Fraud Teams.", | |
| "type": "number" | |
| }, | |
| "rule": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Charge.Outcome.Rule" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The ID of the Radar rule that matched the payment, if applicable." | |
| }, | |
| "seller_message": { | |
| "description": "A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer.", | |
| "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.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.Outcome.Rule": { | |
| "properties": { | |
| "action": { | |
| "description": "The action taken on the payment.", | |
| "type": "string" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "predicate": { | |
| "description": "The predicate to evaluate the payment against.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails": { | |
| "properties": { | |
| "ach_credit_transfer": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.AchCreditTransfer" | |
| }, | |
| "ach_debit": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.AchDebit" | |
| }, | |
| "acss_debit": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.AcssDebit" | |
| }, | |
| "afterpay_clearpay": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.AfterpayClearpay" | |
| }, | |
| "alipay": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.Alipay" | |
| }, | |
| "au_becs_debit": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.AuBecsDebit" | |
| }, | |
| "bacs_debit": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.BacsDebit" | |
| }, | |
| "bancontact": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.Bancontact" | |
| }, | |
| "boleto": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.Boleto" | |
| }, | |
| "card": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.Card" | |
| }, | |
| "card_present": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.CardPresent" | |
| }, | |
| "eps": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.Eps" | |
| }, | |
| "fpx": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.Fpx" | |
| }, | |
| "giropay": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.Giropay" | |
| }, | |
| "grabpay": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.Grabpay" | |
| }, | |
| "ideal": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.Ideal" | |
| }, | |
| "interac_present": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.InteracPresent" | |
| }, | |
| "klarna": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.Klarna" | |
| }, | |
| "multibanco": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.Multibanco" | |
| }, | |
| "oxxo": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.Oxxo" | |
| }, | |
| "p24": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.P24" | |
| }, | |
| "sepa_credit_transfer": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.SepaCreditTransfer" | |
| }, | |
| "sepa_debit": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.SepaDebit" | |
| }, | |
| "sofort": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.Sofort" | |
| }, | |
| "stripe_account": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.StripeAccount" | |
| }, | |
| "type": { | |
| "description": "The type of transaction-specific details of the payment method used in the payment, one of `ach_credit_transfer`, `ach_debit`, `acss_debit`, `alipay`, `au_becs_debit`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `klarna`, `multibanco`, `p24`, `sepa_debit`, `sofort`, `stripe_account`, or `wechat`.\nAn additional hash is included on `payment_method_details` with a name matching this value.\nIt contains information specific to the payment method.", | |
| "type": "string" | |
| }, | |
| "wechat": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.Wechat" | |
| }, | |
| "wechat_pay": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.WechatPay" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.AchCreditTransfer": { | |
| "properties": { | |
| "account_number": { | |
| "description": "Account number to transfer funds to.", | |
| "type": "string" | |
| }, | |
| "bank_name": { | |
| "description": "Name of the bank associated with the routing number.", | |
| "type": "string" | |
| }, | |
| "routing_number": { | |
| "description": "Routing transit number for the bank account to transfer funds to.", | |
| "type": "string" | |
| }, | |
| "swift_code": { | |
| "description": "SWIFT code of the bank associated with the routing number.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.AchDebit": { | |
| "properties": { | |
| "account_holder_type": { | |
| "description": "Type of entity that holds the account. This can be either `individual` or `company`.", | |
| "enum": [ | |
| "company", | |
| "individual" | |
| ], | |
| "type": "string" | |
| }, | |
| "bank_name": { | |
| "description": "Name of the bank associated with the bank account.", | |
| "type": "string" | |
| }, | |
| "country": { | |
| "description": "Two-letter ISO code representing the country the bank account is located in.", | |
| "type": "string" | |
| }, | |
| "fingerprint": { | |
| "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", | |
| "type": "string" | |
| }, | |
| "last4": { | |
| "description": "Last four digits of the bank account number.", | |
| "type": "string" | |
| }, | |
| "routing_number": { | |
| "description": "Routing transit number of the bank account.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.AcssDebit": { | |
| "properties": { | |
| "bank_name": { | |
| "description": "Name of the bank associated with the bank account.", | |
| "type": "string" | |
| }, | |
| "fingerprint": { | |
| "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", | |
| "type": "string" | |
| }, | |
| "institution_number": { | |
| "description": "Institution number of the bank account", | |
| "type": "string" | |
| }, | |
| "last4": { | |
| "description": "Last four digits of the bank account number.", | |
| "type": "string" | |
| }, | |
| "mandate": { | |
| "description": "ID of the mandate used to make this payment.", | |
| "type": "string" | |
| }, | |
| "transit_number": { | |
| "description": "Transit number of the bank account.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.AfterpayClearpay": { | |
| "properties": { | |
| "reference": { | |
| "description": "Order identifier shown to the merchant in Afterpay's online portal.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.Alipay": { | |
| "properties": { | |
| "fingerprint": { | |
| "description": "Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.", | |
| "type": "string" | |
| }, | |
| "transaction_id": { | |
| "description": "Transaction ID of this particular Alipay transaction.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.AuBecsDebit": { | |
| "properties": { | |
| "bsb_number": { | |
| "description": "Bank-State-Branch number of the bank account.", | |
| "type": "string" | |
| }, | |
| "fingerprint": { | |
| "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", | |
| "type": "string" | |
| }, | |
| "last4": { | |
| "description": "Last four digits of the bank account number.", | |
| "type": "string" | |
| }, | |
| "mandate": { | |
| "description": "ID of the mandate used to make this payment.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.BacsDebit": { | |
| "properties": { | |
| "fingerprint": { | |
| "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", | |
| "type": "string" | |
| }, | |
| "last4": { | |
| "description": "Last four digits of the bank account number.", | |
| "type": "string" | |
| }, | |
| "mandate": { | |
| "description": "ID of the mandate used to make this payment.", | |
| "type": "string" | |
| }, | |
| "sort_code": { | |
| "description": "Sort code of the bank account. (e.g., `10-20-30`)", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.Bancontact": { | |
| "properties": { | |
| "bank_code": { | |
| "description": "Bank code of bank associated with the bank account.", | |
| "type": "string" | |
| }, | |
| "bank_name": { | |
| "description": "Name of the bank associated with the bank account.", | |
| "type": "string" | |
| }, | |
| "bic": { | |
| "description": "Bank Identifier Code of the bank associated with the bank account.", | |
| "type": "string" | |
| }, | |
| "generated_sepa_debit": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.PaymentMethod" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge." | |
| }, | |
| "generated_sepa_debit_mandate": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Mandate" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge." | |
| }, | |
| "iban_last4": { | |
| "description": "Last four characters of the IBAN.", | |
| "type": "string" | |
| }, | |
| "preferred_language": { | |
| "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.\nCan be one of `en`, `de`, `fr`, or `nl`", | |
| "enum": [ | |
| "de", | |
| "en", | |
| "fr", | |
| "nl" | |
| ], | |
| "type": "string" | |
| }, | |
| "verified_name": { | |
| "description": "Owner's verified full name. Values are verified or provided by Bancontact directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.Boleto": { | |
| "properties": { | |
| "tax_id": { | |
| "description": "Uniquely identifies this customer tax_id (CNPJ or CPF)", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.Card": { | |
| "properties": { | |
| "brand": { | |
| "description": "Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.", | |
| "type": "string" | |
| }, | |
| "checks": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.Card.Checks", | |
| "description": "Check results by Card networks on Card address and CVC at time of payment." | |
| }, | |
| "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.", | |
| "type": "string" | |
| }, | |
| "description": { | |
| "description": "A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)", | |
| "type": "string" | |
| }, | |
| "exp_month": { | |
| "description": "Two-digit number representing the card's expiration month.", | |
| "type": "number" | |
| }, | |
| "exp_year": { | |
| "description": "Four-digit number representing the card's expiration year.", | |
| "type": "number" | |
| }, | |
| "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.\n\n*Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*", | |
| "type": "string" | |
| }, | |
| "funding": { | |
| "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", | |
| "type": "string" | |
| }, | |
| "iin": { | |
| "description": "Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)", | |
| "type": "string" | |
| }, | |
| "installments": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.Card.Installments", | |
| "description": "Installment details for this payment (Mexico only).\n\nFor more information, see the [installments integration guide](https://stripe.com/docs/payments/installments)." | |
| }, | |
| "issuer": { | |
| "description": "The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)", | |
| "type": "string" | |
| }, | |
| "last4": { | |
| "description": "The last four digits of the card.", | |
| "type": "string" | |
| }, | |
| "moto": { | |
| "description": "True if this payment was marked as MOTO and out of scope for SCA.", | |
| "type": "boolean" | |
| }, | |
| "network": { | |
| "description": "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.", | |
| "type": "string" | |
| }, | |
| "three_d_secure": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.Card.ThreeDSecure", | |
| "description": "Populated if this transaction used 3D Secure authentication." | |
| }, | |
| "wallet": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.Card.Wallet", | |
| "description": "If this Card is part of a card wallet, this contains the details of the card wallet." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.Card.Checks": { | |
| "properties": { | |
| "address_line1_check": { | |
| "description": "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", | |
| "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`.", | |
| "type": "string" | |
| }, | |
| "cvc_check": { | |
| "description": "If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.Card.Installments": { | |
| "properties": { | |
| "plan": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.Card.Installments.Plan", | |
| "description": "Installment plan selected for the payment." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.Card.Installments.Plan": { | |
| "properties": { | |
| "count": { | |
| "description": "For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.", | |
| "type": "number" | |
| }, | |
| "interval": { | |
| "description": "For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`.", | |
| "enum": [ | |
| "month" | |
| ], | |
| "type": "string" | |
| }, | |
| "type": { | |
| "description": "Type of installment plan, one of `fixed_count`.", | |
| "enum": [ | |
| "fixed_count" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.Card.ThreeDSecure": { | |
| "properties": { | |
| "authentication_flow": { | |
| "description": "For authenticated transactions: how the customer was authenticated by\nthe issuing bank.", | |
| "enum": [ | |
| "challenge", | |
| "frictionless" | |
| ], | |
| "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\non the `result`.", | |
| "enum": [ | |
| "abandoned", | |
| "bypassed", | |
| "canceled", | |
| "card_not_enrolled", | |
| "network_not_supported", | |
| "protocol_error", | |
| "rejected" | |
| ], | |
| "type": "string" | |
| }, | |
| "version": { | |
| "description": "The version of 3D Secure that was used.", | |
| "enum": [ | |
| "1.0.2", | |
| "2.1.0", | |
| "2.2.0" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.Card.Wallet": { | |
| "properties": { | |
| "amex_express_checkout": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.Card.Wallet.AmexExpressCheckout" | |
| }, | |
| "apple_pay": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.Card.Wallet.ApplePay" | |
| }, | |
| "dynamic_last4": { | |
| "description": "(For tokenized numbers only.) The last four digits of the device account number.", | |
| "type": "string" | |
| }, | |
| "google_pay": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.Card.Wallet.GooglePay" | |
| }, | |
| "masterpass": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.Card.Wallet.Masterpass" | |
| }, | |
| "samsung_pay": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.Card.Wallet.SamsungPay" | |
| }, | |
| "type": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.Card.Wallet.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." | |
| }, | |
| "visa_checkout": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.Card.Wallet.VisaCheckout" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.Card.Wallet.AmexExpressCheckout": { | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.Card.Wallet.ApplePay": { | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.Card.Wallet.GooglePay": { | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.Card.Wallet.Masterpass": { | |
| "properties": { | |
| "billing_address": { | |
| "$ref": "#/definitions/Stripe.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." | |
| }, | |
| "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.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "shipping_address": { | |
| "$ref": "#/definitions/Stripe.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." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.Card.Wallet.SamsungPay": { | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.Card.Wallet.Type": { | |
| "enum": [ | |
| "amex_express_checkout", | |
| "apple_pay", | |
| "google_pay", | |
| "masterpass", | |
| "samsung_pay", | |
| "visa_checkout" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.Card.Wallet.VisaCheckout": { | |
| "properties": { | |
| "billing_address": { | |
| "$ref": "#/definitions/Stripe.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." | |
| }, | |
| "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.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "shipping_address": { | |
| "$ref": "#/definitions/Stripe.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." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.CardPresent": { | |
| "properties": { | |
| "brand": { | |
| "description": "Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.", | |
| "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 (`/`).", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "description": { | |
| "description": "A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)", | |
| "type": "string" | |
| }, | |
| "emv_auth_data": { | |
| "description": "Authorization response cryptogram.", | |
| "type": "string" | |
| }, | |
| "exp_month": { | |
| "description": "Two-digit number representing the card's expiration month.", | |
| "type": "number" | |
| }, | |
| "exp_year": { | |
| "description": "Four-digit number representing the card's expiration year.", | |
| "type": "number" | |
| }, | |
| "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.\n\n*Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*", | |
| "type": "string" | |
| }, | |
| "funding": { | |
| "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "iin": { | |
| "description": "Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)", | |
| "type": "string" | |
| }, | |
| "issuer": { | |
| "description": "The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)", | |
| "type": "string" | |
| }, | |
| "last4": { | |
| "description": "The last four digits of the card.", | |
| "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`.", | |
| "type": "string" | |
| }, | |
| "read_method": { | |
| "description": "How card details were read in this transaction.", | |
| "enum": [ | |
| "contact_emv", | |
| "contactless_emv", | |
| "contactless_magstripe_mode", | |
| "magnetic_stripe_fallback", | |
| "magnetic_stripe_track2" | |
| ], | |
| "type": "string" | |
| }, | |
| "receipt": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.CardPresent.Receipt", | |
| "description": "A collection of fields required to be displayed on receipts. Only required for EMV transactions." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.CardPresent.Receipt": { | |
| "properties": { | |
| "account_type": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.CardPresent.Receipt.AccountType", | |
| "description": "The type of account being debited or credited" | |
| }, | |
| "application_cryptogram": { | |
| "description": "EMV tag 9F26, cryptogram generated by the integrated circuit chip.", | |
| "type": "string" | |
| }, | |
| "application_preferred_name": { | |
| "description": "Mnenomic of the Application Identifier.", | |
| "type": "string" | |
| }, | |
| "authorization_code": { | |
| "description": "Identifier for this transaction.", | |
| "type": "string" | |
| }, | |
| "authorization_response_code": { | |
| "description": "EMV tag 8A. A code returned by the card issuer.", | |
| "type": "string" | |
| }, | |
| "cardholder_verification_method": { | |
| "description": "How the cardholder verified ownership of the card.", | |
| "type": "string" | |
| }, | |
| "dedicated_file_name": { | |
| "description": "EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.", | |
| "type": "string" | |
| }, | |
| "terminal_verification_results": { | |
| "description": "The outcome of a series of EMV functions performed by the card reader.", | |
| "type": "string" | |
| }, | |
| "transaction_status_information": { | |
| "description": "An indication of various EMV functions performed during the transaction.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.CardPresent.Receipt.AccountType": { | |
| "enum": [ | |
| "checking", | |
| "credit", | |
| "prepaid", | |
| "unknown" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.Eps": { | |
| "properties": { | |
| "bank": { | |
| "description": "The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`.", | |
| "enum": [ | |
| "arzte_und_apotheker_bank", | |
| "austrian_anadi_bank_ag", | |
| "bank_austria", | |
| "bankhaus_carl_spangler", | |
| "bankhaus_schelhammer_und_schattera_ag", | |
| "bawag_psk_ag", | |
| "bks_bank_ag", | |
| "brull_kallmus_bank_ag", | |
| "btv_vier_lander_bank", | |
| "capital_bank_grawe_gruppe_ag", | |
| "dolomitenbank", | |
| "easybank_ag", | |
| "erste_bank_und_sparkassen", | |
| "hypo_alpeadriabank_international_ag", | |
| "hypo_bank_burgenland_aktiengesellschaft", | |
| "hypo_noe_lb_fur_niederosterreich_u_wien", | |
| "hypo_oberosterreich_salzburg_steiermark", | |
| "hypo_tirol_bank_ag", | |
| "hypo_vorarlberg_bank_ag", | |
| "marchfelder_bank", | |
| "oberbank_ag", | |
| "raiffeisen_bankengruppe_osterreich", | |
| "schoellerbank_ag", | |
| "sparda_bank_wien", | |
| "volksbank_gruppe", | |
| "volkskreditbank_ag", | |
| "vr_bank_braunau" | |
| ], | |
| "type": "string" | |
| }, | |
| "verified_name": { | |
| "description": "Owner's verified full name. Values are verified or provided by EPS directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nEPS rarely provides this information so the attribute is usually empty.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.Fpx": { | |
| "properties": { | |
| "account_holder_type": { | |
| "description": "Account holder type, if provided. Can be one of `individual` or `company`.", | |
| "enum": [ | |
| "company", | |
| "individual" | |
| ], | |
| "type": "string" | |
| }, | |
| "bank": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.Fpx.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`." | |
| }, | |
| "transaction_id": { | |
| "description": "Unique transaction id generated by FPX for every request from the merchant", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.Fpx.Bank": { | |
| "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" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.Giropay": { | |
| "properties": { | |
| "bank_code": { | |
| "description": "Bank code of bank associated with the bank account.", | |
| "type": "string" | |
| }, | |
| "bank_name": { | |
| "description": "Name of the bank associated with the bank account.", | |
| "type": "string" | |
| }, | |
| "bic": { | |
| "description": "Bank Identifier Code of the bank associated with the bank account.", | |
| "type": "string" | |
| }, | |
| "verified_name": { | |
| "description": "Owner's verified full name. Values are verified or provided by Giropay directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nGiropay rarely provides this information so the attribute is usually empty.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.Grabpay": { | |
| "properties": { | |
| "transaction_id": { | |
| "description": "Unique transaction id generated by GrabPay", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.Ideal": { | |
| "properties": { | |
| "bank": { | |
| "description": "The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, or `van_lanschot`.", | |
| "enum": [ | |
| "abn_amro", | |
| "asn_bank", | |
| "bunq", | |
| "handelsbanken", | |
| "ing", | |
| "knab", | |
| "moneyou", | |
| "rabobank", | |
| "regiobank", | |
| "revolut", | |
| "sns_bank", | |
| "triodos_bank", | |
| "van_lanschot" | |
| ], | |
| "type": "string" | |
| }, | |
| "bic": { | |
| "description": "The Bank Identifier Code of the customer's bank.", | |
| "enum": [ | |
| "ABNANL2A", | |
| "ASNBNL21", | |
| "BUNQNL2A", | |
| "FVLBNL22", | |
| "HANDNL2A", | |
| "INGBNL2A", | |
| "KNABNL2H", | |
| "MOYONL21", | |
| "RABONL2U", | |
| "RBRBNL21", | |
| "REVOLT21", | |
| "SNSBNL2A", | |
| "TRIONL2U" | |
| ], | |
| "type": "string" | |
| }, | |
| "generated_sepa_debit": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.PaymentMethod" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge." | |
| }, | |
| "generated_sepa_debit_mandate": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Mandate" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge." | |
| }, | |
| "iban_last4": { | |
| "description": "Last four characters of the IBAN.", | |
| "type": "string" | |
| }, | |
| "verified_name": { | |
| "description": "Owner's verified full name. Values are verified or provided by iDEAL directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.InteracPresent": { | |
| "properties": { | |
| "brand": { | |
| "description": "Card brand. Can be `interac`, `mastercard` or `visa`.", | |
| "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 (`/`).", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "description": { | |
| "description": "A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)", | |
| "type": "string" | |
| }, | |
| "emv_auth_data": { | |
| "description": "Authorization response cryptogram.", | |
| "type": "string" | |
| }, | |
| "exp_month": { | |
| "description": "Two-digit number representing the card's expiration month.", | |
| "type": "number" | |
| }, | |
| "exp_year": { | |
| "description": "Four-digit number representing the card's expiration year.", | |
| "type": "number" | |
| }, | |
| "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.\n\n*Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*", | |
| "type": "string" | |
| }, | |
| "funding": { | |
| "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "iin": { | |
| "description": "Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)", | |
| "type": "string" | |
| }, | |
| "issuer": { | |
| "description": "The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)", | |
| "type": "string" | |
| }, | |
| "last4": { | |
| "description": "The last four digits of the card.", | |
| "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`.", | |
| "type": "string" | |
| }, | |
| "preferred_locales": { | |
| "description": "EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "read_method": { | |
| "description": "How card details were read in this transaction.", | |
| "enum": [ | |
| "contact_emv", | |
| "contactless_emv", | |
| "contactless_magstripe_mode", | |
| "magnetic_stripe_fallback", | |
| "magnetic_stripe_track2" | |
| ], | |
| "type": "string" | |
| }, | |
| "receipt": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.InteracPresent.Receipt", | |
| "description": "A collection of fields required to be displayed on receipts. Only required for EMV transactions." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.InteracPresent.Receipt": { | |
| "properties": { | |
| "account_type": { | |
| "$ref": "#/definitions/Stripe.Charge.PaymentMethodDetails.InteracPresent.Receipt.AccountType", | |
| "description": "The type of account being debited or credited" | |
| }, | |
| "application_cryptogram": { | |
| "description": "EMV tag 9F26, cryptogram generated by the integrated circuit chip.", | |
| "type": "string" | |
| }, | |
| "application_preferred_name": { | |
| "description": "Mnenomic of the Application Identifier.", | |
| "type": "string" | |
| }, | |
| "authorization_code": { | |
| "description": "Identifier for this transaction.", | |
| "type": "string" | |
| }, | |
| "authorization_response_code": { | |
| "description": "EMV tag 8A. A code returned by the card issuer.", | |
| "type": "string" | |
| }, | |
| "cardholder_verification_method": { | |
| "description": "How the cardholder verified ownership of the card.", | |
| "type": "string" | |
| }, | |
| "dedicated_file_name": { | |
| "description": "EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.", | |
| "type": "string" | |
| }, | |
| "terminal_verification_results": { | |
| "description": "The outcome of a series of EMV functions performed by the card reader.", | |
| "type": "string" | |
| }, | |
| "transaction_status_information": { | |
| "description": "An indication of various EMV functions performed during the transaction.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.InteracPresent.Receipt.AccountType": { | |
| "enum": [ | |
| "checking", | |
| "savings", | |
| "unknown" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.Klarna": { | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.Multibanco": { | |
| "properties": { | |
| "entity": { | |
| "description": "Entity number associated with this Multibanco payment.", | |
| "type": "string" | |
| }, | |
| "reference": { | |
| "description": "Reference number associated with this Multibanco payment.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.Oxxo": { | |
| "properties": { | |
| "number": { | |
| "description": "OXXO reference number", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.P24": { | |
| "properties": { | |
| "bank": { | |
| "description": "The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `blik`, `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`.", | |
| "enum": [ | |
| "alior_bank", | |
| "bank_millennium", | |
| "bank_nowy_bfg_sa", | |
| "bank_pekao_sa", | |
| "banki_spbdzielcze", | |
| "blik", | |
| "bnp_paribas", | |
| "boz", | |
| "citi_handlowy", | |
| "credit_agricole", | |
| "envelobank", | |
| "etransfer_pocztowy24", | |
| "getin_bank", | |
| "ideabank", | |
| "ing", | |
| "inteligo", | |
| "mbank_mtransfer", | |
| "nest_przelew", | |
| "noble_pay", | |
| "pbac_z_ipko", | |
| "plus_bank", | |
| "santander_przelew24", | |
| "tmobile_usbugi_bankowe", | |
| "toyota_bank", | |
| "volkswagen_bank" | |
| ], | |
| "type": "string" | |
| }, | |
| "reference": { | |
| "description": "Unique reference for this Przelewy24 payment.", | |
| "type": "string" | |
| }, | |
| "verified_name": { | |
| "description": "Owner's verified full name. Values are verified or provided by Przelewy24 directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nPrzelewy24 rarely provides this information so the attribute is usually empty.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.SepaCreditTransfer": { | |
| "properties": { | |
| "bank_name": { | |
| "description": "Name of the bank associated with the bank account.", | |
| "type": "string" | |
| }, | |
| "bic": { | |
| "description": "Bank Identifier Code of the bank associated with the bank account.", | |
| "type": "string" | |
| }, | |
| "iban": { | |
| "description": "IBAN of the bank account to transfer funds to.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.SepaDebit": { | |
| "properties": { | |
| "bank_code": { | |
| "description": "Bank code of bank associated with the bank account.", | |
| "type": "string" | |
| }, | |
| "branch_code": { | |
| "description": "Branch code of bank associated with the bank account.", | |
| "type": "string" | |
| }, | |
| "country": { | |
| "description": "Two-letter ISO code representing the country the bank account is located in.", | |
| "type": "string" | |
| }, | |
| "fingerprint": { | |
| "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", | |
| "type": "string" | |
| }, | |
| "last4": { | |
| "description": "Last four characters of the IBAN.", | |
| "type": "string" | |
| }, | |
| "mandate": { | |
| "description": "ID of the mandate used to make this payment.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.Sofort": { | |
| "properties": { | |
| "bank_code": { | |
| "description": "Bank code of bank associated with the bank account.", | |
| "type": "string" | |
| }, | |
| "bank_name": { | |
| "description": "Name of the bank associated with the bank account.", | |
| "type": "string" | |
| }, | |
| "bic": { | |
| "description": "Bank Identifier Code of the bank associated with the bank account.", | |
| "type": "string" | |
| }, | |
| "country": { | |
| "description": "Two-letter ISO code representing the country the bank account is located in.", | |
| "type": "string" | |
| }, | |
| "generated_sepa_debit": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.PaymentMethod" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge." | |
| }, | |
| "generated_sepa_debit_mandate": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Mandate" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge." | |
| }, | |
| "iban_last4": { | |
| "description": "Last four characters of the IBAN.", | |
| "type": "string" | |
| }, | |
| "preferred_language": { | |
| "description": "Preferred language of the SOFORT authorization page that the customer is redirected to.\nCan be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl`", | |
| "enum": [ | |
| "de", | |
| "en", | |
| "es", | |
| "fr", | |
| "it", | |
| "nl", | |
| "pl" | |
| ], | |
| "type": "string" | |
| }, | |
| "verified_name": { | |
| "description": "Owner's verified full name. Values are verified or provided by SOFORT directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.StripeAccount": { | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.Wechat": { | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.PaymentMethodDetails.WechatPay": { | |
| "properties": { | |
| "fingerprint": { | |
| "description": "Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same.", | |
| "type": "string" | |
| }, | |
| "transaction_id": { | |
| "description": "Transaction ID of this particular WeChat Pay transaction.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.Shipping": { | |
| "properties": { | |
| "address": { | |
| "$ref": "#/definitions/Stripe.Address" | |
| }, | |
| "carrier": { | |
| "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "description": "Recipient name.", | |
| "type": "string" | |
| }, | |
| "phone": { | |
| "description": "Recipient phone (including extension).", | |
| "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.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Charge.TransferData": { | |
| "properties": { | |
| "amount": { | |
| "description": "The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.", | |
| "type": "number" | |
| }, | |
| "destination": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Account" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.ChargesResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Checkout.SessionsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.ConnectCollectionTransfer": { | |
| "description": "The ConnectCollectionTransfer object.", | |
| "properties": { | |
| "amount": { | |
| "description": "Amount transferred, in %s.", | |
| "type": "number" | |
| }, | |
| "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": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Account" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the account that funds are being collected for." | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "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" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.CountrySpecsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Coupon": { | |
| "description": "The Coupon object.", | |
| "properties": { | |
| "amount_off": { | |
| "description": "Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer.", | |
| "type": "number" | |
| }, | |
| "applies_to": { | |
| "$ref": "#/definitions/Stripe.Coupon.AppliesTo" | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "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.", | |
| "type": "string" | |
| }, | |
| "deleted": { | |
| "type": "string" | |
| }, | |
| "duration": { | |
| "$ref": "#/definitions/Stripe.Coupon.Duration", | |
| "description": "One of `forever`, `once`, and `repeating`. Describes how long a customer who applies this coupon will get the discount." | |
| }, | |
| "duration_in_months": { | |
| "description": "If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`.", | |
| "type": "number" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "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.", | |
| "type": "number" | |
| }, | |
| "metadata": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "name": { | |
| "description": "Name of the coupon displayed to customers on for instance invoices or receipts.", | |
| "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.", | |
| "type": "number" | |
| }, | |
| "redeem_by": { | |
| "description": "Date after which the coupon can no longer be redeemed.", | |
| "type": "number" | |
| }, | |
| "times_redeemed": { | |
| "description": "Number of times this coupon has been applied to a customer.", | |
| "type": "number" | |
| }, | |
| "valid": { | |
| "description": "Taking account of the above properties, whether this coupon can still be applied to a customer.", | |
| "type": "boolean" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Coupon.AppliesTo": { | |
| "properties": { | |
| "products": { | |
| "description": "A list of product IDs this coupon applies to", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Coupon.Duration": { | |
| "enum": [ | |
| "forever", | |
| "once", | |
| "repeating" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.CouponsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.CreditNotesResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Customer": { | |
| "description": "The Customer object.", | |
| "properties": { | |
| "address": { | |
| "$ref": "#/definitions/Stripe.Address", | |
| "description": "The customer's address." | |
| }, | |
| "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": "number" | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "currency": { | |
| "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes.", | |
| "type": "string" | |
| }, | |
| "default_source": { | |
| "anyOf": [ | |
| { | |
| "description": "The resulting source of [a Connect platform debiting a connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account).", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "object": { | |
| "enum": [ | |
| "account" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.AlipayAccount" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.BankAccount" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.BitcoinReceiver" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Card" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Source" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the default payment source for the customer.\n\nIf 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." | |
| }, | |
| "deleted": { | |
| "type": "string" | |
| }, | |
| "delinquent": { | |
| "description": "When the customer's latest invoice is billed by charging automatically, `delinquent` is `true` if the invoice's latest charge failed. When the customer's latest invoice is billed by sending an invoice, `delinquent` is `true` if the invoice isn't paid by its due date.\n\nIf an invoice is marked uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn't get reset to `false`.", | |
| "type": "boolean" | |
| }, | |
| "description": { | |
| "description": "An arbitrary string attached to the object. Often useful for displaying to users.", | |
| "type": "string" | |
| }, | |
| "discount": { | |
| "$ref": "#/definitions/Stripe.Discount", | |
| "description": "Describes the current discount active on the customer, if there is one." | |
| }, | |
| "email": { | |
| "description": "The customer's email address.", | |
| "type": "string" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "invoice_prefix": { | |
| "description": "The prefix for the customer used to generate unique invoice numbers.", | |
| "type": "string" | |
| }, | |
| "invoice_settings": { | |
| "$ref": "#/definitions/Stripe.Customer.InvoiceSettings" | |
| }, | |
| "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": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "name": { | |
| "description": "The customer's full name or business name.", | |
| "type": "string" | |
| }, | |
| "next_invoice_sequence": { | |
| "description": "The suffix of the customer's next invoice number, e.g., 0001.", | |
| "type": "number" | |
| }, | |
| "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.", | |
| "type": "string" | |
| }, | |
| "preferred_locales": { | |
| "description": "The customer's preferred locales (languages), ordered by preference.", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "shipping": { | |
| "$ref": "#/definitions/Stripe.Customer.Shipping", | |
| "description": "Mailing and shipping address for the customer. Appears on invoices emailed to this customer." | |
| }, | |
| "sources": { | |
| "$ref": "#/definitions/Stripe.ApiList<Stripe.CustomerSource>", | |
| "description": "The customer's payment sources, if any." | |
| }, | |
| "subscriptions": { | |
| "$ref": "#/definitions/Stripe.ApiList<Stripe.Subscription>", | |
| "description": "The customer's current subscriptions, if any." | |
| }, | |
| "tax": { | |
| "$ref": "#/definitions/Stripe.Customer.Tax" | |
| }, | |
| "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" | |
| ], | |
| "type": "string" | |
| }, | |
| "tax_ids": { | |
| "$ref": "#/definitions/Stripe.ApiList<Stripe.TaxId>", | |
| "description": "The customer's tax IDs." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Customer.InvoiceSettings": { | |
| "properties": { | |
| "custom_fields": { | |
| "description": "Default custom fields to be displayed on invoices for this customer.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.Customer.InvoiceSettings.CustomField" | |
| }, | |
| "type": "array" | |
| }, | |
| "default_payment_method": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.PaymentMethod" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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." | |
| }, | |
| "footer": { | |
| "description": "Default footer to be displayed on invoices for this customer.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Customer.InvoiceSettings.CustomField": { | |
| "properties": { | |
| "name": { | |
| "description": "The name of the custom field.", | |
| "type": "string" | |
| }, | |
| "value": { | |
| "description": "The value of the custom field.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Customer.Shipping": { | |
| "properties": { | |
| "address": { | |
| "$ref": "#/definitions/Stripe.Address" | |
| }, | |
| "carrier": { | |
| "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "description": "Recipient name.", | |
| "type": "string" | |
| }, | |
| "phone": { | |
| "description": "Recipient phone (including extension).", | |
| "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.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Customer.Tax": { | |
| "properties": { | |
| "automatic_tax": { | |
| "$ref": "#/definitions/Stripe.Customer.Tax.AutomaticTax", | |
| "description": "Surfaces if automatic tax computation is possible given the current customer location information." | |
| }, | |
| "ip_address": { | |
| "description": "A recent IP address of the customer used for tax reporting and tax location inference.", | |
| "type": "string" | |
| }, | |
| "location": { | |
| "$ref": "#/definitions/Stripe.Customer.Tax.Location", | |
| "description": "The customer's location as identified by Stripe Tax." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Customer.Tax.AutomaticTax": { | |
| "enum": [ | |
| "failed", | |
| "not_collecting", | |
| "supported", | |
| "unrecognized_location" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Customer.Tax.Location": { | |
| "properties": { | |
| "country": { | |
| "description": "The customer's country as identified by Stripe Tax.", | |
| "type": "string" | |
| }, | |
| "source": { | |
| "$ref": "#/definitions/Stripe.Customer.Tax.Location.Source", | |
| "description": "The data source used to infer the customer's location." | |
| }, | |
| "state": { | |
| "description": "The customer's state, county, province, or region as identified by Stripe Tax.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Customer.Tax.Location.Source": { | |
| "enum": [ | |
| "billing_address", | |
| "ip_address", | |
| "payment_method", | |
| "shipping_destination" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.CustomersResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.DeletedAlipayAccount": { | |
| "description": "The DeletedAlipayAccount object.", | |
| "properties": { | |
| "deleted": { | |
| "description": "Always true for a deleted object", | |
| "enum": [ | |
| true | |
| ], | |
| "type": "boolean" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "alipay_account" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.DeletedBankAccount": { | |
| "description": "The DeletedBankAccount object.", | |
| "properties": { | |
| "currency": { | |
| "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.", | |
| "type": "string" | |
| }, | |
| "deleted": { | |
| "description": "Always true for a deleted object", | |
| "enum": [ | |
| true | |
| ], | |
| "type": "boolean" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "bank_account" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.DeletedBitcoinReceiver": { | |
| "description": "The DeletedBitcoinReceiver object.", | |
| "properties": { | |
| "deleted": { | |
| "description": "Always true for a deleted object", | |
| "enum": [ | |
| true | |
| ], | |
| "type": "boolean" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "bitcoin_receiver" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.DeletedCard": { | |
| "description": "The DeletedCard object.", | |
| "properties": { | |
| "currency": { | |
| "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.", | |
| "type": "string" | |
| }, | |
| "deleted": { | |
| "description": "Always true for a deleted object", | |
| "enum": [ | |
| true | |
| ], | |
| "type": "boolean" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "card" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.DeletedCoupon": { | |
| "description": "The DeletedCoupon object.", | |
| "properties": { | |
| "deleted": { | |
| "description": "Always true for a deleted object", | |
| "enum": [ | |
| true | |
| ], | |
| "type": "boolean" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "coupon" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.DeletedCustomer": { | |
| "description": "The DeletedCustomer object.", | |
| "properties": { | |
| "deleted": { | |
| "description": "Always true for a deleted object", | |
| "enum": [ | |
| true | |
| ], | |
| "type": "boolean" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "customer" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.DeletedDiscount": { | |
| "description": "The DeletedDiscount object.", | |
| "properties": { | |
| "checkout_session": { | |
| "description": "The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.", | |
| "type": "string" | |
| }, | |
| "coupon": { | |
| "$ref": "#/definitions/Stripe.Coupon", | |
| "description": "A coupon contains information about a percent-off or amount-off discount you\nmight want to apply to a customer. Coupons may be applied to [invoices](https://stripe.com/docs/api#invoices) or\n[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)." | |
| }, | |
| "customer": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Customer" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedCustomer" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The ID of the customer associated with this discount." | |
| }, | |
| "deleted": { | |
| "description": "Always true for a deleted object", | |
| "enum": [ | |
| true | |
| ], | |
| "type": "boolean" | |
| }, | |
| "id": { | |
| "description": "The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.", | |
| "type": "string" | |
| }, | |
| "invoice": { | |
| "description": "The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.", | |
| "type": "string" | |
| }, | |
| "invoice_item": { | |
| "description": "The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.", | |
| "type": "string" | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "discount" | |
| ], | |
| "type": "string" | |
| }, | |
| "promotion_code": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.PromotionCode" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The promotion code applied to create this discount." | |
| }, | |
| "start": { | |
| "description": "Date that the coupon was applied.", | |
| "type": "number" | |
| }, | |
| "subscription": { | |
| "description": "The subscription that this coupon is applied to, if it is applied to a particular subscription.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.DeletedInvoice": { | |
| "description": "The DeletedInvoice object.", | |
| "properties": { | |
| "deleted": { | |
| "description": "Always true for a deleted object", | |
| "enum": [ | |
| true | |
| ], | |
| "type": "boolean" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "invoice" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.DeletedPlan": { | |
| "description": "The DeletedPlan object.", | |
| "properties": { | |
| "deleted": { | |
| "description": "Always true for a deleted object", | |
| "enum": [ | |
| true | |
| ], | |
| "type": "boolean" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "plan" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.DeletedPrice": { | |
| "description": "The DeletedPrice object.", | |
| "properties": { | |
| "deleted": { | |
| "description": "Always true for a deleted object", | |
| "enum": [ | |
| true | |
| ], | |
| "type": "boolean" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "price" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.DeletedProduct": { | |
| "description": "The DeletedProduct object.", | |
| "properties": { | |
| "deleted": { | |
| "description": "Always true for a deleted object", | |
| "enum": [ | |
| true | |
| ], | |
| "type": "boolean" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "product" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.DeletedTaxId": { | |
| "description": "The DeletedTaxId object.", | |
| "properties": { | |
| "deleted": { | |
| "description": "Always true for a deleted object", | |
| "enum": [ | |
| true | |
| ], | |
| "type": "boolean" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "tax_id" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Discount": { | |
| "description": "The Discount object.", | |
| "properties": { | |
| "checkout_session": { | |
| "description": "The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.", | |
| "type": "string" | |
| }, | |
| "coupon": { | |
| "$ref": "#/definitions/Stripe.Coupon", | |
| "description": "A coupon contains information about a percent-off or amount-off discount you\nmight want to apply to a customer. Coupons may be applied to [invoices](https://stripe.com/docs/api#invoices) or\n[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)." | |
| }, | |
| "customer": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Customer" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedCustomer" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The ID of the customer associated with this discount." | |
| }, | |
| "deleted": { | |
| "type": "string" | |
| }, | |
| "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.", | |
| "type": "number" | |
| }, | |
| "id": { | |
| "description": "The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.", | |
| "type": "string" | |
| }, | |
| "invoice": { | |
| "description": "The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.", | |
| "type": "string" | |
| }, | |
| "invoice_item": { | |
| "description": "The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.", | |
| "type": "string" | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "discount" | |
| ], | |
| "type": "string" | |
| }, | |
| "promotion_code": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.PromotionCode" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The promotion code applied to create this discount." | |
| }, | |
| "start": { | |
| "description": "Date that the coupon was applied.", | |
| "type": "number" | |
| }, | |
| "subscription": { | |
| "description": "The subscription that this coupon is applied to, if it is applied to a particular subscription.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Dispute": { | |
| "description": "The Dispute object.", | |
| "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": "number" | |
| }, | |
| "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": "#/definitions/Stripe.BalanceTransaction" | |
| }, | |
| "type": "array" | |
| }, | |
| "charge": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Charge" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the charge that was disputed." | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "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": "#/definitions/Stripe.Dispute.Evidence" | |
| }, | |
| "evidence_details": { | |
| "$ref": "#/definitions/Stripe.Dispute.EvidenceDetails" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "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": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "network_reason_code": { | |
| "description": "Network-dependent reason code for the dispute.", | |
| "type": "string" | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "dispute" | |
| ], | |
| "type": "string" | |
| }, | |
| "payment_intent": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.PaymentIntent" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the PaymentIntent that was disputed." | |
| }, | |
| "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).", | |
| "type": "string" | |
| }, | |
| "status": { | |
| "$ref": "#/definitions/Stripe.Dispute.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`." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Dispute.Evidence": { | |
| "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.", | |
| "type": "string" | |
| }, | |
| "billing_address": { | |
| "description": "The billing address provided by the customer.", | |
| "type": "string" | |
| }, | |
| "cancellation_policy": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer." | |
| }, | |
| "cancellation_policy_disclosure": { | |
| "description": "An explanation of how and when the customer was shown your refund policy prior to purchase.", | |
| "type": "string" | |
| }, | |
| "cancellation_rebuttal": { | |
| "description": "A justification for why the customer's subscription was not canceled.", | |
| "type": "string" | |
| }, | |
| "customer_communication": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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." | |
| }, | |
| "customer_email_address": { | |
| "description": "The email address of the customer.", | |
| "type": "string" | |
| }, | |
| "customer_name": { | |
| "description": "The name of the customer.", | |
| "type": "string" | |
| }, | |
| "customer_purchase_ip": { | |
| "description": "The IP address that the customer used when making the purchase.", | |
| "type": "string" | |
| }, | |
| "customer_signature": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature." | |
| }, | |
| "duplicate_charge_documentation": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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." | |
| }, | |
| "duplicate_charge_explanation": { | |
| "description": "An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate.", | |
| "type": "string" | |
| }, | |
| "duplicate_charge_id": { | |
| "description": "The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge.", | |
| "type": "string" | |
| }, | |
| "product_description": { | |
| "description": "A description of the product or service that was sold.", | |
| "type": "string" | |
| }, | |
| "receipt": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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." | |
| }, | |
| "refund_policy": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer." | |
| }, | |
| "refund_policy_disclosure": { | |
| "description": "Documentation demonstrating that the customer was shown your refund policy prior to purchase.", | |
| "type": "string" | |
| }, | |
| "refund_refusal_explanation": { | |
| "description": "A justification for why the customer is not entitled to a refund.", | |
| "type": "string" | |
| }, | |
| "service_date": { | |
| "description": "The date on which the customer received or began receiving the purchased service, in a clear human-readable format.", | |
| "type": "string" | |
| }, | |
| "service_documentation": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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." | |
| }, | |
| "shipping_address": { | |
| "description": "The address to which a physical product was shipped. You should try to include as complete address information as possible.", | |
| "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.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "shipping_documentation": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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." | |
| }, | |
| "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.", | |
| "type": "string" | |
| }, | |
| "uncategorized_file": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements." | |
| }, | |
| "uncategorized_text": { | |
| "description": "Any additional evidence or statements.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Dispute.EvidenceDetails": { | |
| "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.", | |
| "type": "number" | |
| }, | |
| "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": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Dispute.Status": { | |
| "enum": [ | |
| "charge_refunded", | |
| "lost", | |
| "needs_response", | |
| "under_review", | |
| "warning_closed", | |
| "warning_needs_response", | |
| "warning_under_review", | |
| "won" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.DisputesResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.EphemeralKeysResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.EventsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.ExchangeRatesResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.FeeRefund": { | |
| "description": "The FeeRefund object.", | |
| "properties": { | |
| "amount": { | |
| "description": "Amount, in %s.", | |
| "type": "number" | |
| }, | |
| "balance_transaction": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.BalanceTransaction" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "Balance transaction that describes the impact on your account balance." | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "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": [ | |
| { | |
| "$ref": "#/definitions/Stripe.ApplicationFee" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the application fee that was refunded." | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "metadata": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "fee_refund" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.File": { | |
| "description": "The File object.", | |
| "properties": { | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "expires_at": { | |
| "description": "The time at which the file expires and is no longer available in epoch seconds.", | |
| "type": "number" | |
| }, | |
| "filename": { | |
| "description": "A filename for the file, suitable for saving to a filesystem.", | |
| "type": "string" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "links": { | |
| "$ref": "#/definitions/Stripe.ApiList<Stripe.FileLink>", | |
| "description": "A list of [file links](https://stripe.com/docs/api#file_links) that point at this file." | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "file" | |
| ], | |
| "type": "string" | |
| }, | |
| "purpose": { | |
| "$ref": "#/definitions/Stripe.File.Purpose", | |
| "description": "The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file." | |
| }, | |
| "size": { | |
| "description": "The size in bytes of the file object.", | |
| "type": "number" | |
| }, | |
| "title": { | |
| "description": "A user friendly title for the document.", | |
| "type": "string" | |
| }, | |
| "type": { | |
| "description": "The type of the file returned (e.g., `csv`, `pdf`, `jpg`, or `png`).", | |
| "type": "string" | |
| }, | |
| "url": { | |
| "description": "The URL from which the file can be downloaded using your live secret API key.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.File.Purpose": { | |
| "enum": [ | |
| "account_requirement", | |
| "additional_verification", | |
| "business_icon", | |
| "business_logo", | |
| "customer_signature", | |
| "dispute_evidence", | |
| "document_provider_identity_document", | |
| "finance_report_run", | |
| "identity_document", | |
| "identity_document_downloadable", | |
| "pci_document", | |
| "selfie", | |
| "sigma_scheduled_query", | |
| "tax_document_user_upload" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.FileLink": { | |
| "description": "The FileLink object.", | |
| "properties": { | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "expired": { | |
| "description": "Whether this link is already expired.", | |
| "type": "boolean" | |
| }, | |
| "expires_at": { | |
| "description": "Time at which the link expires.", | |
| "type": "number" | |
| }, | |
| "file": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The file object this link points to." | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "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": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "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.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.FileLinksResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.FilesResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Identity.VerificationReportsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Identity.VerificationSessionsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Invoice": { | |
| "description": "The Invoice object.", | |
| "properties": { | |
| "account_country": { | |
| "description": "The country of the business associated with this invoice, most often the business creating the invoice.", | |
| "type": "string" | |
| }, | |
| "account_name": { | |
| "description": "The public name of the business associated with this invoice, most often the business creating the invoice.", | |
| "type": "string" | |
| }, | |
| "account_tax_ids": { | |
| "description": "The account tax IDs associated with the invoice. Only editable when the invoice is a draft.", | |
| "items": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.TaxId" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedTaxId" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ] | |
| }, | |
| "type": "array" | |
| }, | |
| "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": "number" | |
| }, | |
| "amount_paid": { | |
| "description": "The amount, in %s, that was paid.", | |
| "type": "number" | |
| }, | |
| "amount_remaining": { | |
| "description": "The amount remaining, in %s, that is due.", | |
| "type": "number" | |
| }, | |
| "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.", | |
| "type": "number" | |
| }, | |
| "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": "number" | |
| }, | |
| "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" | |
| }, | |
| "automatic_tax": { | |
| "$ref": "#/definitions/Stripe.Invoice.AutomaticTax" | |
| }, | |
| "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", | |
| "quote_accept", | |
| "subscription", | |
| "subscription_create", | |
| "subscription_cycle", | |
| "subscription_threshold", | |
| "subscription_update", | |
| "upcoming" | |
| ], | |
| "type": "string" | |
| }, | |
| "charge": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Charge" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the latest charge generated for this invoice, if any." | |
| }, | |
| "collection_method": { | |
| "$ref": "#/definitions/Stripe.Invoice.CollectionMethod", | |
| "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." | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "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": "#/definitions/Stripe.Invoice.CustomField" | |
| }, | |
| "type": "array" | |
| }, | |
| "customer": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Customer" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedCustomer" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The ID of the customer who will be billed." | |
| }, | |
| "customer_address": { | |
| "$ref": "#/definitions/Stripe.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." | |
| }, | |
| "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.", | |
| "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.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "customer_shipping": { | |
| "$ref": "#/definitions/Stripe.Invoice.CustomerShipping", | |
| "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." | |
| }, | |
| "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" | |
| ], | |
| "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": "#/definitions/Stripe.Invoice.CustomerTaxId" | |
| }, | |
| "type": "array" | |
| }, | |
| "default_payment_method": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.PaymentMethod" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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." | |
| }, | |
| "default_source": { | |
| "anyOf": [ | |
| { | |
| "description": "The resulting source of [a Connect platform debiting a connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account).", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "object": { | |
| "enum": [ | |
| "account" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.AlipayAccount" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.BankAccount" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.BitcoinReceiver" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Card" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Source" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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." | |
| }, | |
| "default_tax_rates": { | |
| "description": "The tax rates applied to this invoice, if any.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.TaxRate" | |
| }, | |
| "type": "array" | |
| }, | |
| "deleted": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "description": "An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.", | |
| "type": "string" | |
| }, | |
| "discount": { | |
| "$ref": "#/definitions/Stripe.Discount", | |
| "description": "Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts." | |
| }, | |
| "discounts": { | |
| "description": "The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.", | |
| "items": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Discount" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedDiscount" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ] | |
| }, | |
| "type": "array" | |
| }, | |
| "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`.", | |
| "type": "number" | |
| }, | |
| "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.", | |
| "type": "number" | |
| }, | |
| "footer": { | |
| "description": "Footer displayed on the invoice.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "last_finalization_error": { | |
| "$ref": "#/definitions/Stripe.Invoice.LastFinalizationError", | |
| "description": "The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized." | |
| }, | |
| "lines": { | |
| "$ref": "#/definitions/Stripe.ApiList<Stripe.InvoiceLineItem>", | |
| "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." | |
| }, | |
| "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": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "next_payment_attempt": { | |
| "description": "The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`.", | |
| "type": "number" | |
| }, | |
| "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.", | |
| "type": "string" | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "invoice" | |
| ], | |
| "type": "string" | |
| }, | |
| "on_behalf_of": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Account" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details." | |
| }, | |
| "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": [ | |
| { | |
| "$ref": "#/definitions/Stripe.PaymentIntent" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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." | |
| }, | |
| "payment_settings": { | |
| "$ref": "#/definitions/Stripe.Invoice.PaymentSettings" | |
| }, | |
| "period_end": { | |
| "description": "End of the usage period during which invoice items were added to this invoice.", | |
| "type": "number" | |
| }, | |
| "period_start": { | |
| "description": "Start of the usage period during which invoice items were added to this invoice.", | |
| "type": "number" | |
| }, | |
| "post_payment_credit_notes_amount": { | |
| "description": "Total amount of all post-payment credit notes issued for this invoice.", | |
| "type": "number" | |
| }, | |
| "pre_payment_credit_notes_amount": { | |
| "description": "Total amount of all pre-payment credit notes issued for this invoice.", | |
| "type": "number" | |
| }, | |
| "quote": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Quote" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The quote this invoice was generated from." | |
| }, | |
| "receipt_number": { | |
| "description": "This is the transaction number that appears on email receipts sent for this invoice.", | |
| "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": "number" | |
| }, | |
| "statement_descriptor": { | |
| "description": "Extra information about an invoice for the customer's credit card statement.", | |
| "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" | |
| ], | |
| "type": "string" | |
| }, | |
| "status_transitions": { | |
| "$ref": "#/definitions/Stripe.Invoice.StatusTransitions" | |
| }, | |
| "subscription": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Subscription" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The subscription that this invoice was prepared for, if any." | |
| }, | |
| "subscription_proration_date": { | |
| "description": "Only set for upcoming invoices that preview prorations. The time used to calculate prorations.", | |
| "type": "number" | |
| }, | |
| "subtotal": { | |
| "description": "Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated", | |
| "type": "number" | |
| }, | |
| "tax": { | |
| "description": "The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice.", | |
| "type": "number" | |
| }, | |
| "threshold_reason": { | |
| "$ref": "#/definitions/Stripe.Invoice.ThresholdReason" | |
| }, | |
| "total": { | |
| "description": "Total after discounts and taxes.", | |
| "type": "number" | |
| }, | |
| "total_discount_amounts": { | |
| "description": "The aggregate amounts calculated per discount across all line items.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.Invoice.TotalDiscountAmount" | |
| }, | |
| "type": "array" | |
| }, | |
| "total_tax_amounts": { | |
| "description": "The aggregate amounts calculated per tax rate for all line items.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.Invoice.TotalTaxAmount" | |
| }, | |
| "type": "array" | |
| }, | |
| "transfer_data": { | |
| "$ref": "#/definitions/Stripe.Invoice.TransferData", | |
| "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." | |
| }, | |
| "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.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Invoice.AutomaticTax": { | |
| "properties": { | |
| "enabled": { | |
| "description": "Whether Stripe automatically computes tax on this invoice.", | |
| "type": "boolean" | |
| }, | |
| "status": { | |
| "description": "The status of the most recent automated tax calculation for this invoice.", | |
| "enum": [ | |
| "complete", | |
| "failed", | |
| "requires_location_inputs" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Invoice.CollectionMethod": { | |
| "enum": [ | |
| "charge_automatically", | |
| "send_invoice" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Invoice.CustomField": { | |
| "properties": { | |
| "name": { | |
| "description": "The name of the custom field.", | |
| "type": "string" | |
| }, | |
| "value": { | |
| "description": "The value of the custom field.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Invoice.CustomerShipping": { | |
| "properties": { | |
| "address": { | |
| "$ref": "#/definitions/Stripe.Address" | |
| }, | |
| "carrier": { | |
| "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "description": "Recipient name.", | |
| "type": "string" | |
| }, | |
| "phone": { | |
| "description": "Recipient phone (including extension).", | |
| "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.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Invoice.CustomerTaxId": { | |
| "properties": { | |
| "type": { | |
| "$ref": "#/definitions/Stripe.Invoice.CustomerTaxId.Type", | |
| "description": "The type of the tax ID, one of `eu_vat`, `br_cnpj`, `br_cpf`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, or `unknown`" | |
| }, | |
| "value": { | |
| "description": "The value of the tax ID.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Invoice.CustomerTaxId.Type": { | |
| "enum": [ | |
| "ae_trn", | |
| "au_abn", | |
| "au_arn", | |
| "br_cnpj", | |
| "br_cpf", | |
| "ca_bn", | |
| "ca_gst_hst", | |
| "ca_pst_bc", | |
| "ca_pst_mb", | |
| "ca_pst_sk", | |
| "ca_qst", | |
| "ch_vat", | |
| "cl_tin", | |
| "es_cif", | |
| "eu_vat", | |
| "gb_vat", | |
| "hk_br", | |
| "id_npwp", | |
| "il_vat", | |
| "in_gst", | |
| "jp_cn", | |
| "jp_rn", | |
| "kr_brn", | |
| "li_uid", | |
| "mx_rfc", | |
| "my_frp", | |
| "my_itn", | |
| "my_sst", | |
| "no_vat", | |
| "nz_gst", | |
| "ru_inn", | |
| "ru_kpp", | |
| "sa_vat", | |
| "sg_gst", | |
| "sg_uen", | |
| "th_vat", | |
| "tw_vat", | |
| "unknown", | |
| "us_ein", | |
| "za_vat" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Invoice.LastFinalizationError": { | |
| "properties": { | |
| "charge": { | |
| "description": "For card errors, the ID of the failed charge.", | |
| "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.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "doc_url": { | |
| "description": "A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.", | |
| "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.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "payment_intent": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent", | |
| "description": "A PaymentIntent guides you through the process of collecting a payment from your customer.\nWe recommend that you create exactly one PaymentIntent for each order or\ncustomer session in your system. You can reference the PaymentIntent later to\nsee the history of payment attempts for a particular session.\n\nA PaymentIntent transitions through\n[multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)\nthroughout its lifetime as it interfaces with Stripe.js to perform\nauthentication flows and ultimately creates at most one successful charge.\n\nRelated guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents)." | |
| }, | |
| "payment_method": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod", | |
| "description": "PaymentMethod objects represent your customer's payment instruments.\nThey can be used with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or saved to\nCustomer objects to store instrument details for future payments.\n\nRelated guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios)." | |
| }, | |
| "payment_method_type": { | |
| "description": "If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.", | |
| "type": "string" | |
| }, | |
| "setup_intent": { | |
| "$ref": "#/definitions/Stripe.SetupIntent", | |
| "description": "A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.\nFor example, you could use a SetupIntent to set up and save your customer's card without immediately collecting a payment.\nLater, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow.\n\nCreate a SetupIntent as soon as you're ready to collect your customer's payment credentials.\nDo not maintain long-lived, unconfirmed SetupIntents as they may no longer be valid.\nThe SetupIntent then transitions through multiple [statuses](https://stripe.com/docs/payments/intents#intent-statuses) as it guides\nyou through the setup process.\n\nSuccessful SetupIntents result in payment credentials that are optimized for future payments.\nFor example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) may need to be run through\n[Strong Customer Authentication](https://stripe.com/docs/strong-customer-authentication) at the time of payment method collection\nin order to streamline later [off-session payments](https://stripe.com/docs/payments/setup-intents).\nIf the SetupIntent is used with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer), upon success,\nit will automatically attach the resulting payment method to that Customer.\nWe recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on\nPaymentIntents to save payment methods in order to prevent saving invalid or unoptimized payment methods.\n\nBy using SetupIntents, you ensure that your customers experience the minimum set of required friction,\neven as regulations change over time.\n\nRelated guide: [Setup Intents API](https://stripe.com/docs/payments/setup-intents)." | |
| }, | |
| "source": { | |
| "anyOf": [ | |
| { | |
| "description": "The resulting source of [a Connect platform debiting a connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account).", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "object": { | |
| "enum": [ | |
| "account" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.AlipayAccount" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.BankAccount" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.BitcoinReceiver" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Card" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Source" | |
| } | |
| ] | |
| }, | |
| "type": { | |
| "$ref": "#/definitions/Stripe.Invoice.LastFinalizationError.Type", | |
| "description": "The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Invoice.LastFinalizationError.Type": { | |
| "enum": [ | |
| "api_error", | |
| "card_error", | |
| "idempotency_error", | |
| "invalid_request_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Invoice.PaymentSettings": { | |
| "properties": { | |
| "payment_method_options": { | |
| "$ref": "#/definitions/Stripe.Invoice.PaymentSettings.PaymentMethodOptions", | |
| "description": "Payment-method-specific configuration to provide to the invoice's PaymentIntent." | |
| }, | |
| "payment_method_types": { | |
| "description": "The list of payment method types (e.g. card) to provide to the invoice's PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice's default payment method, the subscription's default payment method, the customer's default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).", | |
| "items": { | |
| "enum": [ | |
| "ach_credit_transfer", | |
| "ach_debit", | |
| "au_becs_debit", | |
| "bacs_debit", | |
| "bancontact", | |
| "boleto", | |
| "card", | |
| "fpx", | |
| "giropay", | |
| "ideal", | |
| "sepa_credit_transfer", | |
| "sepa_debit", | |
| "sofort", | |
| "wechat_pay" | |
| ], | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Invoice.PaymentSettings.PaymentMethodOptions": { | |
| "properties": { | |
| "bancontact": { | |
| "$ref": "#/definitions/Stripe.Invoice.PaymentSettings.PaymentMethodOptions.Bancontact", | |
| "description": "If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent." | |
| }, | |
| "card": { | |
| "$ref": "#/definitions/Stripe.Invoice.PaymentSettings.PaymentMethodOptions.Card", | |
| "description": "If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Invoice.PaymentSettings.PaymentMethodOptions.Bancontact": { | |
| "properties": { | |
| "preferred_language": { | |
| "$ref": "#/definitions/Stripe.Invoice.PaymentSettings.PaymentMethodOptions.Bancontact.PreferredLanguage", | |
| "description": "Preferred language of the Bancontact authorization page that the customer is redirected to." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Invoice.PaymentSettings.PaymentMethodOptions.Bancontact.PreferredLanguage": { | |
| "enum": [ | |
| "de", | |
| "en", | |
| "fr", | |
| "nl" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Invoice.PaymentSettings.PaymentMethodOptions.Card": { | |
| "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. 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" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Invoice.StatusTransitions": { | |
| "properties": { | |
| "finalized_at": { | |
| "description": "The time that the invoice draft was finalized.", | |
| "type": "number" | |
| }, | |
| "marked_uncollectible_at": { | |
| "description": "The time that the invoice was marked uncollectible.", | |
| "type": "number" | |
| }, | |
| "paid_at": { | |
| "description": "The time that the invoice was paid.", | |
| "type": "number" | |
| }, | |
| "voided_at": { | |
| "description": "The time that the invoice was voided.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Invoice.ThresholdReason": { | |
| "properties": { | |
| "amount_gte": { | |
| "description": "The total invoice amount threshold boundary if it triggered the threshold invoice.", | |
| "type": "number" | |
| }, | |
| "item_reasons": { | |
| "description": "Indicates which line items triggered a threshold invoice.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.Invoice.ThresholdReason.ItemReason" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Invoice.ThresholdReason.ItemReason": { | |
| "properties": { | |
| "line_item_ids": { | |
| "description": "The IDs of the line items that triggered the threshold invoice.", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "usage_gte": { | |
| "description": "The quantity threshold boundary that applied to the given line item.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Invoice.TotalDiscountAmount": { | |
| "properties": { | |
| "amount": { | |
| "description": "The amount, in %s, of the discount.", | |
| "type": "number" | |
| }, | |
| "discount": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Discount" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedDiscount" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The discount that was applied to get this discount amount." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Invoice.TotalTaxAmount": { | |
| "properties": { | |
| "amount": { | |
| "description": "The amount, in %s, of the tax.", | |
| "type": "number" | |
| }, | |
| "inclusive": { | |
| "description": "Whether this tax amount is inclusive or exclusive.", | |
| "type": "boolean" | |
| }, | |
| "tax_rate": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.TaxRate" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The tax rate that was applied to get this tax amount." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Invoice.TransferData": { | |
| "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.", | |
| "type": "number" | |
| }, | |
| "destination": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Account" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The account where funds from the payment will be transferred to upon payment success." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.InvoiceItemsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.InvoiceLineItem": { | |
| "description": "The InvoiceLineItem object.", | |
| "properties": { | |
| "amount": { | |
| "description": "The amount, in %s.", | |
| "type": "number" | |
| }, | |
| "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.", | |
| "type": "string" | |
| }, | |
| "discount_amounts": { | |
| "description": "The amount of discount calculated per discount for this line item.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.InvoiceLineItem.DiscountAmount" | |
| }, | |
| "type": "array" | |
| }, | |
| "discountable": { | |
| "description": "If true, discounts will apply to this line item. Always false for prorations.", | |
| "type": "boolean" | |
| }, | |
| "discounts": { | |
| "description": "The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.", | |
| "items": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Discount" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ] | |
| }, | |
| "type": "array" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "invoice_item": { | |
| "description": "The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems) associated with this line item if any.", | |
| "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": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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." | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "line_item" | |
| ], | |
| "type": "string" | |
| }, | |
| "period": { | |
| "$ref": "#/definitions/Stripe.InvoiceLineItem.Period" | |
| }, | |
| "plan": { | |
| "$ref": "#/definitions/Stripe.Plan", | |
| "description": "The plan of the subscription, if the line item is a subscription or a proration." | |
| }, | |
| "price": { | |
| "$ref": "#/definitions/Stripe.Price", | |
| "description": "The price of the line item." | |
| }, | |
| "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.", | |
| "type": "number" | |
| }, | |
| "subscription": { | |
| "description": "The subscription that the invoice item pertains to, if any.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "tax_amounts": { | |
| "description": "The amount of tax calculated per tax rate for this line item", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.InvoiceLineItem.TaxAmount" | |
| }, | |
| "type": "array" | |
| }, | |
| "tax_rates": { | |
| "description": "The tax rates which apply to the line item.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.TaxRate" | |
| }, | |
| "type": "array" | |
| }, | |
| "type": { | |
| "$ref": "#/definitions/Stripe.InvoiceLineItem.Type", | |
| "description": "A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.InvoiceLineItem.DiscountAmount": { | |
| "properties": { | |
| "amount": { | |
| "description": "The amount, in %s, of the discount.", | |
| "type": "number" | |
| }, | |
| "discount": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Discount" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedDiscount" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The discount that was applied to get this discount amount." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.InvoiceLineItem.Period": { | |
| "properties": { | |
| "end": { | |
| "description": "End of the line item's billing period", | |
| "type": "number" | |
| }, | |
| "start": { | |
| "description": "Start of the line item's billing period", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.InvoiceLineItem.TaxAmount": { | |
| "properties": { | |
| "amount": { | |
| "description": "The amount, in %s, of the tax.", | |
| "type": "number" | |
| }, | |
| "inclusive": { | |
| "description": "Whether this tax amount is inclusive or exclusive.", | |
| "type": "boolean" | |
| }, | |
| "tax_rate": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.TaxRate" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The tax rate that was applied to get this tax amount." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.InvoiceLineItem.Type": { | |
| "enum": [ | |
| "invoiceitem", | |
| "subscription" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.InvoicesResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.IssuerFraudRecordsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Authorization": { | |
| "description": "The Authorization object.", | |
| "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": "number" | |
| }, | |
| "amount_details": { | |
| "$ref": "#/definitions/Stripe.Issuing.Authorization.AmountDetails", | |
| "description": "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)." | |
| }, | |
| "approved": { | |
| "description": "Whether the authorization has been approved.", | |
| "type": "boolean" | |
| }, | |
| "authorization_method": { | |
| "$ref": "#/definitions/Stripe.Issuing.Authorization.AuthorizationMethod", | |
| "description": "How the card details were provided." | |
| }, | |
| "balance_transactions": { | |
| "description": "List of balance transactions associated with this authorization.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.BalanceTransaction" | |
| }, | |
| "type": "array" | |
| }, | |
| "card": { | |
| "$ref": "#/definitions/Stripe.Issuing.Card", | |
| "description": "You can [create physical or virtual cards](https://stripe.com/docs/issuing/cards) that are issued to cardholders." | |
| }, | |
| "cardholder": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Issuing.Cardholder" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The cardholder to whom this authorization belongs." | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "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.", | |
| "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": "number" | |
| }, | |
| "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": "#/definitions/Stripe.Issuing.Authorization.MerchantData" | |
| }, | |
| "metadata": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "issuing.authorization" | |
| ], | |
| "type": "string" | |
| }, | |
| "pending_request": { | |
| "$ref": "#/definitions/Stripe.Issuing.Authorization.PendingRequest", | |
| "description": "The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook." | |
| }, | |
| "request_history": { | |
| "description": "History of every time `pending_request` was approved/denied, either by you directly or by Stripe (e.g. based on your `spending_controls`). If the merchant changes the authorization by performing an [incremental authorization](https://stripe.com/docs/issuing/purchases/authorizations), you can look at this field to see the previous requests for the authorization.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.Issuing.Authorization.RequestHistory" | |
| }, | |
| "type": "array" | |
| }, | |
| "status": { | |
| "$ref": "#/definitions/Stripe.Issuing.Authorization.Status", | |
| "description": "The current status of the authorization in its lifecycle." | |
| }, | |
| "transactions": { | |
| "description": "List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.Issuing.Transaction" | |
| }, | |
| "type": "array" | |
| }, | |
| "verification_data": { | |
| "$ref": "#/definitions/Stripe.Issuing.Authorization.VerificationData" | |
| }, | |
| "wallet": { | |
| "description": "The digital wallet used for this authorization. One of `apple_pay`, `google_pay`, or `samsung_pay`.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Authorization.AmountDetails": { | |
| "properties": { | |
| "atm_fee": { | |
| "description": "The fee charged by the ATM for the cash withdrawal.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Authorization.AuthorizationMethod": { | |
| "enum": [ | |
| "chip", | |
| "contactless", | |
| "keyed_in", | |
| "online", | |
| "swipe" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Issuing.Authorization.MerchantData": { | |
| "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.", | |
| "type": "string" | |
| }, | |
| "category_code": { | |
| "description": "The merchant category code for the seller's business", | |
| "type": "string" | |
| }, | |
| "city": { | |
| "description": "City where the seller is located", | |
| "type": "string" | |
| }, | |
| "country": { | |
| "description": "Country where the seller is located", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "description": "Name of the seller", | |
| "type": "string" | |
| }, | |
| "network_id": { | |
| "description": "Identifier assigned to the seller by the card brand", | |
| "type": "string" | |
| }, | |
| "postal_code": { | |
| "description": "Postal code where the seller is located", | |
| "type": "string" | |
| }, | |
| "state": { | |
| "description": "State where the seller is located", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Authorization.PendingRequest": { | |
| "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": "number" | |
| }, | |
| "amount_details": { | |
| "$ref": "#/definitions/Stripe.Issuing.Authorization.PendingRequest.AmountDetails", | |
| "description": "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)." | |
| }, | |
| "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": "number" | |
| }, | |
| "merchant_currency": { | |
| "description": "The local currency the merchant is requesting to authorize.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Authorization.PendingRequest.AmountDetails": { | |
| "properties": { | |
| "atm_fee": { | |
| "description": "The fee charged by the ATM for the cash withdrawal.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Authorization.RequestHistory": { | |
| "properties": { | |
| "amount": { | |
| "description": "The `pending_request.amount` at the time of the request, presented 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": "number" | |
| }, | |
| "amount_details": { | |
| "$ref": "#/definitions/Stripe.Issuing.Authorization.RequestHistory.AmountDetails", | |
| "description": "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)." | |
| }, | |
| "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.", | |
| "type": "number" | |
| }, | |
| "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" | |
| }, | |
| "merchant_amount": { | |
| "description": "The `pending_request.merchant_amount` at the time of the request, presented in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).", | |
| "type": "number" | |
| }, | |
| "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).", | |
| "type": "string" | |
| }, | |
| "reason": { | |
| "$ref": "#/definitions/Stripe.Issuing.Authorization.RequestHistory.Reason", | |
| "description": "The reason for the approval or decline." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Authorization.RequestHistory.AmountDetails": { | |
| "properties": { | |
| "atm_fee": { | |
| "description": "The fee charged by the ATM for the cash withdrawal.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Authorization.RequestHistory.Reason": { | |
| "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" | |
| }, | |
| "Stripe.Issuing.Authorization.Status": { | |
| "enum": [ | |
| "closed", | |
| "pending", | |
| "reversed" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Issuing.Authorization.VerificationData": { | |
| "properties": { | |
| "address_line1_check": { | |
| "$ref": "#/definitions/Stripe.Issuing.Authorization.VerificationData.AddressLine1Check", | |
| "description": "Whether the cardholder provided an address first line and if it matched the cardholder's `billing.address.line1`." | |
| }, | |
| "address_postal_code_check": { | |
| "$ref": "#/definitions/Stripe.Issuing.Authorization.VerificationData.AddressPostalCodeCheck", | |
| "description": "Whether the cardholder provided a postal code and if it matched the cardholder's `billing.address.postal_code`." | |
| }, | |
| "cvc_check": { | |
| "$ref": "#/definitions/Stripe.Issuing.Authorization.VerificationData.CvcCheck", | |
| "description": "Whether the cardholder provided a CVC and if it matched Stripe's record." | |
| }, | |
| "expiry_check": { | |
| "$ref": "#/definitions/Stripe.Issuing.Authorization.VerificationData.ExpiryCheck", | |
| "description": "Whether the cardholder provided an expiry date and if it matched Stripe's record." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Authorization.VerificationData.AddressLine1Check": { | |
| "enum": [ | |
| "match", | |
| "mismatch", | |
| "not_provided" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Issuing.Authorization.VerificationData.AddressPostalCodeCheck": { | |
| "enum": [ | |
| "match", | |
| "mismatch", | |
| "not_provided" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Issuing.Authorization.VerificationData.CvcCheck": { | |
| "enum": [ | |
| "match", | |
| "mismatch", | |
| "not_provided" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Issuing.Authorization.VerificationData.ExpiryCheck": { | |
| "enum": [ | |
| "match", | |
| "mismatch", | |
| "not_provided" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Issuing.AuthorizationsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Card": { | |
| "description": "The Card object.", | |
| "properties": { | |
| "brand": { | |
| "description": "The brand of the card.", | |
| "type": "string" | |
| }, | |
| "cancellation_reason": { | |
| "description": "The reason why the card was canceled.", | |
| "enum": [ | |
| "lost", | |
| "stolen" | |
| ], | |
| "type": "string" | |
| }, | |
| "cardholder": { | |
| "$ref": "#/definitions/Stripe.Issuing.Cardholder", | |
| "description": "An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/docs/issuing) cards.\n\nRelated guide: [How to create a Cardholder](https://stripe.com/docs/issuing/cards#create-cardholder)" | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "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.", | |
| "type": "string" | |
| }, | |
| "exp_month": { | |
| "description": "The expiration month of the card.", | |
| "type": "number" | |
| }, | |
| "exp_year": { | |
| "description": "The expiration year of the card.", | |
| "type": "number" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "last4": { | |
| "description": "The last 4 digits of the card number.", | |
| "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": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "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.", | |
| "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": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Issuing.Card" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The latest card that replaces this card, if any." | |
| }, | |
| "replacement_for": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Issuing.Card" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The card this card replaces, if any." | |
| }, | |
| "replacement_reason": { | |
| "description": "The reason why the previous card needed to be replaced.", | |
| "enum": [ | |
| "damaged", | |
| "expired", | |
| "lost", | |
| "stolen" | |
| ], | |
| "type": "string" | |
| }, | |
| "shipping": { | |
| "$ref": "#/definitions/Stripe.Issuing.Card.Shipping", | |
| "description": "Where and how the card will be shipped." | |
| }, | |
| "spending_controls": { | |
| "$ref": "#/definitions/Stripe.Issuing.Card.SpendingControls" | |
| }, | |
| "status": { | |
| "$ref": "#/definitions/Stripe.Issuing.Card.Status", | |
| "description": "Whether authorizations can be approved on this card." | |
| }, | |
| "type": { | |
| "$ref": "#/definitions/Stripe.Issuing.Card.Type", | |
| "description": "The type of the card." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Card.Shipping": { | |
| "properties": { | |
| "address": { | |
| "$ref": "#/definitions/Stripe.Address" | |
| }, | |
| "carrier": { | |
| "description": "The delivery company that shipped a card.", | |
| "enum": [ | |
| "dhl", | |
| "fedex", | |
| "royal_mail", | |
| "usps" | |
| ], | |
| "type": "string" | |
| }, | |
| "eta": { | |
| "description": "A unix timestamp representing a best estimate of when the card will be delivered.", | |
| "type": "number" | |
| }, | |
| "name": { | |
| "description": "Recipient name.", | |
| "type": "string" | |
| }, | |
| "service": { | |
| "$ref": "#/definitions/Stripe.Issuing.Card.Shipping.Service", | |
| "description": "Shipment service, such as `standard` or `express`." | |
| }, | |
| "status": { | |
| "description": "The delivery status of the card.", | |
| "enum": [ | |
| "canceled", | |
| "delivered", | |
| "failure", | |
| "pending", | |
| "returned", | |
| "shipped" | |
| ], | |
| "type": "string" | |
| }, | |
| "tracking_number": { | |
| "description": "A tracking number for a card shipment.", | |
| "type": "string" | |
| }, | |
| "tracking_url": { | |
| "description": "A link to the shipping carrier's site where you can view detailed information about a card shipment.", | |
| "type": "string" | |
| }, | |
| "type": { | |
| "$ref": "#/definitions/Stripe.Issuing.Card.Shipping.Type", | |
| "description": "Packaging options." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Card.Shipping.Service": { | |
| "enum": [ | |
| "express", | |
| "priority", | |
| "standard" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Issuing.Card.Shipping.Type": { | |
| "enum": [ | |
| "bulk", | |
| "individual" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Issuing.Card.SpendingControls": { | |
| "properties": { | |
| "allowed_categories": { | |
| "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.", | |
| "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" | |
| }, | |
| "type": "array" | |
| }, | |
| "blocked_categories": { | |
| "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.", | |
| "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" | |
| }, | |
| "type": "array" | |
| }, | |
| "spending_limits": { | |
| "description": "Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain).", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.Issuing.Card.SpendingControls.SpendingLimit" | |
| }, | |
| "type": "array" | |
| }, | |
| "spending_limits_currency": { | |
| "description": "Currency of the amounts within `spending_limits`. Always the same as the currency of the card.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Card.SpendingControls.SpendingLimit": { | |
| "properties": { | |
| "amount": { | |
| "description": "Maximum amount allowed to spend per interval.", | |
| "type": "number" | |
| }, | |
| "categories": { | |
| "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.", | |
| "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" | |
| }, | |
| "type": "array" | |
| }, | |
| "interval": { | |
| "$ref": "#/definitions/Stripe.Issuing.Card.SpendingControls.SpendingLimit.Interval", | |
| "description": "Interval (or event) to which the amount applies." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Card.SpendingControls.SpendingLimit.Interval": { | |
| "enum": [ | |
| "all_time", | |
| "daily", | |
| "monthly", | |
| "per_authorization", | |
| "weekly", | |
| "yearly" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Issuing.Card.Status": { | |
| "enum": [ | |
| "active", | |
| "canceled", | |
| "inactive" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Issuing.Card.Type": { | |
| "enum": [ | |
| "physical", | |
| "virtual" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Issuing.Cardholder": { | |
| "description": "The Cardholder object.", | |
| "properties": { | |
| "billing": { | |
| "$ref": "#/definitions/Stripe.Issuing.Cardholder.Billing" | |
| }, | |
| "company": { | |
| "$ref": "#/definitions/Stripe.Issuing.Cardholder.Company", | |
| "description": "Additional information about a `company` cardholder." | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "email": { | |
| "description": "The cardholder's email address.", | |
| "type": "string" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "individual": { | |
| "$ref": "#/definitions/Stripe.Issuing.Cardholder.Individual", | |
| "description": "Additional information about an `individual` cardholder." | |
| }, | |
| "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": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "name": { | |
| "description": "The cardholder's name. This will be printed on cards issued to them.", | |
| "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. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details.", | |
| "type": "string" | |
| }, | |
| "requirements": { | |
| "$ref": "#/definitions/Stripe.Issuing.Cardholder.Requirements" | |
| }, | |
| "spending_controls": { | |
| "$ref": "#/definitions/Stripe.Issuing.Cardholder.SpendingControls", | |
| "description": "Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details." | |
| }, | |
| "status": { | |
| "$ref": "#/definitions/Stripe.Issuing.Cardholder.Status", | |
| "description": "Specifies whether to permit authorizations on this cardholder's cards." | |
| }, | |
| "type": { | |
| "$ref": "#/definitions/Stripe.Issuing.Cardholder.Type", | |
| "description": "One of `individual` or `company`." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Cardholder.Billing": { | |
| "properties": { | |
| "address": { | |
| "$ref": "#/definitions/Stripe.Address" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Cardholder.Company": { | |
| "properties": { | |
| "tax_id_provided": { | |
| "description": "Whether the company's business ID number was provided.", | |
| "type": "boolean" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Cardholder.Individual": { | |
| "properties": { | |
| "dob": { | |
| "$ref": "#/definitions/Stripe.Issuing.Cardholder.Individual.Dob", | |
| "description": "The date of birth of this cardholder." | |
| }, | |
| "first_name": { | |
| "description": "The first name of this cardholder.", | |
| "type": "string" | |
| }, | |
| "last_name": { | |
| "description": "The last name of this cardholder.", | |
| "type": "string" | |
| }, | |
| "verification": { | |
| "$ref": "#/definitions/Stripe.Issuing.Cardholder.Individual.Verification", | |
| "description": "Government-issued ID document for this cardholder." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Cardholder.Individual.Dob": { | |
| "properties": { | |
| "day": { | |
| "description": "The day of birth, between 1 and 31.", | |
| "type": "number" | |
| }, | |
| "month": { | |
| "description": "The month of birth, between 1 and 12.", | |
| "type": "number" | |
| }, | |
| "year": { | |
| "description": "The four-digit year of birth.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Cardholder.Individual.Verification": { | |
| "properties": { | |
| "document": { | |
| "$ref": "#/definitions/Stripe.Issuing.Cardholder.Individual.Verification.Document", | |
| "description": "An identifying document, either a passport or local ID card." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Cardholder.Individual.Verification.Document": { | |
| "properties": { | |
| "back": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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`." | |
| }, | |
| "front": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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`." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Cardholder.Requirements": { | |
| "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" | |
| ], | |
| "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" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Cardholder.SpendingControls": { | |
| "properties": { | |
| "allowed_categories": { | |
| "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.", | |
| "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" | |
| }, | |
| "type": "array" | |
| }, | |
| "blocked_categories": { | |
| "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.", | |
| "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" | |
| }, | |
| "type": "array" | |
| }, | |
| "spending_limits": { | |
| "description": "Limit spending with amount-based rules that apply across this cardholder's cards.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.Issuing.Cardholder.SpendingControls.SpendingLimit" | |
| }, | |
| "type": "array" | |
| }, | |
| "spending_limits_currency": { | |
| "description": "Currency of the amounts within `spending_limits`.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Cardholder.SpendingControls.SpendingLimit": { | |
| "properties": { | |
| "amount": { | |
| "description": "Maximum amount allowed to spend per interval.", | |
| "type": "number" | |
| }, | |
| "categories": { | |
| "description": "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.", | |
| "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" | |
| }, | |
| "type": "array" | |
| }, | |
| "interval": { | |
| "$ref": "#/definitions/Stripe.Issuing.Cardholder.SpendingControls.SpendingLimit.Interval", | |
| "description": "Interval (or event) to which the amount applies." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Cardholder.SpendingControls.SpendingLimit.Interval": { | |
| "enum": [ | |
| "all_time", | |
| "daily", | |
| "monthly", | |
| "per_authorization", | |
| "weekly", | |
| "yearly" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Issuing.Cardholder.Status": { | |
| "enum": [ | |
| "active", | |
| "blocked", | |
| "inactive" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Issuing.Cardholder.Type": { | |
| "enum": [ | |
| "company", | |
| "individual" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Issuing.CardholdersResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.CardsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Dispute": { | |
| "description": "The Dispute object.", | |
| "properties": { | |
| "amount": { | |
| "description": "Disputed amount. Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation).", | |
| "type": "number" | |
| }, | |
| "balance_transactions": { | |
| "description": "List of balance transactions associated with the dispute.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.BalanceTransaction" | |
| }, | |
| "type": "array" | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "currency": { | |
| "description": "The currency the `transaction` was made in.", | |
| "type": "string" | |
| }, | |
| "evidence": { | |
| "$ref": "#/definitions/Stripe.Issuing.Dispute.Evidence" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "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": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "issuing.dispute" | |
| ], | |
| "type": "string" | |
| }, | |
| "status": { | |
| "$ref": "#/definitions/Stripe.Issuing.Dispute.Status", | |
| "description": "Current status of the dispute." | |
| }, | |
| "transaction": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Issuing.Transaction" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The transaction being disputed." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Dispute.Evidence": { | |
| "properties": { | |
| "canceled": { | |
| "$ref": "#/definitions/Stripe.Issuing.Dispute.Evidence.Canceled" | |
| }, | |
| "duplicate": { | |
| "$ref": "#/definitions/Stripe.Issuing.Dispute.Evidence.Duplicate" | |
| }, | |
| "fraudulent": { | |
| "$ref": "#/definitions/Stripe.Issuing.Dispute.Evidence.Fraudulent" | |
| }, | |
| "merchandise_not_as_described": { | |
| "$ref": "#/definitions/Stripe.Issuing.Dispute.Evidence.MerchandiseNotAsDescribed" | |
| }, | |
| "not_received": { | |
| "$ref": "#/definitions/Stripe.Issuing.Dispute.Evidence.NotReceived" | |
| }, | |
| "other": { | |
| "$ref": "#/definitions/Stripe.Issuing.Dispute.Evidence.Other" | |
| }, | |
| "reason": { | |
| "$ref": "#/definitions/Stripe.Issuing.Dispute.Evidence.Reason", | |
| "description": "The reason for filing the dispute. Its value will match the field containing the evidence." | |
| }, | |
| "service_not_as_described": { | |
| "$ref": "#/definitions/Stripe.Issuing.Dispute.Evidence.ServiceNotAsDescribed" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Dispute.Evidence.Canceled": { | |
| "properties": { | |
| "additional_documentation": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." | |
| }, | |
| "canceled_at": { | |
| "description": "Date when order was canceled.", | |
| "type": "number" | |
| }, | |
| "cancellation_policy_provided": { | |
| "description": "Whether the cardholder was provided with a cancellation policy.", | |
| "type": "boolean" | |
| }, | |
| "cancellation_reason": { | |
| "description": "Reason for canceling the order.", | |
| "type": "string" | |
| }, | |
| "expected_at": { | |
| "description": "Date when the cardholder expected to receive the product.", | |
| "type": "number" | |
| }, | |
| "explanation": { | |
| "description": "Explanation of why the cardholder is disputing this transaction.", | |
| "type": "string" | |
| }, | |
| "product_description": { | |
| "description": "Description of the merchandise or service that was purchased.", | |
| "type": "string" | |
| }, | |
| "product_type": { | |
| "description": "Whether the product was a merchandise or service.", | |
| "enum": [ | |
| "merchandise", | |
| "service" | |
| ], | |
| "type": "string" | |
| }, | |
| "return_status": { | |
| "description": "Result of cardholder's attempt to return the product.", | |
| "enum": [ | |
| "merchant_rejected", | |
| "successful" | |
| ], | |
| "type": "string" | |
| }, | |
| "returned_at": { | |
| "description": "Date when the product was returned or attempted to be returned.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Dispute.Evidence.Duplicate": { | |
| "properties": { | |
| "additional_documentation": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." | |
| }, | |
| "card_statement": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for." | |
| }, | |
| "cash_receipt": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash." | |
| }, | |
| "check_image": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product." | |
| }, | |
| "explanation": { | |
| "description": "Explanation of why the cardholder is disputing this transaction.", | |
| "type": "string" | |
| }, | |
| "original_transaction": { | |
| "description": "Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Dispute.Evidence.Fraudulent": { | |
| "properties": { | |
| "additional_documentation": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." | |
| }, | |
| "explanation": { | |
| "description": "Explanation of why the cardholder is disputing this transaction.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Dispute.Evidence.MerchandiseNotAsDescribed": { | |
| "properties": { | |
| "additional_documentation": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." | |
| }, | |
| "explanation": { | |
| "description": "Explanation of why the cardholder is disputing this transaction.", | |
| "type": "string" | |
| }, | |
| "received_at": { | |
| "description": "Date when the product was received.", | |
| "type": "number" | |
| }, | |
| "return_description": { | |
| "description": "Description of the cardholder's attempt to return the product.", | |
| "type": "string" | |
| }, | |
| "return_status": { | |
| "description": "Result of cardholder's attempt to return the product.", | |
| "enum": [ | |
| "merchant_rejected", | |
| "successful" | |
| ], | |
| "type": "string" | |
| }, | |
| "returned_at": { | |
| "description": "Date when the product was returned or attempted to be returned.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Dispute.Evidence.NotReceived": { | |
| "properties": { | |
| "additional_documentation": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." | |
| }, | |
| "expected_at": { | |
| "description": "Date when the cardholder expected to receive the product.", | |
| "type": "number" | |
| }, | |
| "explanation": { | |
| "description": "Explanation of why the cardholder is disputing this transaction.", | |
| "type": "string" | |
| }, | |
| "product_description": { | |
| "description": "Description of the merchandise or service that was purchased.", | |
| "type": "string" | |
| }, | |
| "product_type": { | |
| "description": "Whether the product was a merchandise or service.", | |
| "enum": [ | |
| "merchandise", | |
| "service" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Dispute.Evidence.Other": { | |
| "properties": { | |
| "additional_documentation": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." | |
| }, | |
| "explanation": { | |
| "description": "Explanation of why the cardholder is disputing this transaction.", | |
| "type": "string" | |
| }, | |
| "product_description": { | |
| "description": "Description of the merchandise or service that was purchased.", | |
| "type": "string" | |
| }, | |
| "product_type": { | |
| "description": "Whether the product was a merchandise or service.", | |
| "enum": [ | |
| "merchandise", | |
| "service" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Dispute.Evidence.Reason": { | |
| "enum": [ | |
| "canceled", | |
| "duplicate", | |
| "fraudulent", | |
| "merchandise_not_as_described", | |
| "not_received", | |
| "other", | |
| "service_not_as_described" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Issuing.Dispute.Evidence.ServiceNotAsDescribed": { | |
| "properties": { | |
| "additional_documentation": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute." | |
| }, | |
| "canceled_at": { | |
| "description": "Date when order was canceled.", | |
| "type": "number" | |
| }, | |
| "cancellation_reason": { | |
| "description": "Reason for canceling the order.", | |
| "type": "string" | |
| }, | |
| "explanation": { | |
| "description": "Explanation of why the cardholder is disputing this transaction.", | |
| "type": "string" | |
| }, | |
| "received_at": { | |
| "description": "Date when the product was received.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Dispute.Status": { | |
| "enum": [ | |
| "expired", | |
| "lost", | |
| "submitted", | |
| "unsubmitted", | |
| "won" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Issuing.DisputesResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Transaction": { | |
| "description": "The Transaction object.", | |
| "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": "number" | |
| }, | |
| "amount_details": { | |
| "$ref": "#/definitions/Stripe.Issuing.Transaction.AmountDetails", | |
| "description": "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)." | |
| }, | |
| "authorization": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Issuing.Authorization" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The `Authorization` object that led to this transaction." | |
| }, | |
| "balance_transaction": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.BalanceTransaction" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this transaction." | |
| }, | |
| "card": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Issuing.Card" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The card used to make this transaction." | |
| }, | |
| "cardholder": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Issuing.Cardholder" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The cardholder to whom this transaction belongs." | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "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" | |
| }, | |
| "dispute": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Issuing.Dispute" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "If you've disputed the transaction, the ID of the dispute." | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "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": "number" | |
| }, | |
| "merchant_currency": { | |
| "description": "The currency with which the merchant is taking payment.", | |
| "type": "string" | |
| }, | |
| "merchant_data": { | |
| "$ref": "#/definitions/Stripe.Issuing.Transaction.MerchantData" | |
| }, | |
| "metadata": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "issuing.transaction" | |
| ], | |
| "type": "string" | |
| }, | |
| "purchase_details": { | |
| "$ref": "#/definitions/Stripe.Issuing.Transaction.PurchaseDetails", | |
| "description": "Additional purchase information that is optionally provided by the merchant." | |
| }, | |
| "type": { | |
| "$ref": "#/definitions/Stripe.Issuing.Transaction.Type", | |
| "description": "The nature of the transaction." | |
| }, | |
| "wallet": { | |
| "description": "The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`.", | |
| "enum": [ | |
| "apple_pay", | |
| "google_pay", | |
| "samsung_pay" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Transaction.AmountDetails": { | |
| "properties": { | |
| "atm_fee": { | |
| "description": "The fee charged by the ATM for the cash withdrawal.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Transaction.MerchantData": { | |
| "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.", | |
| "type": "string" | |
| }, | |
| "category_code": { | |
| "description": "The merchant category code for the seller's business", | |
| "type": "string" | |
| }, | |
| "city": { | |
| "description": "City where the seller is located", | |
| "type": "string" | |
| }, | |
| "country": { | |
| "description": "Country where the seller is located", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "description": "Name of the seller", | |
| "type": "string" | |
| }, | |
| "network_id": { | |
| "description": "Identifier assigned to the seller by the card brand", | |
| "type": "string" | |
| }, | |
| "postal_code": { | |
| "description": "Postal code where the seller is located", | |
| "type": "string" | |
| }, | |
| "state": { | |
| "description": "State where the seller is located", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Transaction.PurchaseDetails": { | |
| "properties": { | |
| "flight": { | |
| "$ref": "#/definitions/Stripe.Issuing.Transaction.PurchaseDetails.Flight", | |
| "description": "Information about the flight that was purchased with this transaction." | |
| }, | |
| "fuel": { | |
| "$ref": "#/definitions/Stripe.Issuing.Transaction.PurchaseDetails.Fuel", | |
| "description": "Information about fuel that was purchased with this transaction." | |
| }, | |
| "lodging": { | |
| "$ref": "#/definitions/Stripe.Issuing.Transaction.PurchaseDetails.Lodging", | |
| "description": "Information about lodging that was purchased with this transaction." | |
| }, | |
| "receipt": { | |
| "description": "The line items in the purchase.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.Issuing.Transaction.PurchaseDetails.Receipt" | |
| }, | |
| "type": "array" | |
| }, | |
| "reference": { | |
| "description": "A merchant-specific order number.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Transaction.PurchaseDetails.Flight": { | |
| "properties": { | |
| "departure_at": { | |
| "description": "The time that the flight departed.", | |
| "type": "number" | |
| }, | |
| "passenger_name": { | |
| "description": "The name of the passenger.", | |
| "type": "string" | |
| }, | |
| "refundable": { | |
| "description": "Whether the ticket is refundable.", | |
| "type": "boolean" | |
| }, | |
| "segments": { | |
| "description": "The legs of the trip.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.Issuing.Transaction.PurchaseDetails.Flight.Segment" | |
| }, | |
| "type": "array" | |
| }, | |
| "travel_agency": { | |
| "description": "The travel agency that issued the ticket.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Transaction.PurchaseDetails.Flight.Segment": { | |
| "properties": { | |
| "arrival_airport_code": { | |
| "description": "The three-letter IATA airport code of the flight's destination.", | |
| "type": "string" | |
| }, | |
| "carrier": { | |
| "description": "The airline carrier code.", | |
| "type": "string" | |
| }, | |
| "departure_airport_code": { | |
| "description": "The three-letter IATA airport code that the flight departed from.", | |
| "type": "string" | |
| }, | |
| "flight_number": { | |
| "description": "The flight number.", | |
| "type": "string" | |
| }, | |
| "service_class": { | |
| "description": "The flight's service class.", | |
| "type": "string" | |
| }, | |
| "stopover_allowed": { | |
| "description": "Whether a stopover is allowed on this flight.", | |
| "type": "boolean" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Transaction.PurchaseDetails.Fuel": { | |
| "properties": { | |
| "type": { | |
| "description": "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.", | |
| "type": "string" | |
| }, | |
| "unit": { | |
| "description": "The units for `volume_decimal`. One of `us_gallon` or `liter`.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "volume_decimal": { | |
| "description": "The volume of the fuel that was pumped, represented as a decimal string with at most 12 decimal places.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Transaction.PurchaseDetails.Lodging": { | |
| "properties": { | |
| "check_in_at": { | |
| "description": "The time of checking into the lodging.", | |
| "type": "number" | |
| }, | |
| "nights": { | |
| "description": "The number of nights stayed at the lodging.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Transaction.PurchaseDetails.Receipt": { | |
| "properties": { | |
| "description": { | |
| "description": "The description of the item. The maximum length of this field is 26 characters.", | |
| "type": "string" | |
| }, | |
| "quantity": { | |
| "description": "The quantity of the item.", | |
| "type": "number" | |
| }, | |
| "total": { | |
| "description": "The total for this line item in cents.", | |
| "type": "number" | |
| }, | |
| "unit_cost": { | |
| "description": "The unit cost of the item in cents.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Issuing.Transaction.Type": { | |
| "enum": [ | |
| "capture", | |
| "refund" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Issuing.TransactionsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.LineItem": { | |
| "description": "The LineItem object.", | |
| "properties": { | |
| "amount_subtotal": { | |
| "description": "Total before any discounts or taxes are applied.", | |
| "type": "number" | |
| }, | |
| "amount_total": { | |
| "description": "Total after discounts and taxes.", | |
| "type": "number" | |
| }, | |
| "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.", | |
| "type": "string" | |
| }, | |
| "discounts": { | |
| "description": "The discounts applied to the line item.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.LineItem.Discount" | |
| }, | |
| "type": "array" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "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": "#/definitions/Stripe.Price", | |
| "description": "The price used to generate the line item." | |
| }, | |
| "quantity": { | |
| "description": "The quantity of products being purchased.", | |
| "type": "number" | |
| }, | |
| "taxes": { | |
| "description": "The taxes applied to the line item.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.LineItem.Tax" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.LineItem.Discount": { | |
| "properties": { | |
| "amount": { | |
| "description": "The amount discounted.", | |
| "type": "number" | |
| }, | |
| "discount": { | |
| "$ref": "#/definitions/Stripe.Discount", | |
| "description": "A discount represents the actual application of a coupon to a particular\ncustomer. It contains information about when the discount began and when it\nwill end.\n\nRelated guide: [Applying Discounts to Subscriptions](https://stripe.com/docs/billing/subscriptions/discounts)." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.LineItem.Tax": { | |
| "properties": { | |
| "amount": { | |
| "description": "Amount of tax applied for this rate.", | |
| "type": "number" | |
| }, | |
| "rate": { | |
| "$ref": "#/definitions/Stripe.TaxRate", | |
| "description": "Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax.\n\nRelated guide: [Tax Rates](https://stripe.com/docs/billing/taxes/tax-rates)." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Mandate": { | |
| "description": "The Mandate object.", | |
| "properties": { | |
| "customer_acceptance": { | |
| "$ref": "#/definitions/Stripe.Mandate.CustomerAcceptance" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "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": "#/definitions/Stripe.Mandate.MultiUse" | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "mandate" | |
| ], | |
| "type": "string" | |
| }, | |
| "payment_method": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.PaymentMethod" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the payment method associated with this mandate." | |
| }, | |
| "payment_method_details": { | |
| "$ref": "#/definitions/Stripe.Mandate.PaymentMethodDetails" | |
| }, | |
| "single_use": { | |
| "$ref": "#/definitions/Stripe.Mandate.SingleUse" | |
| }, | |
| "status": { | |
| "$ref": "#/definitions/Stripe.Mandate.Status", | |
| "description": "The status of the mandate, which indicates whether it can be used to initiate a payment." | |
| }, | |
| "type": { | |
| "$ref": "#/definitions/Stripe.Mandate.Type", | |
| "description": "The type of the mandate." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Mandate.CustomerAcceptance": { | |
| "properties": { | |
| "accepted_at": { | |
| "description": "The time at which the customer accepted the Mandate.", | |
| "type": "number" | |
| }, | |
| "offline": { | |
| "$ref": "#/definitions/Stripe.Mandate.CustomerAcceptance.Offline" | |
| }, | |
| "online": { | |
| "$ref": "#/definitions/Stripe.Mandate.CustomerAcceptance.Online" | |
| }, | |
| "type": { | |
| "$ref": "#/definitions/Stripe.Mandate.CustomerAcceptance.Type", | |
| "description": "The type of customer acceptance information included with the Mandate. One of `online` or `offline`." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Mandate.CustomerAcceptance.Offline": { | |
| "type": "object" | |
| }, | |
| "Stripe.Mandate.CustomerAcceptance.Online": { | |
| "properties": { | |
| "ip_address": { | |
| "description": "The IP address from which the Mandate was accepted by the customer.", | |
| "type": "string" | |
| }, | |
| "user_agent": { | |
| "description": "The user agent of the browser from which the Mandate was accepted by the customer.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Mandate.CustomerAcceptance.Type": { | |
| "enum": [ | |
| "offline", | |
| "online" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Mandate.MultiUse": { | |
| "type": "object" | |
| }, | |
| "Stripe.Mandate.PaymentMethodDetails": { | |
| "properties": { | |
| "acss_debit": { | |
| "$ref": "#/definitions/Stripe.Mandate.PaymentMethodDetails.AcssDebit" | |
| }, | |
| "au_becs_debit": { | |
| "$ref": "#/definitions/Stripe.Mandate.PaymentMethodDetails.AuBecsDebit" | |
| }, | |
| "bacs_debit": { | |
| "$ref": "#/definitions/Stripe.Mandate.PaymentMethodDetails.BacsDebit" | |
| }, | |
| "card": { | |
| "$ref": "#/definitions/Stripe.Mandate.PaymentMethodDetails.Card" | |
| }, | |
| "sepa_debit": { | |
| "$ref": "#/definitions/Stripe.Mandate.PaymentMethodDetails.SepaDebit" | |
| }, | |
| "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.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Mandate.PaymentMethodDetails.AcssDebit": { | |
| "properties": { | |
| "interval_description": { | |
| "description": "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.", | |
| "type": "string" | |
| }, | |
| "payment_schedule": { | |
| "$ref": "#/definitions/Stripe.Mandate.PaymentMethodDetails.AcssDebit.PaymentSchedule", | |
| "description": "Payment schedule for the mandate." | |
| }, | |
| "transaction_type": { | |
| "$ref": "#/definitions/Stripe.Mandate.PaymentMethodDetails.AcssDebit.TransactionType", | |
| "description": "Transaction type of the mandate." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Mandate.PaymentMethodDetails.AcssDebit.PaymentSchedule": { | |
| "enum": [ | |
| "combined", | |
| "interval", | |
| "sporadic" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Mandate.PaymentMethodDetails.AcssDebit.TransactionType": { | |
| "enum": [ | |
| "business", | |
| "personal" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Mandate.PaymentMethodDetails.AuBecsDebit": { | |
| "properties": { | |
| "url": { | |
| "description": "The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Mandate.PaymentMethodDetails.BacsDebit": { | |
| "properties": { | |
| "network_status": { | |
| "$ref": "#/definitions/Stripe.Mandate.PaymentMethodDetails.BacsDebit.NetworkStatus", | |
| "description": "The status of the mandate on the Bacs network. Can be one of `pending`, `revoked`, `refused`, or `accepted`." | |
| }, | |
| "reference": { | |
| "description": "The unique reference identifying the mandate on the Bacs network.", | |
| "type": "string" | |
| }, | |
| "url": { | |
| "description": "The URL that will contain the mandate that the customer has signed.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Mandate.PaymentMethodDetails.BacsDebit.NetworkStatus": { | |
| "enum": [ | |
| "accepted", | |
| "pending", | |
| "refused", | |
| "revoked" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Mandate.PaymentMethodDetails.Card": { | |
| "type": "object" | |
| }, | |
| "Stripe.Mandate.PaymentMethodDetails.SepaDebit": { | |
| "properties": { | |
| "reference": { | |
| "description": "The unique reference of the mandate.", | |
| "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.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Mandate.SingleUse": { | |
| "properties": { | |
| "amount": { | |
| "description": "On a single use mandate, the amount of the payment.", | |
| "type": "number" | |
| }, | |
| "currency": { | |
| "description": "On a single use mandate, the currency of the payment.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Mandate.Status": { | |
| "enum": [ | |
| "active", | |
| "inactive", | |
| "pending" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Mandate.Type": { | |
| "enum": [ | |
| "multi_use", | |
| "single_use" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.MandatesResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.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.", | |
| "type": "object" | |
| }, | |
| "Stripe.OAuthResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Order": { | |
| "description": "The Order object.", | |
| "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": "number" | |
| }, | |
| "amount_returned": { | |
| "description": "The total amount that was returned to the customer.", | |
| "type": "number" | |
| }, | |
| "application": { | |
| "description": "ID of the Connect Application that created the order.", | |
| "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.", | |
| "type": "number" | |
| }, | |
| "charge": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Charge" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The ID of the payment used to pay for the order. Present if the order status is `paid`, `fulfilled`, or `refunded`." | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "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": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Customer" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedCustomer" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The customer used for the order." | |
| }, | |
| "email": { | |
| "description": "The email address of the customer placing the order.", | |
| "type": "string" | |
| }, | |
| "external_coupon_code": { | |
| "description": "External coupon code to load for this order.", | |
| "type": "string" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "items": { | |
| "description": "List of items constituting the order. An order can have up to 25 items.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.OrderItem" | |
| }, | |
| "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": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "order" | |
| ], | |
| "type": "string" | |
| }, | |
| "returns": { | |
| "$ref": "#/definitions/Stripe.ApiList<Stripe.OrderReturn>", | |
| "description": "A list of returns that have taken place for this order." | |
| }, | |
| "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.", | |
| "type": "string" | |
| }, | |
| "shipping": { | |
| "$ref": "#/definitions/Stripe.Order.Shipping", | |
| "description": "The shipping address for the order. Present if the order is for goods to be shipped." | |
| }, | |
| "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": "#/definitions/Stripe.Order.ShippingMethod" | |
| }, | |
| "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).", | |
| "type": "string" | |
| }, | |
| "status_transitions": { | |
| "$ref": "#/definitions/Stripe.Order.StatusTransitions", | |
| "description": "The timestamps at which the order status was updated." | |
| }, | |
| "updated": { | |
| "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "upstream_id": { | |
| "description": "The user's order ID if it is different from the Stripe order ID.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Order.Shipping": { | |
| "properties": { | |
| "address": { | |
| "$ref": "#/definitions/Stripe.Address" | |
| }, | |
| "carrier": { | |
| "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "description": "Recipient name.", | |
| "type": "string" | |
| }, | |
| "phone": { | |
| "description": "Recipient phone (including extension).", | |
| "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.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Order.ShippingMethod": { | |
| "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": "number" | |
| }, | |
| "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": { | |
| "$ref": "#/definitions/Stripe.Order.ShippingMethod.DeliveryEstimate", | |
| "description": "The estimated delivery date for the given shipping method. Can be either a specific date or a range." | |
| }, | |
| "description": { | |
| "description": "An arbitrary string attached to the object. Often useful for displaying to users.", | |
| "type": "string" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Order.ShippingMethod.DeliveryEstimate": { | |
| "properties": { | |
| "date": { | |
| "description": "If `type` is `\"exact\"`, `date` will be the expected delivery date in the format YYYY-MM-DD.", | |
| "type": "string" | |
| }, | |
| "earliest": { | |
| "description": "If `type` is `\"range\"`, `earliest` will be be the earliest delivery date in the format YYYY-MM-DD.", | |
| "type": "string" | |
| }, | |
| "latest": { | |
| "description": "If `type` is `\"range\"`, `latest` will be the latest delivery date in the format YYYY-MM-DD.", | |
| "type": "string" | |
| }, | |
| "type": { | |
| "description": "The type of estimate. Must be either `\"range\"` or `\"exact\"`.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Order.StatusTransitions": { | |
| "properties": { | |
| "canceled": { | |
| "description": "The time that the order was canceled.", | |
| "type": "number" | |
| }, | |
| "fulfiled": { | |
| "description": "The time that the order was fulfilled.", | |
| "type": "number" | |
| }, | |
| "paid": { | |
| "description": "The time that the order was paid.", | |
| "type": "number" | |
| }, | |
| "returned": { | |
| "description": "The time that the order was returned.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.OrderItem": { | |
| "description": "The OrderItem object.", | |
| "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": "number" | |
| }, | |
| "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\"`).", | |
| "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": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Sku" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a 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`.", | |
| "type": "number" | |
| }, | |
| "type": { | |
| "description": "The type of line item. One of `sku`, `tax`, `shipping`, or `discount`.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.OrderReturn": { | |
| "description": "The OrderReturn object.", | |
| "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": "number" | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "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.", | |
| "type": "string" | |
| }, | |
| "items": { | |
| "description": "The items included in this order return.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.OrderItem" | |
| }, | |
| "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": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Order" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The order that this return includes items from." | |
| }, | |
| "refund": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Refund" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The ID of the refund issued for this return." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.OrderReturnsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.OrdersResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent": { | |
| "description": "The PaymentIntent object.", | |
| "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": "number" | |
| }, | |
| "amount_capturable": { | |
| "description": "Amount that can be captured from this PaymentIntent.", | |
| "type": "number" | |
| }, | |
| "amount_received": { | |
| "description": "Amount that was collected by this PaymentIntent.", | |
| "type": "number" | |
| }, | |
| "application": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Application" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the Connect application that created the PaymentIntent." | |
| }, | |
| "application_fee_amount": { | |
| "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).", | |
| "type": "number" | |
| }, | |
| "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.", | |
| "type": "number" | |
| }, | |
| "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" | |
| ], | |
| "type": "string" | |
| }, | |
| "capture_method": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.CaptureMethod", | |
| "description": "Controls when the funds will be captured from the customer's account." | |
| }, | |
| "charges": { | |
| "$ref": "#/definitions/Stripe.ApiList<Stripe.Charge>", | |
| "description": "Charges that were created by this PaymentIntent, if any." | |
| }, | |
| "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?integration=elements) and learn about how `client_secret` should be handled.", | |
| "type": "string" | |
| }, | |
| "confirmation_method": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.ConfirmationMethod" | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "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": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Customer" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedCustomer" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf 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." | |
| }, | |
| "description": { | |
| "description": "An arbitrary string attached to the object. Often useful for displaying to users.", | |
| "type": "string" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "invoice": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Invoice" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the invoice that created this PaymentIntent, if it exists." | |
| }, | |
| "last_payment_error": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.LastPaymentError", | |
| "description": "The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason." | |
| }, | |
| "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": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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)." | |
| }, | |
| "next_action": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.NextAction", | |
| "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." | |
| }, | |
| "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": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Account" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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." | |
| }, | |
| "payment_method": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.PaymentMethod" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the payment method used in this PaymentIntent." | |
| }, | |
| "payment_method_options": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.PaymentMethodOptions", | |
| "description": "Payment-method-specific configuration for this PaymentIntent." | |
| }, | |
| "payment_method_types": { | |
| "description": "The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "receipt_email": { | |
| "description": "Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).", | |
| "type": "string" | |
| }, | |
| "review": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Review" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the review associated with this PaymentIntent, if any." | |
| }, | |
| "setup_future_usage": { | |
| "description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding 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.\n\nWhen 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" | |
| ], | |
| "type": "string" | |
| }, | |
| "shipping": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.Shipping", | |
| "description": "Shipping information for this PaymentIntent." | |
| }, | |
| "source": { | |
| "anyOf": [ | |
| { | |
| "description": "The resulting source of [a Connect platform debiting a connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account).", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "object": { | |
| "enum": [ | |
| "account" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.AlipayAccount" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.BankAccount" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.BitcoinReceiver" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Card" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Source" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedAlipayAccount" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedBankAccount" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedBitcoinReceiver" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedCard" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "This is a legacy field that will be removed in the future. It is the ID of the Source object that is associated with this PaymentIntent, if one was supplied." | |
| }, | |
| "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.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "status": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.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)." | |
| }, | |
| "transfer_data": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.TransferData", | |
| "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." | |
| }, | |
| "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.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.CaptureMethod": { | |
| "enum": [ | |
| "automatic", | |
| "manual" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.PaymentIntent.ConfirmationMethod": { | |
| "enum": [ | |
| "automatic", | |
| "manual" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.PaymentIntent.LastPaymentError": { | |
| "properties": { | |
| "charge": { | |
| "description": "For card errors, the ID of the failed charge.", | |
| "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.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "doc_url": { | |
| "description": "A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.", | |
| "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.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "payment_intent": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent", | |
| "description": "A PaymentIntent guides you through the process of collecting a payment from your customer.\nWe recommend that you create exactly one PaymentIntent for each order or\ncustomer session in your system. You can reference the PaymentIntent later to\nsee the history of payment attempts for a particular session.\n\nA PaymentIntent transitions through\n[multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)\nthroughout its lifetime as it interfaces with Stripe.js to perform\nauthentication flows and ultimately creates at most one successful charge.\n\nRelated guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents)." | |
| }, | |
| "payment_method": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod", | |
| "description": "PaymentMethod objects represent your customer's payment instruments.\nThey can be used with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or saved to\nCustomer objects to store instrument details for future payments.\n\nRelated guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios)." | |
| }, | |
| "payment_method_type": { | |
| "description": "If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.", | |
| "type": "string" | |
| }, | |
| "setup_intent": { | |
| "$ref": "#/definitions/Stripe.SetupIntent", | |
| "description": "A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.\nFor example, you could use a SetupIntent to set up and save your customer's card without immediately collecting a payment.\nLater, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow.\n\nCreate a SetupIntent as soon as you're ready to collect your customer's payment credentials.\nDo not maintain long-lived, unconfirmed SetupIntents as they may no longer be valid.\nThe SetupIntent then transitions through multiple [statuses](https://stripe.com/docs/payments/intents#intent-statuses) as it guides\nyou through the setup process.\n\nSuccessful SetupIntents result in payment credentials that are optimized for future payments.\nFor example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) may need to be run through\n[Strong Customer Authentication](https://stripe.com/docs/strong-customer-authentication) at the time of payment method collection\nin order to streamline later [off-session payments](https://stripe.com/docs/payments/setup-intents).\nIf the SetupIntent is used with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer), upon success,\nit will automatically attach the resulting payment method to that Customer.\nWe recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on\nPaymentIntents to save payment methods in order to prevent saving invalid or unoptimized payment methods.\n\nBy using SetupIntents, you ensure that your customers experience the minimum set of required friction,\neven as regulations change over time.\n\nRelated guide: [Setup Intents API](https://stripe.com/docs/payments/setup-intents)." | |
| }, | |
| "source": { | |
| "anyOf": [ | |
| { | |
| "description": "The resulting source of [a Connect platform debiting a connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account).", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "object": { | |
| "enum": [ | |
| "account" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.AlipayAccount" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.BankAccount" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.BitcoinReceiver" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Card" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Source" | |
| } | |
| ] | |
| }, | |
| "type": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.LastPaymentError.Type", | |
| "description": "The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.LastPaymentError.Type": { | |
| "enum": [ | |
| "api_error", | |
| "card_error", | |
| "idempotency_error", | |
| "invalid_request_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.PaymentIntent.NextAction": { | |
| "properties": { | |
| "alipay_handle_redirect": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.NextAction.AlipayHandleRedirect" | |
| }, | |
| "boleto_display_details": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.NextAction.BoletoDisplayDetails" | |
| }, | |
| "oxxo_display_details": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.NextAction.OxxoDisplayDetails" | |
| }, | |
| "redirect_to_url": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.NextAction.RedirectToUrl" | |
| }, | |
| "type": { | |
| "description": "Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, or `oxxo_display_details`.", | |
| "type": "string" | |
| }, | |
| "use_stripe_sdk": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.NextAction.UseStripeSdk", | |
| "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." | |
| }, | |
| "verify_with_microdeposits": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.NextAction.VerifyWithMicrodeposits" | |
| }, | |
| "wechat_pay_display_qr_code": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.NextAction.WechatPayDisplayQrCode" | |
| }, | |
| "wechat_pay_redirect_to_android_app": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.NextAction.WechatPayRedirectToAndroidApp" | |
| }, | |
| "wechat_pay_redirect_to_ios_app": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.NextAction.WechatPayRedirectToIosApp" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.NextAction.AlipayHandleRedirect": { | |
| "properties": { | |
| "native_data": { | |
| "description": "The native data to be used with Alipay SDK you must redirect your customer to in order to authenticate the payment in an Android App.", | |
| "type": "string" | |
| }, | |
| "native_url": { | |
| "description": "The native URL you must redirect your customer to in order to authenticate the payment in an iOS App.", | |
| "type": "string" | |
| }, | |
| "return_url": { | |
| "description": "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.", | |
| "type": "string" | |
| }, | |
| "url": { | |
| "description": "The URL you must redirect your customer to in order to authenticate the payment.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.NextAction.BoletoDisplayDetails": { | |
| "properties": { | |
| "expires_at": { | |
| "description": "The timestamp after which the boleto expires.", | |
| "type": "number" | |
| }, | |
| "hosted_voucher_url": { | |
| "description": "The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher.", | |
| "type": "string" | |
| }, | |
| "number": { | |
| "description": "The boleto number.", | |
| "type": "string" | |
| }, | |
| "pdf": { | |
| "description": "The URL to the downloadable boleto voucher PDF.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.NextAction.OxxoDisplayDetails": { | |
| "properties": { | |
| "expires_after": { | |
| "description": "The timestamp after which the OXXO voucher expires.", | |
| "type": "number" | |
| }, | |
| "hosted_voucher_url": { | |
| "description": "The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher.", | |
| "type": "string" | |
| }, | |
| "number": { | |
| "description": "OXXO reference number.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.NextAction.RedirectToUrl": { | |
| "properties": { | |
| "return_url": { | |
| "description": "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.", | |
| "type": "string" | |
| }, | |
| "url": { | |
| "description": "The URL you must redirect your customer to in order to authenticate the payment.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.NextAction.UseStripeSdk": { | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.NextAction.VerifyWithMicrodeposits": { | |
| "properties": { | |
| "arrival_date": { | |
| "description": "The timestamp when the microdeposits are expected to land.", | |
| "type": "number" | |
| }, | |
| "hosted_verification_url": { | |
| "description": "The URL for the hosted verification page, which allows customers to verify their bank account.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.NextAction.WechatPayDisplayQrCode": { | |
| "properties": { | |
| "data": { | |
| "description": "The data being used to generate QR code", | |
| "type": "string" | |
| }, | |
| "image_data_url": { | |
| "description": "The base64 image data for a pre-generated QR code", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.NextAction.WechatPayRedirectToAndroidApp": { | |
| "properties": { | |
| "app_id": { | |
| "description": "app_id is the APP ID registered on WeChat open platform", | |
| "type": "string" | |
| }, | |
| "nonce_str": { | |
| "description": "nonce_str is a random string", | |
| "type": "string" | |
| }, | |
| "package": { | |
| "description": "package is static value", | |
| "type": "string" | |
| }, | |
| "partner_id": { | |
| "description": "an unique merchant ID assigned by Wechat Pay", | |
| "type": "string" | |
| }, | |
| "prepay_id": { | |
| "description": "an unique trading ID assigned by Wechat Pay", | |
| "type": "string" | |
| }, | |
| "sign": { | |
| "description": "A signature", | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "description": "Specifies the current time in epoch format", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.NextAction.WechatPayRedirectToIosApp": { | |
| "properties": { | |
| "native_url": { | |
| "description": "An universal link that redirect to Wechat Pay APP", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.PaymentMethodOptions": { | |
| "properties": { | |
| "acss_debit": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.PaymentMethodOptions.AcssDebit" | |
| }, | |
| "afterpay_clearpay": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.PaymentMethodOptions.AfterpayClearpay" | |
| }, | |
| "alipay": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.PaymentMethodOptions.Alipay" | |
| }, | |
| "bancontact": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.PaymentMethodOptions.Bancontact" | |
| }, | |
| "boleto": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.PaymentMethodOptions.Boleto" | |
| }, | |
| "card": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.PaymentMethodOptions.Card" | |
| }, | |
| "card_present": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.PaymentMethodOptions.CardPresent" | |
| }, | |
| "ideal": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.PaymentMethodOptions.Ideal" | |
| }, | |
| "oxxo": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.PaymentMethodOptions.Oxxo" | |
| }, | |
| "p24": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.PaymentMethodOptions.P24" | |
| }, | |
| "sepa_debit": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.PaymentMethodOptions.SepaDebit" | |
| }, | |
| "sofort": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.PaymentMethodOptions.Sofort" | |
| }, | |
| "wechat_pay": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.PaymentMethodOptions.WechatPay" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.PaymentMethodOptions.AcssDebit": { | |
| "properties": { | |
| "mandate_options": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.PaymentMethodOptions.AcssDebit.MandateOptions" | |
| }, | |
| "verification_method": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.PaymentMethodOptions.AcssDebit.VerificationMethod", | |
| "description": "Bank account verification method." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.PaymentMethodOptions.AcssDebit.MandateOptions": { | |
| "properties": { | |
| "custom_mandate_url": { | |
| "description": "A URL for custom mandate text", | |
| "type": "string" | |
| }, | |
| "interval_description": { | |
| "description": "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.", | |
| "type": "string" | |
| }, | |
| "payment_schedule": { | |
| "description": "Payment schedule for the mandate.", | |
| "enum": [ | |
| "combined", | |
| "interval", | |
| "sporadic" | |
| ], | |
| "type": "string" | |
| }, | |
| "transaction_type": { | |
| "description": "Transaction type of the mandate.", | |
| "enum": [ | |
| "business", | |
| "personal" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.PaymentMethodOptions.AcssDebit.VerificationMethod": { | |
| "enum": [ | |
| "automatic", | |
| "instant", | |
| "microdeposits" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.PaymentIntent.PaymentMethodOptions.AfterpayClearpay": { | |
| "properties": { | |
| "reference": { | |
| "description": "Order identifier shown to the merchant in Afterpay's online portal. We recommend using a value that helps you answer any questions a customer might have about\nthe payment. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.PaymentMethodOptions.Alipay": { | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.PaymentMethodOptions.Bancontact": { | |
| "properties": { | |
| "preferred_language": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.PaymentMethodOptions.Bancontact.PreferredLanguage", | |
| "description": "Preferred language of the Bancontact authorization page that the customer is redirected to." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.PaymentMethodOptions.Bancontact.PreferredLanguage": { | |
| "enum": [ | |
| "de", | |
| "en", | |
| "fr", | |
| "nl" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.PaymentIntent.PaymentMethodOptions.Boleto": { | |
| "properties": { | |
| "expires_after_days": { | |
| "description": "The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.PaymentMethodOptions.Card": { | |
| "properties": { | |
| "installments": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.PaymentMethodOptions.Card.Installments", | |
| "description": "Installment details for this payment (Mexico only).\n\nFor more information, see the [installments integration guide](https://stripe.com/docs/payments/installments)." | |
| }, | |
| "network": { | |
| "description": "Selected network to process this payment intent on. Depends on the available networks of the card attached to the payment intent. Can be only set confirm-time.", | |
| "enum": [ | |
| "amex", | |
| "cartes_bancaires", | |
| "diners", | |
| "discover", | |
| "interac", | |
| "jcb", | |
| "mastercard", | |
| "unionpay", | |
| "unknown", | |
| "visa" | |
| ], | |
| "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" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.PaymentMethodOptions.Card.Installments": { | |
| "properties": { | |
| "available_plans": { | |
| "description": "Installment plans that may be selected for this PaymentIntent.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.PaymentMethodOptions.Card.Installments.AvailablePlan" | |
| }, | |
| "type": "array" | |
| }, | |
| "enabled": { | |
| "description": "Whether Installments are enabled for this PaymentIntent.", | |
| "type": "boolean" | |
| }, | |
| "plan": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.PaymentMethodOptions.Card.Installments.Plan", | |
| "description": "Installment plan selected for this PaymentIntent." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.PaymentMethodOptions.Card.Installments.AvailablePlan": { | |
| "properties": { | |
| "count": { | |
| "description": "For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.", | |
| "type": "number" | |
| }, | |
| "interval": { | |
| "description": "For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`.", | |
| "enum": [ | |
| "month" | |
| ], | |
| "type": "string" | |
| }, | |
| "type": { | |
| "description": "Type of installment plan, one of `fixed_count`.", | |
| "enum": [ | |
| "fixed_count" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.PaymentMethodOptions.Card.Installments.Plan": { | |
| "properties": { | |
| "count": { | |
| "description": "For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.", | |
| "type": "number" | |
| }, | |
| "interval": { | |
| "description": "For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`.", | |
| "enum": [ | |
| "month" | |
| ], | |
| "type": "string" | |
| }, | |
| "type": { | |
| "description": "Type of installment plan, one of `fixed_count`.", | |
| "enum": [ | |
| "fixed_count" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.PaymentMethodOptions.CardPresent": { | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.PaymentMethodOptions.Ideal": { | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.PaymentMethodOptions.Oxxo": { | |
| "properties": { | |
| "expires_after_days": { | |
| "description": "The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.PaymentMethodOptions.P24": { | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.PaymentMethodOptions.SepaDebit": { | |
| "properties": { | |
| "mandate_options": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent.PaymentMethodOptions.SepaDebit.MandateOptions" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.PaymentMethodOptions.SepaDebit.MandateOptions": { | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.PaymentMethodOptions.Sofort": { | |
| "properties": { | |
| "preferred_language": { | |
| "description": "Preferred language of the SOFORT authorization page that the customer is redirected to.", | |
| "enum": [ | |
| "de", | |
| "en", | |
| "es", | |
| "fr", | |
| "it", | |
| "nl", | |
| "pl" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.PaymentMethodOptions.WechatPay": { | |
| "properties": { | |
| "app_id": { | |
| "description": "The app ID registered with WeChat Pay. Only required when client is ios or android.", | |
| "type": "string" | |
| }, | |
| "client": { | |
| "description": "The client type that the end customer will pay from", | |
| "enum": [ | |
| "android", | |
| "ios", | |
| "web" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.Shipping": { | |
| "properties": { | |
| "address": { | |
| "$ref": "#/definitions/Stripe.Address" | |
| }, | |
| "carrier": { | |
| "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "description": "Recipient name.", | |
| "type": "string" | |
| }, | |
| "phone": { | |
| "description": "Recipient phone (including extension).", | |
| "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.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntent.Status": { | |
| "enum": [ | |
| "canceled", | |
| "processing", | |
| "requires_action", | |
| "requires_capture", | |
| "requires_confirmation", | |
| "requires_payment_method", | |
| "succeeded" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.PaymentIntent.TransferData": { | |
| "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": "number" | |
| }, | |
| "destination": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Account" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The account (if any) the payment will be attributed to for tax\nreporting, and where funds from the payment will be transferred to upon\npayment success." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentIntentsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod": { | |
| "description": "The PaymentMethod object.", | |
| "properties": { | |
| "acss_debit": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.AcssDebit" | |
| }, | |
| "afterpay_clearpay": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.AfterpayClearpay" | |
| }, | |
| "alipay": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.Alipay" | |
| }, | |
| "au_becs_debit": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.AuBecsDebit" | |
| }, | |
| "bacs_debit": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.BacsDebit" | |
| }, | |
| "bancontact": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.Bancontact" | |
| }, | |
| "billing_details": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.BillingDetails" | |
| }, | |
| "boleto": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.Boleto" | |
| }, | |
| "card": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.Card" | |
| }, | |
| "card_present": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.CardPresent" | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "customer": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Customer" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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." | |
| }, | |
| "eps": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.Eps" | |
| }, | |
| "fpx": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.Fpx" | |
| }, | |
| "giropay": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.Giropay" | |
| }, | |
| "grabpay": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.Grabpay" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "ideal": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.Ideal" | |
| }, | |
| "interac_present": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.InteracPresent" | |
| }, | |
| "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": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "payment_method" | |
| ], | |
| "type": "string" | |
| }, | |
| "oxxo": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.Oxxo" | |
| }, | |
| "p24": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.P24" | |
| }, | |
| "sepa_debit": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.SepaDebit" | |
| }, | |
| "sofort": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.Sofort" | |
| }, | |
| "type": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.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." | |
| }, | |
| "wechat_pay": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.WechatPay" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.AcssDebit": { | |
| "properties": { | |
| "bank_name": { | |
| "description": "Name of the bank associated with the bank account.", | |
| "type": "string" | |
| }, | |
| "fingerprint": { | |
| "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", | |
| "type": "string" | |
| }, | |
| "institution_number": { | |
| "description": "Institution number of the bank account.", | |
| "type": "string" | |
| }, | |
| "last4": { | |
| "description": "Last four digits of the bank account number.", | |
| "type": "string" | |
| }, | |
| "transit_number": { | |
| "description": "Transit number of the bank account.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.AfterpayClearpay": { | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.Alipay": { | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.AuBecsDebit": { | |
| "properties": { | |
| "bsb_number": { | |
| "description": "Six-digit number identifying bank and branch associated with this bank account.", | |
| "type": "string" | |
| }, | |
| "fingerprint": { | |
| "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", | |
| "type": "string" | |
| }, | |
| "last4": { | |
| "description": "Last four digits of the bank account number.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.BacsDebit": { | |
| "properties": { | |
| "fingerprint": { | |
| "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", | |
| "type": "string" | |
| }, | |
| "last4": { | |
| "description": "Last four digits of the bank account number.", | |
| "type": "string" | |
| }, | |
| "sort_code": { | |
| "description": "Sort code of the bank account. (e.g., `10-20-30`)", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.Bancontact": { | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.BillingDetails": { | |
| "properties": { | |
| "address": { | |
| "$ref": "#/definitions/Stripe.Address", | |
| "description": "Billing address." | |
| }, | |
| "email": { | |
| "description": "Email address.", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "description": "Full name.", | |
| "type": "string" | |
| }, | |
| "phone": { | |
| "description": "Billing phone number (including extension).", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.Boleto": { | |
| "properties": { | |
| "tax_id": { | |
| "description": "Uniquely identifies the customer tax id (CNPJ or CPF)", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.Card": { | |
| "properties": { | |
| "brand": { | |
| "description": "Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.", | |
| "type": "string" | |
| }, | |
| "checks": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.Card.Checks", | |
| "description": "Checks on Card address and CVC if provided." | |
| }, | |
| "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.", | |
| "type": "string" | |
| }, | |
| "description": { | |
| "description": "A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)", | |
| "type": "string" | |
| }, | |
| "exp_month": { | |
| "description": "Two-digit number representing the card's expiration month.", | |
| "type": "number" | |
| }, | |
| "exp_year": { | |
| "description": "Four-digit number representing the card's expiration year.", | |
| "type": "number" | |
| }, | |
| "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.\n\n*Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*", | |
| "type": "string" | |
| }, | |
| "funding": { | |
| "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.", | |
| "type": "string" | |
| }, | |
| "iin": { | |
| "description": "Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)", | |
| "type": "string" | |
| }, | |
| "issuer": { | |
| "description": "The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)", | |
| "type": "string" | |
| }, | |
| "last4": { | |
| "description": "The last four digits of the card.", | |
| "type": "string" | |
| }, | |
| "networks": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.Card.Networks", | |
| "description": "Contains information about card networks that can be used to process the payment." | |
| }, | |
| "three_d_secure_usage": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.Card.ThreeDSecureUsage", | |
| "description": "Contains details on how this Card maybe be used for 3D Secure authentication." | |
| }, | |
| "wallet": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.Card.Wallet", | |
| "description": "If this Card is part of a card wallet, this contains the details of the card wallet." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.Card.Checks": { | |
| "properties": { | |
| "address_line1_check": { | |
| "description": "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", | |
| "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`.", | |
| "type": "string" | |
| }, | |
| "cvc_check": { | |
| "description": "If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.Card.Networks": { | |
| "properties": { | |
| "available": { | |
| "description": "All available networks for the card.", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "preferred": { | |
| "description": "The preferred network for the card.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.Card.ThreeDSecureUsage": { | |
| "properties": { | |
| "supported": { | |
| "description": "Whether 3D Secure is supported on this card.", | |
| "type": "boolean" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.Card.Wallet": { | |
| "properties": { | |
| "amex_express_checkout": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.Card.Wallet.AmexExpressCheckout" | |
| }, | |
| "apple_pay": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.Card.Wallet.ApplePay" | |
| }, | |
| "dynamic_last4": { | |
| "description": "(For tokenized numbers only.) The last four digits of the device account number.", | |
| "type": "string" | |
| }, | |
| "google_pay": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.Card.Wallet.GooglePay" | |
| }, | |
| "masterpass": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.Card.Wallet.Masterpass" | |
| }, | |
| "samsung_pay": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.Card.Wallet.SamsungPay" | |
| }, | |
| "type": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.Card.Wallet.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." | |
| }, | |
| "visa_checkout": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.Card.Wallet.VisaCheckout" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.Card.Wallet.AmexExpressCheckout": { | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.Card.Wallet.ApplePay": { | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.Card.Wallet.GooglePay": { | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.Card.Wallet.Masterpass": { | |
| "properties": { | |
| "billing_address": { | |
| "$ref": "#/definitions/Stripe.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." | |
| }, | |
| "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.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "shipping_address": { | |
| "$ref": "#/definitions/Stripe.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." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.Card.Wallet.SamsungPay": { | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.Card.Wallet.Type": { | |
| "enum": [ | |
| "amex_express_checkout", | |
| "apple_pay", | |
| "google_pay", | |
| "masterpass", | |
| "samsung_pay", | |
| "visa_checkout" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.PaymentMethod.Card.Wallet.VisaCheckout": { | |
| "properties": { | |
| "billing_address": { | |
| "$ref": "#/definitions/Stripe.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." | |
| }, | |
| "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.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "shipping_address": { | |
| "$ref": "#/definitions/Stripe.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." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.CardPresent": { | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.Eps": { | |
| "properties": { | |
| "bank": { | |
| "description": "The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`.", | |
| "enum": [ | |
| "arzte_und_apotheker_bank", | |
| "austrian_anadi_bank_ag", | |
| "bank_austria", | |
| "bankhaus_carl_spangler", | |
| "bankhaus_schelhammer_und_schattera_ag", | |
| "bawag_psk_ag", | |
| "bks_bank_ag", | |
| "brull_kallmus_bank_ag", | |
| "btv_vier_lander_bank", | |
| "capital_bank_grawe_gruppe_ag", | |
| "dolomitenbank", | |
| "easybank_ag", | |
| "erste_bank_und_sparkassen", | |
| "hypo_alpeadriabank_international_ag", | |
| "hypo_bank_burgenland_aktiengesellschaft", | |
| "hypo_noe_lb_fur_niederosterreich_u_wien", | |
| "hypo_oberosterreich_salzburg_steiermark", | |
| "hypo_tirol_bank_ag", | |
| "hypo_vorarlberg_bank_ag", | |
| "marchfelder_bank", | |
| "oberbank_ag", | |
| "raiffeisen_bankengruppe_osterreich", | |
| "schoellerbank_ag", | |
| "sparda_bank_wien", | |
| "volksbank_gruppe", | |
| "volkskreditbank_ag", | |
| "vr_bank_braunau" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.Fpx": { | |
| "properties": { | |
| "account_holder_type": { | |
| "description": "Account holder type, if provided. Can be one of `individual` or `company`.", | |
| "enum": [ | |
| "company", | |
| "individual" | |
| ], | |
| "type": "string" | |
| }, | |
| "bank": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.Fpx.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`." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.Fpx.Bank": { | |
| "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" | |
| }, | |
| "Stripe.PaymentMethod.Giropay": { | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.Grabpay": { | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.Ideal": { | |
| "properties": { | |
| "bank": { | |
| "description": "The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, or `van_lanschot`.", | |
| "enum": [ | |
| "abn_amro", | |
| "asn_bank", | |
| "bunq", | |
| "handelsbanken", | |
| "ing", | |
| "knab", | |
| "moneyou", | |
| "rabobank", | |
| "regiobank", | |
| "revolut", | |
| "sns_bank", | |
| "triodos_bank", | |
| "van_lanschot" | |
| ], | |
| "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", | |
| "REVOLT21", | |
| "SNSBNL2A", | |
| "TRIONL2U" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.InteracPresent": { | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.Oxxo": { | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.P24": { | |
| "properties": { | |
| "bank": { | |
| "description": "The customer's bank, if provided.", | |
| "enum": [ | |
| "alior_bank", | |
| "bank_millennium", | |
| "bank_nowy_bfg_sa", | |
| "bank_pekao_sa", | |
| "banki_spbdzielcze", | |
| "blik", | |
| "bnp_paribas", | |
| "boz", | |
| "citi_handlowy", | |
| "credit_agricole", | |
| "envelobank", | |
| "etransfer_pocztowy24", | |
| "getin_bank", | |
| "ideabank", | |
| "ing", | |
| "inteligo", | |
| "mbank_mtransfer", | |
| "nest_przelew", | |
| "noble_pay", | |
| "pbac_z_ipko", | |
| "plus_bank", | |
| "santander_przelew24", | |
| "tmobile_usbugi_bankowe", | |
| "toyota_bank", | |
| "volkswagen_bank" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.SepaDebit": { | |
| "properties": { | |
| "bank_code": { | |
| "description": "Bank code of bank associated with the bank account.", | |
| "type": "string" | |
| }, | |
| "branch_code": { | |
| "description": "Branch code of bank associated with the bank account.", | |
| "type": "string" | |
| }, | |
| "country": { | |
| "description": "Two-letter ISO code representing the country the bank account is located in.", | |
| "type": "string" | |
| }, | |
| "fingerprint": { | |
| "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.", | |
| "type": "string" | |
| }, | |
| "generated_from": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod.SepaDebit.GeneratedFrom", | |
| "description": "Information about the object that generated this PaymentMethod." | |
| }, | |
| "last4": { | |
| "description": "Last four characters of the IBAN.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.SepaDebit.GeneratedFrom": { | |
| "properties": { | |
| "charge": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Charge" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The ID of the Charge that generated this PaymentMethod, if any." | |
| }, | |
| "setup_attempt": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.SetupAttempt" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The ID of the SetupAttempt that generated this PaymentMethod, if any." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.Sofort": { | |
| "properties": { | |
| "country": { | |
| "description": "Two-letter ISO code representing the country the bank account is located in.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethod.Type": { | |
| "enum": [ | |
| "acss_debit", | |
| "afterpay_clearpay", | |
| "alipay", | |
| "au_becs_debit", | |
| "bacs_debit", | |
| "bancontact", | |
| "boleto", | |
| "card", | |
| "card_present", | |
| "eps", | |
| "fpx", | |
| "giropay", | |
| "grabpay", | |
| "ideal", | |
| "interac_present", | |
| "oxxo", | |
| "p24", | |
| "sepa_debit", | |
| "sofort", | |
| "wechat_pay" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.PaymentMethod.WechatPay": { | |
| "type": "object" | |
| }, | |
| "Stripe.PaymentMethodsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Payout": { | |
| "description": "The Payout object.", | |
| "properties": { | |
| "amount": { | |
| "description": "Amount (in %s) to be transferred to your bank account or debit card.", | |
| "type": "number" | |
| }, | |
| "arrival_date": { | |
| "description": "Date the payout is expected to arrive in the bank. This factors in delays like weekends or bank holidays.", | |
| "type": "number" | |
| }, | |
| "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": [ | |
| { | |
| "$ref": "#/definitions/Stripe.BalanceTransaction" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the balance transaction that describes the impact of this payout on your account balance." | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "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.", | |
| "type": "string" | |
| }, | |
| "destination": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.BankAccount" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Card" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedBankAccount" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedCard" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the bank account or card the payout was sent to." | |
| }, | |
| "failure_balance_transaction": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.BalanceTransaction" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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." | |
| }, | |
| "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.", | |
| "type": "string" | |
| }, | |
| "failure_message": { | |
| "description": "Message to user further explaining reason for payout failure if available.", | |
| "type": "string" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "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": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "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.)", | |
| "type": "string" | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "payout" | |
| ], | |
| "type": "string" | |
| }, | |
| "original_payout": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Payout" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "If the payout reverses another, this is the ID of the original payout." | |
| }, | |
| "reversed_by": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Payout" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "If the payout was reversed, this is the ID of the payout that reverses this payout." | |
| }, | |
| "source_type": { | |
| "description": "The source balance this payout came from. One of `card`, `fpx`, or `bank_account`.", | |
| "type": "string" | |
| }, | |
| "statement_descriptor": { | |
| "description": "Extra information about a payout to be displayed on the user's bank statement.", | |
| "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`.", | |
| "type": "string" | |
| }, | |
| "type": { | |
| "$ref": "#/definitions/Stripe.Payout.Type", | |
| "description": "Can be `bank_account` or `card`." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Payout.Type": { | |
| "enum": [ | |
| "bank_account", | |
| "card" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.PayoutsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Person": { | |
| "description": "The Person object.", | |
| "properties": { | |
| "account": { | |
| "description": "The account the person is associated with.", | |
| "type": "string" | |
| }, | |
| "address": { | |
| "$ref": "#/definitions/Stripe.Address" | |
| }, | |
| "address_kana": { | |
| "$ref": "#/definitions/Stripe.Person.AddressKana", | |
| "description": "The Kana variation of the person's address (Japan only)." | |
| }, | |
| "address_kanji": { | |
| "$ref": "#/definitions/Stripe.Person.AddressKanji", | |
| "description": "The Kanji variation of the person's address (Japan only)." | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "deleted": { | |
| "type": "string" | |
| }, | |
| "dob": { | |
| "$ref": "#/definitions/Stripe.Person.Dob" | |
| }, | |
| "email": { | |
| "description": "The person's email address.", | |
| "type": "string" | |
| }, | |
| "first_name": { | |
| "description": "The person's first name.", | |
| "type": "string" | |
| }, | |
| "first_name_kana": { | |
| "description": "The Kana variation of the person's first name (Japan only).", | |
| "type": "string" | |
| }, | |
| "first_name_kanji": { | |
| "description": "The Kanji variation of the person's first name (Japan only).", | |
| "type": "string" | |
| }, | |
| "future_requirements": { | |
| "$ref": "#/definitions/Stripe.Person.FutureRequirements", | |
| "description": "Information about the upcoming new requirements for this person, including what information needs to be collected, and by when." | |
| }, | |
| "gender": { | |
| "description": "The person's gender (International regulations require either \"male\" or \"female\").", | |
| "type": "string" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "id_number_provided": { | |
| "description": "Whether the person's `id_number` was provided.", | |
| "type": "boolean" | |
| }, | |
| "last_name": { | |
| "description": "The person's last name.", | |
| "type": "string" | |
| }, | |
| "last_name_kana": { | |
| "description": "The Kana variation of the person's last name (Japan only).", | |
| "type": "string" | |
| }, | |
| "last_name_kanji": { | |
| "description": "The Kanji variation of the person's last name (Japan only).", | |
| "type": "string" | |
| }, | |
| "maiden_name": { | |
| "description": "The person's maiden name.", | |
| "type": "string" | |
| }, | |
| "metadata": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "nationality": { | |
| "description": "The country where the person is a national.", | |
| "type": "string" | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "person" | |
| ], | |
| "type": "string" | |
| }, | |
| "phone": { | |
| "description": "The person's phone number.", | |
| "type": "string" | |
| }, | |
| "political_exposure": { | |
| "$ref": "#/definitions/Stripe.Person.PoliticalExposure", | |
| "description": "Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction." | |
| }, | |
| "relationship": { | |
| "$ref": "#/definitions/Stripe.Person.Relationship" | |
| }, | |
| "requirements": { | |
| "$ref": "#/definitions/Stripe.Person.Requirements", | |
| "description": "Information about the requirements for this person, including what information needs to be collected, and by when." | |
| }, | |
| "ssn_last_4_provided": { | |
| "description": "Whether the last four digits of the person's Social Security number have been provided (U.S. only).", | |
| "type": "boolean" | |
| }, | |
| "verification": { | |
| "$ref": "#/definitions/Stripe.Person.Verification" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Person.AddressKana": { | |
| "properties": { | |
| "city": { | |
| "description": "City/Ward.", | |
| "type": "string" | |
| }, | |
| "country": { | |
| "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", | |
| "type": "string" | |
| }, | |
| "line1": { | |
| "description": "Block/Building number.", | |
| "type": "string" | |
| }, | |
| "line2": { | |
| "description": "Building details.", | |
| "type": "string" | |
| }, | |
| "postal_code": { | |
| "description": "ZIP or postal code.", | |
| "type": "string" | |
| }, | |
| "state": { | |
| "description": "Prefecture.", | |
| "type": "string" | |
| }, | |
| "town": { | |
| "description": "Town/cho-me.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Person.AddressKanji": { | |
| "properties": { | |
| "city": { | |
| "description": "City/Ward.", | |
| "type": "string" | |
| }, | |
| "country": { | |
| "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", | |
| "type": "string" | |
| }, | |
| "line1": { | |
| "description": "Block/Building number.", | |
| "type": "string" | |
| }, | |
| "line2": { | |
| "description": "Building details.", | |
| "type": "string" | |
| }, | |
| "postal_code": { | |
| "description": "ZIP or postal code.", | |
| "type": "string" | |
| }, | |
| "state": { | |
| "description": "Prefecture.", | |
| "type": "string" | |
| }, | |
| "town": { | |
| "description": "Town/cho-me.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Person.Dob": { | |
| "properties": { | |
| "day": { | |
| "description": "The day of birth, between 1 and 31.", | |
| "type": "number" | |
| }, | |
| "month": { | |
| "description": "The month of birth, between 1 and 12.", | |
| "type": "number" | |
| }, | |
| "year": { | |
| "description": "The four-digit year of birth.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Person.FutureRequirements": { | |
| "properties": { | |
| "alternatives": { | |
| "description": "Fields that are due and can be satisfied by providing the corresponding alternative fields instead.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.Person.FutureRequirements.Alternative" | |
| }, | |
| "type": "array" | |
| }, | |
| "currently_due": { | |
| "description": "Fields that need to be collected to keep the person's account enabled. If not collected by the account's `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash, and may immediately become `past_due`, but the account may also be given a grace period depending on the account's enablement state prior to transition.", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "errors": { | |
| "description": "Fields that are `currently_due` and need to be collected again because validation or verification failed.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.Person.FutureRequirements.Error" | |
| }, | |
| "type": "array" | |
| }, | |
| "eventually_due": { | |
| "description": "Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `future_requirements[current_deadline]` becomes set.", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "past_due": { | |
| "description": "Fields that weren't collected by the account's `requirements.current_deadline`. These fields need to be collected to enable the person's account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "pending_verification": { | |
| "description": "Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`.", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Person.FutureRequirements.Alternative": { | |
| "properties": { | |
| "alternative_fields_due": { | |
| "description": "Fields that can be provided to satisfy all fields in `original_fields_due`.", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "original_fields_due": { | |
| "description": "Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Person.FutureRequirements.Error": { | |
| "properties": { | |
| "code": { | |
| "$ref": "#/definitions/Stripe.Person.FutureRequirements.Error.Code", | |
| "description": "The code for the type of error." | |
| }, | |
| "reason": { | |
| "description": "An informative message that indicates the error type and provides additional details about the error.", | |
| "type": "string" | |
| }, | |
| "requirement": { | |
| "description": "The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Person.FutureRequirements.Error.Code": { | |
| "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_issue_or_expiry_date_missing", | |
| "verification_document_manipulated", | |
| "verification_document_missing_back", | |
| "verification_document_missing_front", | |
| "verification_document_name_mismatch", | |
| "verification_document_name_missing", | |
| "verification_document_nationality_mismatch", | |
| "verification_document_not_readable", | |
| "verification_document_not_signed", | |
| "verification_document_not_uploaded", | |
| "verification_document_photo_mismatch", | |
| "verification_document_too_large", | |
| "verification_document_type_not_supported", | |
| "verification_failed_address_match", | |
| "verification_failed_business_iec_number", | |
| "verification_failed_document_match", | |
| "verification_failed_id_number_match", | |
| "verification_failed_keyed_identity", | |
| "verification_failed_keyed_match", | |
| "verification_failed_name_match", | |
| "verification_failed_other", | |
| "verification_failed_tax_id_match", | |
| "verification_failed_tax_id_not_issued", | |
| "verification_missing_executives", | |
| "verification_missing_owners", | |
| "verification_requires_additional_memorandum_of_associations" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Person.PoliticalExposure": { | |
| "enum": [ | |
| "existing", | |
| "none" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Person.Relationship": { | |
| "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.", | |
| "type": "boolean" | |
| }, | |
| "executive": { | |
| "description": "Whether the person has significant responsibility to control, manage, or direct the organization.", | |
| "type": "boolean" | |
| }, | |
| "owner": { | |
| "description": "Whether the person is an owner of the account's legal entity.", | |
| "type": "boolean" | |
| }, | |
| "percent_ownership": { | |
| "description": "The percent owned by the person of the account's legal entity.", | |
| "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.", | |
| "type": "boolean" | |
| }, | |
| "title": { | |
| "description": "The person's title (e.g., CEO, Support Engineer).", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Person.Requirements": { | |
| "properties": { | |
| "alternatives": { | |
| "description": "Fields that are due and can be satisfied by providing the corresponding alternative fields instead.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.Person.Requirements.Alternative" | |
| }, | |
| "type": "array" | |
| }, | |
| "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": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "errors": { | |
| "description": "Fields that are `currently_due` and need to be collected again because validation or verification failed.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.Person.Requirements.Error" | |
| }, | |
| "type": "array" | |
| }, | |
| "eventually_due": { | |
| "description": "Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set.", | |
| "items": { | |
| "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 the person's account.", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "pending_verification": { | |
| "description": "Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`.", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Person.Requirements.Alternative": { | |
| "properties": { | |
| "alternative_fields_due": { | |
| "description": "Fields that can be provided to satisfy all fields in `original_fields_due`.", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "original_fields_due": { | |
| "description": "Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Person.Requirements.Error": { | |
| "properties": { | |
| "code": { | |
| "$ref": "#/definitions/Stripe.Person.Requirements.Error.Code", | |
| "description": "The code for the type of error." | |
| }, | |
| "reason": { | |
| "description": "An informative message that indicates the error type and provides additional details about the error.", | |
| "type": "string" | |
| }, | |
| "requirement": { | |
| "description": "The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Person.Requirements.Error.Code": { | |
| "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_issue_or_expiry_date_missing", | |
| "verification_document_manipulated", | |
| "verification_document_missing_back", | |
| "verification_document_missing_front", | |
| "verification_document_name_mismatch", | |
| "verification_document_name_missing", | |
| "verification_document_nationality_mismatch", | |
| "verification_document_not_readable", | |
| "verification_document_not_signed", | |
| "verification_document_not_uploaded", | |
| "verification_document_photo_mismatch", | |
| "verification_document_too_large", | |
| "verification_document_type_not_supported", | |
| "verification_failed_address_match", | |
| "verification_failed_business_iec_number", | |
| "verification_failed_document_match", | |
| "verification_failed_id_number_match", | |
| "verification_failed_keyed_identity", | |
| "verification_failed_keyed_match", | |
| "verification_failed_name_match", | |
| "verification_failed_other", | |
| "verification_failed_tax_id_match", | |
| "verification_failed_tax_id_not_issued", | |
| "verification_missing_executives", | |
| "verification_missing_owners", | |
| "verification_requires_additional_memorandum_of_associations" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Person.Verification": { | |
| "properties": { | |
| "additional_document": { | |
| "$ref": "#/definitions/Stripe.Person.Verification.AdditionalDocument", | |
| "description": "A document showing address, either a passport, local ID card, or utility bill from a well-known utility company." | |
| }, | |
| "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\".", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "document": { | |
| "$ref": "#/definitions/Stripe.Person.Verification.Document" | |
| }, | |
| "status": { | |
| "description": "The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Person.Verification.AdditionalDocument": { | |
| "properties": { | |
| "back": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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`." | |
| }, | |
| "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\".", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "front": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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`." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Person.Verification.Document": { | |
| "properties": { | |
| "back": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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`." | |
| }, | |
| "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\".", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "front": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.File" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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`." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Plan": { | |
| "description": "The Plan object.", | |
| "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" | |
| ], | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "description": "The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.", | |
| "type": "number" | |
| }, | |
| "amount_decimal": { | |
| "description": "The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.", | |
| "type": "string" | |
| }, | |
| "billing_scheme": { | |
| "$ref": "#/definitions/Stripe.Plan.BillingScheme", | |
| "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." | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "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" | |
| }, | |
| "deleted": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "interval": { | |
| "$ref": "#/definitions/Stripe.Plan.Interval", | |
| "description": "The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`." | |
| }, | |
| "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": "number" | |
| }, | |
| "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": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "nickname": { | |
| "description": "A brief description of the plan, hidden from customers.", | |
| "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": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Product" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedProduct" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The product whose pricing this plan determines." | |
| }, | |
| "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": "#/definitions/Stripe.Plan.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" | |
| ], | |
| "type": "string" | |
| }, | |
| "transform_usage": { | |
| "$ref": "#/definitions/Stripe.Plan.TransformUsage", | |
| "description": "Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`." | |
| }, | |
| "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).", | |
| "type": "number" | |
| }, | |
| "usage_type": { | |
| "$ref": "#/definitions/Stripe.Plan.UsageType", | |
| "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`." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Plan.BillingScheme": { | |
| "enum": [ | |
| "per_unit", | |
| "tiered" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Plan.Interval": { | |
| "enum": [ | |
| "day", | |
| "month", | |
| "week", | |
| "year" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Plan.Tier": { | |
| "properties": { | |
| "flat_amount": { | |
| "description": "Price for the entire tier.", | |
| "type": "number" | |
| }, | |
| "flat_amount_decimal": { | |
| "description": "Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.", | |
| "type": "string" | |
| }, | |
| "unit_amount": { | |
| "description": "Per unit price for units relevant to the tier.", | |
| "type": "number" | |
| }, | |
| "unit_amount_decimal": { | |
| "description": "Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.", | |
| "type": "string" | |
| }, | |
| "up_to": { | |
| "description": "Up to and including to this quantity will be contained in the tier.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Plan.TransformUsage": { | |
| "properties": { | |
| "divide_by": { | |
| "description": "Divide usage by this number.", | |
| "type": "number" | |
| }, | |
| "round": { | |
| "$ref": "#/definitions/Stripe.Plan.TransformUsage.Round", | |
| "description": "After division, either round the result `up` or `down`." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Plan.TransformUsage.Round": { | |
| "enum": [ | |
| "down", | |
| "up" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Plan.UsageType": { | |
| "enum": [ | |
| "licensed", | |
| "metered" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.PlansResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.PlatformTaxFee": { | |
| "description": "The PlatformTaxFee object.", | |
| "properties": { | |
| "account": { | |
| "description": "The Connected account that incurred this charge.", | |
| "type": "string" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "type": { | |
| "description": "The type of tax (VAT).", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Price": { | |
| "description": "The Price object.", | |
| "properties": { | |
| "active": { | |
| "description": "Whether the price can be used for new purchases.", | |
| "type": "boolean" | |
| }, | |
| "billing_scheme": { | |
| "$ref": "#/definitions/Stripe.Price.BillingScheme", | |
| "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." | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "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" | |
| }, | |
| "deleted": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "metadata": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "nickname": { | |
| "description": "A brief description of the price, hidden from customers.", | |
| "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": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Product" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedProduct" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The ID of the product this price is associated with." | |
| }, | |
| "recurring": { | |
| "$ref": "#/definitions/Stripe.Price.Recurring", | |
| "description": "The recurring components of a price such as `interval` and `usage_type`." | |
| }, | |
| "tax_behavior": { | |
| "description": "Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.", | |
| "enum": [ | |
| "exclusive", | |
| "inclusive", | |
| "unspecified" | |
| ], | |
| "type": "string" | |
| }, | |
| "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": "#/definitions/Stripe.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" | |
| ], | |
| "type": "string" | |
| }, | |
| "transform_quantity": { | |
| "$ref": "#/definitions/Stripe.Price.TransformQuantity", | |
| "description": "Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`." | |
| }, | |
| "type": { | |
| "$ref": "#/definitions/Stripe.Price.Type", | |
| "description": "One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase." | |
| }, | |
| "unit_amount": { | |
| "description": "The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.", | |
| "type": "number" | |
| }, | |
| "unit_amount_decimal": { | |
| "description": "The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Price.BillingScheme": { | |
| "enum": [ | |
| "per_unit", | |
| "tiered" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Price.Recurring": { | |
| "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" | |
| ], | |
| "type": "string" | |
| }, | |
| "interval": { | |
| "$ref": "#/definitions/Stripe.Price.Recurring.Interval", | |
| "description": "The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`." | |
| }, | |
| "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": "number" | |
| }, | |
| "trial_period_days": { | |
| "description": "Default number of trial days when subscribing a customer to this price using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).", | |
| "type": "number" | |
| }, | |
| "usage_type": { | |
| "$ref": "#/definitions/Stripe.Price.Recurring.UsageType", | |
| "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`." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Price.Recurring.Interval": { | |
| "enum": [ | |
| "day", | |
| "month", | |
| "week", | |
| "year" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Price.Recurring.UsageType": { | |
| "enum": [ | |
| "licensed", | |
| "metered" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Price.Tier": { | |
| "properties": { | |
| "flat_amount": { | |
| "description": "Price for the entire tier.", | |
| "type": "number" | |
| }, | |
| "flat_amount_decimal": { | |
| "description": "Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.", | |
| "type": "string" | |
| }, | |
| "unit_amount": { | |
| "description": "Per unit price for units relevant to the tier.", | |
| "type": "number" | |
| }, | |
| "unit_amount_decimal": { | |
| "description": "Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.", | |
| "type": "string" | |
| }, | |
| "up_to": { | |
| "description": "Up to and including to this quantity will be contained in the tier.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Price.TransformQuantity": { | |
| "properties": { | |
| "divide_by": { | |
| "description": "Divide usage by this number.", | |
| "type": "number" | |
| }, | |
| "round": { | |
| "$ref": "#/definitions/Stripe.Price.TransformQuantity.Round", | |
| "description": "After division, either round the result `up` or `down`." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Price.TransformQuantity.Round": { | |
| "enum": [ | |
| "down", | |
| "up" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Price.Type": { | |
| "enum": [ | |
| "one_time", | |
| "recurring" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.PricesResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Product": { | |
| "description": "The Product object.", | |
| "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": { | |
| "type": "string" | |
| }, | |
| "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`.", | |
| "type": "string" | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "deactivate_on": { | |
| "description": "An array of connect application identifiers that cannot purchase this product. Only applicable to products of `type=good`.", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "deleted": { | |
| "type": "string" | |
| }, | |
| "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.", | |
| "type": "string" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "images": { | |
| "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.", | |
| "items": { | |
| "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": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "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.", | |
| "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": { | |
| "$ref": "#/definitions/Stripe.Product.PackageDimensions", | |
| "description": "The dimensions of this product for shipping purposes." | |
| }, | |
| "shippable": { | |
| "description": "Whether this product is shipped (i.e., physical goods).", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "tax_code": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.TaxCode" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "A [tax code](https://stripe.com/docs/tax/tax-codes) ID." | |
| }, | |
| "type": { | |
| "$ref": "#/definitions/Stripe.Product.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." | |
| }, | |
| "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.", | |
| "type": "string" | |
| }, | |
| "updated": { | |
| "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "url": { | |
| "description": "A URL of a publicly-accessible webpage for this product.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Product.PackageDimensions": { | |
| "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" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Product.Type": { | |
| "enum": [ | |
| "good", | |
| "service" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.ProductsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.PromotionCode": { | |
| "description": "The PromotionCode object.", | |
| "properties": { | |
| "active": { | |
| "description": "Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.", | |
| "type": "boolean" | |
| }, | |
| "code": { | |
| "description": "The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer.", | |
| "type": "string" | |
| }, | |
| "coupon": { | |
| "$ref": "#/definitions/Stripe.Coupon", | |
| "description": "A coupon contains information about a percent-off or amount-off discount you\nmight want to apply to a customer. Coupons may be applied to [invoices](https://stripe.com/docs/api#invoices) or\n[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)." | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "customer": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Customer" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedCustomer" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The customer that this promotion code can be used by." | |
| }, | |
| "expires_at": { | |
| "description": "Date at which the promotion code can no longer be redeemed.", | |
| "type": "number" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "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 promotion code can be redeemed.", | |
| "type": "number" | |
| }, | |
| "metadata": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "promotion_code" | |
| ], | |
| "type": "string" | |
| }, | |
| "restrictions": { | |
| "$ref": "#/definitions/Stripe.PromotionCode.Restrictions" | |
| }, | |
| "times_redeemed": { | |
| "description": "Number of times this promotion code has been used.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PromotionCode.Restrictions": { | |
| "properties": { | |
| "first_time_transaction": { | |
| "description": "A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices", | |
| "type": "boolean" | |
| }, | |
| "minimum_amount": { | |
| "description": "Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).", | |
| "type": "number" | |
| }, | |
| "minimum_amount_currency": { | |
| "description": "Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.PromotionCodesResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Quote": { | |
| "description": "The Quote object.", | |
| "properties": { | |
| "amount_subtotal": { | |
| "description": "Total before any discounts or taxes are applied.", | |
| "type": "number" | |
| }, | |
| "amount_total": { | |
| "description": "Total after discounts and taxes are applied.", | |
| "type": "number" | |
| }, | |
| "application_fee_amount": { | |
| "description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote.", | |
| "type": "number" | |
| }, | |
| "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. Only applicable if there are line items with recurring prices on the quote.", | |
| "type": "number" | |
| }, | |
| "automatic_tax": { | |
| "$ref": "#/definitions/Stripe.Quote.AutomaticTax" | |
| }, | |
| "collection_method": { | |
| "$ref": "#/definitions/Stripe.Quote.CollectionMethod", | |
| "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions. Defaults to `charge_automatically`." | |
| }, | |
| "computed": { | |
| "$ref": "#/definitions/Stripe.Quote.Computed" | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "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": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Customer" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedCustomer" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed." | |
| }, | |
| "default_tax_rates": { | |
| "description": "The tax rates applied to this quote.", | |
| "items": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.TaxRate" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ] | |
| }, | |
| "type": "array" | |
| }, | |
| "description": { | |
| "description": "A description that will be displayed on the quote PDF.", | |
| "type": "string" | |
| }, | |
| "discounts": { | |
| "description": "The discounts applied to this quote.", | |
| "items": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Discount" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ] | |
| }, | |
| "type": "array" | |
| }, | |
| "expires_at": { | |
| "description": "The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "footer": { | |
| "description": "A footer that will be displayed on the quote PDF.", | |
| "type": "string" | |
| }, | |
| "from_quote": { | |
| "$ref": "#/definitions/Stripe.Quote.FromQuote", | |
| "description": "Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details." | |
| }, | |
| "header": { | |
| "description": "A header that will be displayed on the quote PDF.", | |
| "type": "string" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "invoice": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Invoice" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedInvoice" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The invoice that was created from this quote." | |
| }, | |
| "invoice_settings": { | |
| "$ref": "#/definitions/Stripe.Quote.InvoiceSettings", | |
| "description": "All invoices will be billed using the specified settings." | |
| }, | |
| "line_items": { | |
| "$ref": "#/definitions/Stripe.ApiList<Stripe.LineItem>", | |
| "description": "A list of items the customer is being quoted for." | |
| }, | |
| "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": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "number": { | |
| "description": "A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://stripe.com/docs/quotes/overview#finalize).", | |
| "type": "string" | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "quote" | |
| ], | |
| "type": "string" | |
| }, | |
| "on_behalf_of": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Account" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details." | |
| }, | |
| "status": { | |
| "$ref": "#/definitions/Stripe.Quote.Status", | |
| "description": "The status of the quote." | |
| }, | |
| "status_transitions": { | |
| "$ref": "#/definitions/Stripe.Quote.StatusTransitions" | |
| }, | |
| "subscription": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Subscription" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The subscription that was created or updated from this quote." | |
| }, | |
| "subscription_data": { | |
| "$ref": "#/definitions/Stripe.Quote.SubscriptionData" | |
| }, | |
| "subscription_schedule": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.SubscriptionSchedule" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The subscription schedule that was created or updated from this quote." | |
| }, | |
| "total_details": { | |
| "$ref": "#/definitions/Stripe.Quote.TotalDetails" | |
| }, | |
| "transfer_data": { | |
| "$ref": "#/definitions/Stripe.Quote.TransferData", | |
| "description": "The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Quote.AutomaticTax": { | |
| "properties": { | |
| "enabled": { | |
| "description": "Automatically calculate taxes", | |
| "type": "boolean" | |
| }, | |
| "status": { | |
| "description": "The status of the most recent automated tax calculation for this quote.", | |
| "enum": [ | |
| "complete", | |
| "failed", | |
| "requires_location_inputs" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Quote.CollectionMethod": { | |
| "enum": [ | |
| "charge_automatically", | |
| "send_invoice" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Quote.Computed": { | |
| "properties": { | |
| "recurring": { | |
| "$ref": "#/definitions/Stripe.Quote.Computed.Recurring", | |
| "description": "The definitive totals and line items the customer will be charged on a recurring basis. Takes into account the line items with recurring prices and discounts with `duration=forever` coupons only. Defaults to `null` if no inputted line items with recurring prices." | |
| }, | |
| "upfront": { | |
| "$ref": "#/definitions/Stripe.Quote.Computed.Upfront" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Quote.Computed.Recurring": { | |
| "properties": { | |
| "amount_subtotal": { | |
| "description": "Total before any discounts or taxes are applied.", | |
| "type": "number" | |
| }, | |
| "amount_total": { | |
| "description": "Total after discounts and taxes are applied.", | |
| "type": "number" | |
| }, | |
| "interval": { | |
| "$ref": "#/definitions/Stripe.Quote.Computed.Recurring.Interval", | |
| "description": "The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`." | |
| }, | |
| "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": "number" | |
| }, | |
| "total_details": { | |
| "$ref": "#/definitions/Stripe.Quote.Computed.Recurring.TotalDetails" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Quote.Computed.Recurring.Interval": { | |
| "enum": [ | |
| "day", | |
| "month", | |
| "week", | |
| "year" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Quote.Computed.Recurring.TotalDetails": { | |
| "properties": { | |
| "amount_discount": { | |
| "description": "This is the sum of all the line item discounts.", | |
| "type": "number" | |
| }, | |
| "amount_shipping": { | |
| "description": "This is the sum of all the line item shipping amounts.", | |
| "type": "number" | |
| }, | |
| "amount_tax": { | |
| "description": "This is the sum of all the line item tax amounts.", | |
| "type": "number" | |
| }, | |
| "breakdown": { | |
| "$ref": "#/definitions/Stripe.Quote.Computed.Recurring.TotalDetails.Breakdown" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Quote.Computed.Recurring.TotalDetails.Breakdown": { | |
| "properties": { | |
| "discounts": { | |
| "description": "The aggregated line item discounts.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.Quote.Computed.Recurring.TotalDetails.Breakdown.Discount" | |
| }, | |
| "type": "array" | |
| }, | |
| "taxes": { | |
| "description": "The aggregated line item tax amounts by rate.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.Quote.Computed.Recurring.TotalDetails.Breakdown.Tax" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Quote.Computed.Recurring.TotalDetails.Breakdown.Discount": { | |
| "properties": { | |
| "amount": { | |
| "description": "The amount discounted.", | |
| "type": "number" | |
| }, | |
| "discount": { | |
| "$ref": "#/definitions/Stripe.Discount", | |
| "description": "A discount represents the actual application of a coupon to a particular\ncustomer. It contains information about when the discount began and when it\nwill end.\n\nRelated guide: [Applying Discounts to Subscriptions](https://stripe.com/docs/billing/subscriptions/discounts)." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Quote.Computed.Recurring.TotalDetails.Breakdown.Tax": { | |
| "properties": { | |
| "amount": { | |
| "description": "Amount of tax applied for this rate.", | |
| "type": "number" | |
| }, | |
| "rate": { | |
| "$ref": "#/definitions/Stripe.TaxRate", | |
| "description": "Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax.\n\nRelated guide: [Tax Rates](https://stripe.com/docs/billing/taxes/tax-rates)." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Quote.Computed.Upfront": { | |
| "properties": { | |
| "amount_subtotal": { | |
| "description": "Total before any discounts or taxes are applied.", | |
| "type": "number" | |
| }, | |
| "amount_total": { | |
| "description": "Total after discounts and taxes are applied.", | |
| "type": "number" | |
| }, | |
| "line_items": { | |
| "$ref": "#/definitions/Stripe.ApiList<Stripe.LineItem>", | |
| "description": "The line items that will appear on the next invoice after this quote is accepted. This does not include pending invoice items that exist on the customer but may still be included in the next invoice." | |
| }, | |
| "total_details": { | |
| "$ref": "#/definitions/Stripe.Quote.Computed.Upfront.TotalDetails" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Quote.Computed.Upfront.TotalDetails": { | |
| "properties": { | |
| "amount_discount": { | |
| "description": "This is the sum of all the line item discounts.", | |
| "type": "number" | |
| }, | |
| "amount_shipping": { | |
| "description": "This is the sum of all the line item shipping amounts.", | |
| "type": "number" | |
| }, | |
| "amount_tax": { | |
| "description": "This is the sum of all the line item tax amounts.", | |
| "type": "number" | |
| }, | |
| "breakdown": { | |
| "$ref": "#/definitions/Stripe.Quote.Computed.Upfront.TotalDetails.Breakdown" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Quote.Computed.Upfront.TotalDetails.Breakdown": { | |
| "properties": { | |
| "discounts": { | |
| "description": "The aggregated line item discounts.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.Quote.Computed.Upfront.TotalDetails.Breakdown.Discount" | |
| }, | |
| "type": "array" | |
| }, | |
| "taxes": { | |
| "description": "The aggregated line item tax amounts by rate.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.Quote.Computed.Upfront.TotalDetails.Breakdown.Tax" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Quote.Computed.Upfront.TotalDetails.Breakdown.Discount": { | |
| "properties": { | |
| "amount": { | |
| "description": "The amount discounted.", | |
| "type": "number" | |
| }, | |
| "discount": { | |
| "$ref": "#/definitions/Stripe.Discount", | |
| "description": "A discount represents the actual application of a coupon to a particular\ncustomer. It contains information about when the discount began and when it\nwill end.\n\nRelated guide: [Applying Discounts to Subscriptions](https://stripe.com/docs/billing/subscriptions/discounts)." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Quote.Computed.Upfront.TotalDetails.Breakdown.Tax": { | |
| "properties": { | |
| "amount": { | |
| "description": "Amount of tax applied for this rate.", | |
| "type": "number" | |
| }, | |
| "rate": { | |
| "$ref": "#/definitions/Stripe.TaxRate", | |
| "description": "Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax.\n\nRelated guide: [Tax Rates](https://stripe.com/docs/billing/taxes/tax-rates)." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Quote.FromQuote": { | |
| "properties": { | |
| "is_revision": { | |
| "description": "Whether this quote is a revision of a different quote.", | |
| "type": "boolean" | |
| }, | |
| "quote": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Quote" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The quote that was cloned." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Quote.InvoiceSettings": { | |
| "properties": { | |
| "days_until_due": { | |
| "description": "Number of days within which a customer must pay invoices generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Quote.Status": { | |
| "enum": [ | |
| "accepted", | |
| "canceled", | |
| "draft", | |
| "open" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Quote.StatusTransitions": { | |
| "properties": { | |
| "accepted_at": { | |
| "description": "The time that the quote was accepted. Measured in seconds since Unix epoch.", | |
| "type": "number" | |
| }, | |
| "canceled_at": { | |
| "description": "The time that the quote was canceled. Measured in seconds since Unix epoch.", | |
| "type": "number" | |
| }, | |
| "finalized_at": { | |
| "description": "The time that the quote was finalized. Measured in seconds since Unix epoch.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Quote.SubscriptionData": { | |
| "properties": { | |
| "effective_date": { | |
| "description": "When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "trial_period_days": { | |
| "description": "Integer representing the number of trial period days before the customer is charged for the first time.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Quote.TotalDetails": { | |
| "properties": { | |
| "amount_discount": { | |
| "description": "This is the sum of all the line item discounts.", | |
| "type": "number" | |
| }, | |
| "amount_shipping": { | |
| "description": "This is the sum of all the line item shipping amounts.", | |
| "type": "number" | |
| }, | |
| "amount_tax": { | |
| "description": "This is the sum of all the line item tax amounts.", | |
| "type": "number" | |
| }, | |
| "breakdown": { | |
| "$ref": "#/definitions/Stripe.Quote.TotalDetails.Breakdown" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Quote.TotalDetails.Breakdown": { | |
| "properties": { | |
| "discounts": { | |
| "description": "The aggregated line item discounts.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.Quote.TotalDetails.Breakdown.Discount" | |
| }, | |
| "type": "array" | |
| }, | |
| "taxes": { | |
| "description": "The aggregated line item tax amounts by rate.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.Quote.TotalDetails.Breakdown.Tax" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Quote.TotalDetails.Breakdown.Discount": { | |
| "properties": { | |
| "amount": { | |
| "description": "The amount discounted.", | |
| "type": "number" | |
| }, | |
| "discount": { | |
| "$ref": "#/definitions/Stripe.Discount", | |
| "description": "A discount represents the actual application of a coupon to a particular\ncustomer. It contains information about when the discount began and when it\nwill end.\n\nRelated guide: [Applying Discounts to Subscriptions](https://stripe.com/docs/billing/subscriptions/discounts)." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Quote.TotalDetails.Breakdown.Tax": { | |
| "properties": { | |
| "amount": { | |
| "description": "Amount of tax applied for this rate.", | |
| "type": "number" | |
| }, | |
| "rate": { | |
| "$ref": "#/definitions/Stripe.TaxRate", | |
| "description": "Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax.\n\nRelated guide: [Tax Rates](https://stripe.com/docs/billing/taxes/tax-rates)." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Quote.TransferData": { | |
| "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.", | |
| "type": "number" | |
| }, | |
| "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 will be transferred to the destination.", | |
| "type": "number" | |
| }, | |
| "destination": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Account" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The account where funds from the payment will be transferred to upon payment success." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.QuotesResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Radar.EarlyFraudWarningsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Radar.ValueListItemsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Radar.ValueListsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.RawErrorType": { | |
| "enum": [ | |
| "api_error", | |
| "authentication_error", | |
| "card_error", | |
| "idempotency_error", | |
| "invalid_grant", | |
| "invalid_request_error", | |
| "rate_limit_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Recipient": { | |
| "description": "The Recipient object.", | |
| "properties": { | |
| "active_account": { | |
| "$ref": "#/definitions/Stripe.BankAccount", | |
| "description": "Hash describing the current account on the recipient, if there is one." | |
| }, | |
| "cards": { | |
| "$ref": "#/definitions/Stripe.ApiList<Stripe.Card>" | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "default_card": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Card" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The default card to use for creating transfers to this recipient." | |
| }, | |
| "deleted": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "description": "An arbitrary string attached to the object. Often useful for displaying to users.", | |
| "type": "string" | |
| }, | |
| "email": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "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": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "migrated_to": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Account" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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." | |
| }, | |
| "name": { | |
| "description": "Full, legal name of the recipient.", | |
| "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": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Account" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ] | |
| }, | |
| "type": { | |
| "description": "Type of the recipient, one of `individual` or `corporation`.", | |
| "type": "string" | |
| }, | |
| "verified": { | |
| "description": "Whether the recipient has been verified. This field is non-standard, and maybe removed in the future", | |
| "type": "boolean" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Refund": { | |
| "description": "The Refund object.", | |
| "properties": { | |
| "amount": { | |
| "description": "Amount, in %s.", | |
| "type": "number" | |
| }, | |
| "balance_transaction": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.BalanceTransaction" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "Balance transaction that describes the impact on your account balance." | |
| }, | |
| "charge": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Charge" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the charge that was refunded." | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "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)", | |
| "type": "string" | |
| }, | |
| "failure_balance_transaction": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.BalanceTransaction" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "If the refund failed, this balance transaction describes the adjustment made on your account balance that reverses the initial 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`.", | |
| "type": "string" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "metadata": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "refund" | |
| ], | |
| "type": "string" | |
| }, | |
| "payment_intent": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.PaymentIntent" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the PaymentIntent that was refunded." | |
| }, | |
| "reason": { | |
| "description": "Reason for the refund, either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`).", | |
| "type": "string" | |
| }, | |
| "receipt_number": { | |
| "description": "This is the transaction number that appears on email receipts sent for this refund.", | |
| "type": "string" | |
| }, | |
| "source_transfer_reversal": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.TransferReversal" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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." | |
| }, | |
| "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.", | |
| "type": "string" | |
| }, | |
| "transfer_reversal": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.TransferReversal" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "If the accompanying transfer was reversed, the transfer reversal object. Only applicable if the charge was created using the destination parameter." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.RefundsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Reporting.ReportRunsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Reporting.ReportTypesResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.ReserveTransaction": { | |
| "description": "The ReserveTransaction object.", | |
| "properties": { | |
| "amount": { | |
| "type": "number" | |
| }, | |
| "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.", | |
| "type": "string" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "reserve_transaction" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Review": { | |
| "description": "The Review object.", | |
| "properties": { | |
| "billing_zip": { | |
| "description": "The ZIP or postal code of the card used, if applicable.", | |
| "type": "string" | |
| }, | |
| "charge": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Charge" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The charge associated with this review." | |
| }, | |
| "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`, `disputed`, or `redacted`.", | |
| "enum": [ | |
| "approved", | |
| "disputed", | |
| "redacted", | |
| "refunded", | |
| "refunded_as_fraud" | |
| ], | |
| "type": "string" | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "ip_address": { | |
| "description": "The IP address where the payment originated.", | |
| "type": "string" | |
| }, | |
| "ip_address_location": { | |
| "$ref": "#/definitions/Stripe.Review.IpAddressLocation", | |
| "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." | |
| }, | |
| "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": { | |
| "$ref": "#/definitions/Stripe.Review.OpenedReason", | |
| "description": "The reason the review was opened. One of `rule` or `manual`." | |
| }, | |
| "payment_intent": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.PaymentIntent" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The PaymentIntent ID associated with this review, if one exists." | |
| }, | |
| "reason": { | |
| "description": "The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`.", | |
| "type": "string" | |
| }, | |
| "session": { | |
| "$ref": "#/definitions/Stripe.Review.Session", | |
| "description": "Information related to the browsing session of the user who initiated the payment." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Review.IpAddressLocation": { | |
| "properties": { | |
| "city": { | |
| "description": "The city where the payment originated.", | |
| "type": "string" | |
| }, | |
| "country": { | |
| "description": "Two-letter ISO code representing the country where the payment originated.", | |
| "type": "string" | |
| }, | |
| "latitude": { | |
| "description": "The geographic latitude where the payment originated.", | |
| "type": "number" | |
| }, | |
| "longitude": { | |
| "description": "The geographic longitude where the payment originated.", | |
| "type": "number" | |
| }, | |
| "region": { | |
| "description": "The state/county/province/region where the payment originated.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Review.OpenedReason": { | |
| "enum": [ | |
| "manual", | |
| "rule" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Review.Session": { | |
| "properties": { | |
| "browser": { | |
| "description": "The browser used in this browser session (e.g., `Chrome`).", | |
| "type": "string" | |
| }, | |
| "device": { | |
| "description": "Information about the device used for the browser session (e.g., `Samsung SM-G930T`).", | |
| "type": "string" | |
| }, | |
| "platform": { | |
| "description": "The platform for the browser session (e.g., `Macintosh`).", | |
| "type": "string" | |
| }, | |
| "version": { | |
| "description": "The version for the browser session (e.g., `61.0.3163.100`).", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.ReviewsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.SetupAttempt": { | |
| "description": "The SetupAttempt object.", | |
| "properties": { | |
| "application": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Application" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The value of [application](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-application) on the SetupIntent at the time of this confirmation." | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "customer": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Customer" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedCustomer" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The value of [customer](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-customer) on the SetupIntent at the time of this confirmation." | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "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": [ | |
| "setup_attempt" | |
| ], | |
| "type": "string" | |
| }, | |
| "on_behalf_of": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Account" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The value of [on_behalf_of](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-on_behalf_of) on the SetupIntent at the time of this confirmation." | |
| }, | |
| "payment_method": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.PaymentMethod" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the payment method used with this SetupAttempt." | |
| }, | |
| "payment_method_details": { | |
| "$ref": "#/definitions/Stripe.SetupAttempt.PaymentMethodDetails" | |
| }, | |
| "setup_error": { | |
| "$ref": "#/definitions/Stripe.SetupAttempt.SetupError", | |
| "description": "The error encountered during this attempt to confirm the SetupIntent, if any." | |
| }, | |
| "setup_intent": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.SetupIntent" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the SetupIntent that this attempt belongs to." | |
| }, | |
| "status": { | |
| "description": "Status of this SetupAttempt, one of `requires_confirmation`, `requires_action`, `processing`, `succeeded`, `failed`, or `abandoned`.", | |
| "type": "string" | |
| }, | |
| "usage": { | |
| "description": "The value of [usage](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-usage) on the SetupIntent at the time of this confirmation, one of `off_session` or `on_session`.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SetupAttempt.PaymentMethodDetails": { | |
| "properties": { | |
| "acss_debit": { | |
| "$ref": "#/definitions/Stripe.SetupAttempt.PaymentMethodDetails.AcssDebit" | |
| }, | |
| "au_becs_debit": { | |
| "$ref": "#/definitions/Stripe.SetupAttempt.PaymentMethodDetails.AuBecsDebit" | |
| }, | |
| "bacs_debit": { | |
| "$ref": "#/definitions/Stripe.SetupAttempt.PaymentMethodDetails.BacsDebit" | |
| }, | |
| "bancontact": { | |
| "$ref": "#/definitions/Stripe.SetupAttempt.PaymentMethodDetails.Bancontact" | |
| }, | |
| "card": { | |
| "$ref": "#/definitions/Stripe.SetupAttempt.PaymentMethodDetails.Card" | |
| }, | |
| "card_present": { | |
| "$ref": "#/definitions/Stripe.SetupAttempt.PaymentMethodDetails.CardPresent" | |
| }, | |
| "ideal": { | |
| "$ref": "#/definitions/Stripe.SetupAttempt.PaymentMethodDetails.Ideal" | |
| }, | |
| "sepa_debit": { | |
| "$ref": "#/definitions/Stripe.SetupAttempt.PaymentMethodDetails.SepaDebit" | |
| }, | |
| "sofort": { | |
| "$ref": "#/definitions/Stripe.SetupAttempt.PaymentMethodDetails.Sofort" | |
| }, | |
| "type": { | |
| "description": "The type of the payment method used in the SetupIntent (e.g., `card`). An additional hash is included on `payment_method_details` with a name matching this value. It contains confirmation-specific information for the payment method.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SetupAttempt.PaymentMethodDetails.AcssDebit": { | |
| "type": "object" | |
| }, | |
| "Stripe.SetupAttempt.PaymentMethodDetails.AuBecsDebit": { | |
| "type": "object" | |
| }, | |
| "Stripe.SetupAttempt.PaymentMethodDetails.BacsDebit": { | |
| "type": "object" | |
| }, | |
| "Stripe.SetupAttempt.PaymentMethodDetails.Bancontact": { | |
| "properties": { | |
| "bank_code": { | |
| "description": "Bank code of bank associated with the bank account.", | |
| "type": "string" | |
| }, | |
| "bank_name": { | |
| "description": "Name of the bank associated with the bank account.", | |
| "type": "string" | |
| }, | |
| "bic": { | |
| "description": "Bank Identifier Code of the bank associated with the bank account.", | |
| "type": "string" | |
| }, | |
| "generated_sepa_debit": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.PaymentMethod" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt." | |
| }, | |
| "generated_sepa_debit_mandate": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Mandate" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt." | |
| }, | |
| "iban_last4": { | |
| "description": "Last four characters of the IBAN.", | |
| "type": "string" | |
| }, | |
| "preferred_language": { | |
| "description": "Preferred language of the Bancontact authorization page that the customer is redirected to.\nCan be one of `en`, `de`, `fr`, or `nl`", | |
| "enum": [ | |
| "de", | |
| "en", | |
| "fr", | |
| "nl" | |
| ], | |
| "type": "string" | |
| }, | |
| "verified_name": { | |
| "description": "Owner's verified full name. Values are verified or provided by Bancontact directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SetupAttempt.PaymentMethodDetails.Card": { | |
| "properties": { | |
| "three_d_secure": { | |
| "$ref": "#/definitions/Stripe.SetupAttempt.PaymentMethodDetails.Card.ThreeDSecure", | |
| "description": "Populated if this authorization used 3D Secure authentication." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SetupAttempt.PaymentMethodDetails.Card.ThreeDSecure": { | |
| "properties": { | |
| "authentication_flow": { | |
| "description": "For authenticated transactions: how the customer was authenticated by\nthe issuing bank.", | |
| "enum": [ | |
| "challenge", | |
| "frictionless" | |
| ], | |
| "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\non the `result`.", | |
| "enum": [ | |
| "abandoned", | |
| "bypassed", | |
| "canceled", | |
| "card_not_enrolled", | |
| "network_not_supported", | |
| "protocol_error", | |
| "rejected" | |
| ], | |
| "type": "string" | |
| }, | |
| "version": { | |
| "description": "The version of 3D Secure that was used.", | |
| "enum": [ | |
| "1.0.2", | |
| "2.1.0", | |
| "2.2.0" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SetupAttempt.PaymentMethodDetails.CardPresent": { | |
| "properties": { | |
| "generated_card": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.PaymentMethod" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The ID of the Card PaymentMethod which was generated by this SetupAttempt." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SetupAttempt.PaymentMethodDetails.Ideal": { | |
| "properties": { | |
| "bank": { | |
| "description": "The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, or `van_lanschot`.", | |
| "enum": [ | |
| "abn_amro", | |
| "asn_bank", | |
| "bunq", | |
| "handelsbanken", | |
| "ing", | |
| "knab", | |
| "moneyou", | |
| "rabobank", | |
| "regiobank", | |
| "revolut", | |
| "sns_bank", | |
| "triodos_bank", | |
| "van_lanschot" | |
| ], | |
| "type": "string" | |
| }, | |
| "bic": { | |
| "description": "The Bank Identifier Code of the customer's bank.", | |
| "enum": [ | |
| "ABNANL2A", | |
| "ASNBNL21", | |
| "BUNQNL2A", | |
| "FVLBNL22", | |
| "HANDNL2A", | |
| "INGBNL2A", | |
| "KNABNL2H", | |
| "MOYONL21", | |
| "RABONL2U", | |
| "RBRBNL21", | |
| "REVOLT21", | |
| "SNSBNL2A", | |
| "TRIONL2U" | |
| ], | |
| "type": "string" | |
| }, | |
| "generated_sepa_debit": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.PaymentMethod" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt." | |
| }, | |
| "generated_sepa_debit_mandate": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Mandate" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt." | |
| }, | |
| "iban_last4": { | |
| "description": "Last four characters of the IBAN.", | |
| "type": "string" | |
| }, | |
| "verified_name": { | |
| "description": "Owner's verified full name. Values are verified or provided by iDEAL directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SetupAttempt.PaymentMethodDetails.SepaDebit": { | |
| "type": "object" | |
| }, | |
| "Stripe.SetupAttempt.PaymentMethodDetails.Sofort": { | |
| "properties": { | |
| "bank_code": { | |
| "description": "Bank code of bank associated with the bank account.", | |
| "type": "string" | |
| }, | |
| "bank_name": { | |
| "description": "Name of the bank associated with the bank account.", | |
| "type": "string" | |
| }, | |
| "bic": { | |
| "description": "Bank Identifier Code of the bank associated with the bank account.", | |
| "type": "string" | |
| }, | |
| "generated_sepa_debit": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.PaymentMethod" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt." | |
| }, | |
| "generated_sepa_debit_mandate": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Mandate" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt." | |
| }, | |
| "iban_last4": { | |
| "description": "Last four characters of the IBAN.", | |
| "type": "string" | |
| }, | |
| "preferred_language": { | |
| "description": "Preferred language of the Sofort authorization page that the customer is redirected to.\nCan be one of `en`, `de`, `fr`, or `nl`", | |
| "enum": [ | |
| "de", | |
| "en", | |
| "fr", | |
| "nl" | |
| ], | |
| "type": "string" | |
| }, | |
| "verified_name": { | |
| "description": "Owner's verified full name. Values are verified or provided by Sofort directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SetupAttempt.SetupError": { | |
| "properties": { | |
| "charge": { | |
| "description": "For card errors, the ID of the failed charge.", | |
| "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.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "doc_url": { | |
| "description": "A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.", | |
| "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.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "payment_intent": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent", | |
| "description": "A PaymentIntent guides you through the process of collecting a payment from your customer.\nWe recommend that you create exactly one PaymentIntent for each order or\ncustomer session in your system. You can reference the PaymentIntent later to\nsee the history of payment attempts for a particular session.\n\nA PaymentIntent transitions through\n[multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)\nthroughout its lifetime as it interfaces with Stripe.js to perform\nauthentication flows and ultimately creates at most one successful charge.\n\nRelated guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents)." | |
| }, | |
| "payment_method": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod", | |
| "description": "PaymentMethod objects represent your customer's payment instruments.\nThey can be used with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or saved to\nCustomer objects to store instrument details for future payments.\n\nRelated guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios)." | |
| }, | |
| "payment_method_type": { | |
| "description": "If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.", | |
| "type": "string" | |
| }, | |
| "setup_intent": { | |
| "$ref": "#/definitions/Stripe.SetupIntent", | |
| "description": "A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.\nFor example, you could use a SetupIntent to set up and save your customer's card without immediately collecting a payment.\nLater, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow.\n\nCreate a SetupIntent as soon as you're ready to collect your customer's payment credentials.\nDo not maintain long-lived, unconfirmed SetupIntents as they may no longer be valid.\nThe SetupIntent then transitions through multiple [statuses](https://stripe.com/docs/payments/intents#intent-statuses) as it guides\nyou through the setup process.\n\nSuccessful SetupIntents result in payment credentials that are optimized for future payments.\nFor example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) may need to be run through\n[Strong Customer Authentication](https://stripe.com/docs/strong-customer-authentication) at the time of payment method collection\nin order to streamline later [off-session payments](https://stripe.com/docs/payments/setup-intents).\nIf the SetupIntent is used with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer), upon success,\nit will automatically attach the resulting payment method to that Customer.\nWe recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on\nPaymentIntents to save payment methods in order to prevent saving invalid or unoptimized payment methods.\n\nBy using SetupIntents, you ensure that your customers experience the minimum set of required friction,\neven as regulations change over time.\n\nRelated guide: [Setup Intents API](https://stripe.com/docs/payments/setup-intents)." | |
| }, | |
| "source": { | |
| "anyOf": [ | |
| { | |
| "description": "The resulting source of [a Connect platform debiting a connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account).", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "object": { | |
| "enum": [ | |
| "account" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.AlipayAccount" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.BankAccount" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.BitcoinReceiver" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Card" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Source" | |
| } | |
| ] | |
| }, | |
| "type": { | |
| "$ref": "#/definitions/Stripe.SetupAttempt.SetupError.Type", | |
| "description": "The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SetupAttempt.SetupError.Type": { | |
| "enum": [ | |
| "api_error", | |
| "card_error", | |
| "idempotency_error", | |
| "invalid_request_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.SetupAttemptsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.SetupIntent": { | |
| "description": "The SetupIntent object.", | |
| "properties": { | |
| "application": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Application" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the Connect application that created the SetupIntent." | |
| }, | |
| "cancellation_reason": { | |
| "description": "Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`.", | |
| "enum": [ | |
| "abandoned", | |
| "duplicate", | |
| "requested_by_customer" | |
| ], | |
| "type": "string" | |
| }, | |
| "client_secret": { | |
| "description": "The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.\n\nThe 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.", | |
| "type": "string" | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "customer": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Customer" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedCustomer" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the Customer this SetupIntent belongs to, if one exists.\n\nIf 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." | |
| }, | |
| "description": { | |
| "description": "An arbitrary string attached to the object. Often useful for displaying to users.", | |
| "type": "string" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "last_setup_error": { | |
| "$ref": "#/definitions/Stripe.SetupIntent.LastSetupError", | |
| "description": "The error encountered in the previous SetupIntent confirmation." | |
| }, | |
| "latest_attempt": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.SetupAttempt" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The most recent SetupAttempt for this SetupIntent." | |
| }, | |
| "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": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Mandate" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the multi use Mandate generated by the SetupIntent." | |
| }, | |
| "metadata": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "next_action": { | |
| "$ref": "#/definitions/Stripe.SetupIntent.NextAction", | |
| "description": "If present, this property tells you what actions you need to take in order for your customer to continue payment setup." | |
| }, | |
| "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": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Account" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The account (if any) for which the setup is intended." | |
| }, | |
| "payment_method": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.PaymentMethod" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the payment method used with this SetupIntent." | |
| }, | |
| "payment_method_options": { | |
| "$ref": "#/definitions/Stripe.SetupIntent.PaymentMethodOptions", | |
| "description": "Payment-method-specific configuration for this SetupIntent." | |
| }, | |
| "payment_method_types": { | |
| "description": "The list of payment method types (e.g. card) that this SetupIntent is allowed to set up.", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "single_use_mandate": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Mandate" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the single_use Mandate generated by the SetupIntent." | |
| }, | |
| "status": { | |
| "$ref": "#/definitions/Stripe.SetupIntent.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`." | |
| }, | |
| "usage": { | |
| "description": "Indicates how the payment method is intended to be used in the future.\n\nUse `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`.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SetupIntent.LastSetupError": { | |
| "properties": { | |
| "charge": { | |
| "description": "For card errors, the ID of the failed charge.", | |
| "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.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "doc_url": { | |
| "description": "A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.", | |
| "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.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "payment_intent": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent", | |
| "description": "A PaymentIntent guides you through the process of collecting a payment from your customer.\nWe recommend that you create exactly one PaymentIntent for each order or\ncustomer session in your system. You can reference the PaymentIntent later to\nsee the history of payment attempts for a particular session.\n\nA PaymentIntent transitions through\n[multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)\nthroughout its lifetime as it interfaces with Stripe.js to perform\nauthentication flows and ultimately creates at most one successful charge.\n\nRelated guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents)." | |
| }, | |
| "payment_method": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod", | |
| "description": "PaymentMethod objects represent your customer's payment instruments.\nThey can be used with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or saved to\nCustomer objects to store instrument details for future payments.\n\nRelated guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios)." | |
| }, | |
| "payment_method_type": { | |
| "description": "If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.", | |
| "type": "string" | |
| }, | |
| "setup_intent": { | |
| "$ref": "#/definitions/Stripe.SetupIntent", | |
| "description": "A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.\nFor example, you could use a SetupIntent to set up and save your customer's card without immediately collecting a payment.\nLater, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow.\n\nCreate a SetupIntent as soon as you're ready to collect your customer's payment credentials.\nDo not maintain long-lived, unconfirmed SetupIntents as they may no longer be valid.\nThe SetupIntent then transitions through multiple [statuses](https://stripe.com/docs/payments/intents#intent-statuses) as it guides\nyou through the setup process.\n\nSuccessful SetupIntents result in payment credentials that are optimized for future payments.\nFor example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) may need to be run through\n[Strong Customer Authentication](https://stripe.com/docs/strong-customer-authentication) at the time of payment method collection\nin order to streamline later [off-session payments](https://stripe.com/docs/payments/setup-intents).\nIf the SetupIntent is used with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer), upon success,\nit will automatically attach the resulting payment method to that Customer.\nWe recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on\nPaymentIntents to save payment methods in order to prevent saving invalid or unoptimized payment methods.\n\nBy using SetupIntents, you ensure that your customers experience the minimum set of required friction,\neven as regulations change over time.\n\nRelated guide: [Setup Intents API](https://stripe.com/docs/payments/setup-intents)." | |
| }, | |
| "source": { | |
| "anyOf": [ | |
| { | |
| "description": "The resulting source of [a Connect platform debiting a connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account).", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "object": { | |
| "enum": [ | |
| "account" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.AlipayAccount" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.BankAccount" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.BitcoinReceiver" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Card" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Source" | |
| } | |
| ] | |
| }, | |
| "type": { | |
| "$ref": "#/definitions/Stripe.SetupIntent.LastSetupError.Type", | |
| "description": "The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SetupIntent.LastSetupError.Type": { | |
| "enum": [ | |
| "api_error", | |
| "card_error", | |
| "idempotency_error", | |
| "invalid_request_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.SetupIntent.NextAction": { | |
| "properties": { | |
| "redirect_to_url": { | |
| "$ref": "#/definitions/Stripe.SetupIntent.NextAction.RedirectToUrl" | |
| }, | |
| "type": { | |
| "description": "Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, or `oxxo_display_details`.", | |
| "type": "string" | |
| }, | |
| "use_stripe_sdk": { | |
| "$ref": "#/definitions/Stripe.SetupIntent.NextAction.UseStripeSdk", | |
| "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." | |
| }, | |
| "verify_with_microdeposits": { | |
| "$ref": "#/definitions/Stripe.SetupIntent.NextAction.VerifyWithMicrodeposits" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SetupIntent.NextAction.RedirectToUrl": { | |
| "properties": { | |
| "return_url": { | |
| "description": "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.", | |
| "type": "string" | |
| }, | |
| "url": { | |
| "description": "The URL you must redirect your customer to in order to authenticate.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SetupIntent.NextAction.UseStripeSdk": { | |
| "type": "object" | |
| }, | |
| "Stripe.SetupIntent.NextAction.VerifyWithMicrodeposits": { | |
| "properties": { | |
| "arrival_date": { | |
| "description": "The timestamp when the microdeposits are expected to land.", | |
| "type": "number" | |
| }, | |
| "hosted_verification_url": { | |
| "description": "The URL for the hosted verification page, which allows customers to verify their bank account.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SetupIntent.PaymentMethodOptions": { | |
| "properties": { | |
| "acss_debit": { | |
| "$ref": "#/definitions/Stripe.SetupIntent.PaymentMethodOptions.AcssDebit" | |
| }, | |
| "card": { | |
| "$ref": "#/definitions/Stripe.SetupIntent.PaymentMethodOptions.Card" | |
| }, | |
| "sepa_debit": { | |
| "$ref": "#/definitions/Stripe.SetupIntent.PaymentMethodOptions.SepaDebit" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SetupIntent.PaymentMethodOptions.AcssDebit": { | |
| "properties": { | |
| "currency": { | |
| "description": "Currency supported by the bank account", | |
| "enum": [ | |
| "cad", | |
| "usd" | |
| ], | |
| "type": "string" | |
| }, | |
| "mandate_options": { | |
| "$ref": "#/definitions/Stripe.SetupIntent.PaymentMethodOptions.AcssDebit.MandateOptions" | |
| }, | |
| "verification_method": { | |
| "$ref": "#/definitions/Stripe.SetupIntent.PaymentMethodOptions.AcssDebit.VerificationMethod", | |
| "description": "Bank account verification method." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SetupIntent.PaymentMethodOptions.AcssDebit.MandateOptions": { | |
| "properties": { | |
| "custom_mandate_url": { | |
| "description": "A URL for custom mandate text", | |
| "type": "string" | |
| }, | |
| "interval_description": { | |
| "description": "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.", | |
| "type": "string" | |
| }, | |
| "payment_schedule": { | |
| "description": "Payment schedule for the mandate.", | |
| "enum": [ | |
| "combined", | |
| "interval", | |
| "sporadic" | |
| ], | |
| "type": "string" | |
| }, | |
| "transaction_type": { | |
| "description": "Transaction type of the mandate.", | |
| "enum": [ | |
| "business", | |
| "personal" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SetupIntent.PaymentMethodOptions.AcssDebit.VerificationMethod": { | |
| "enum": [ | |
| "automatic", | |
| "instant", | |
| "microdeposits" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.SetupIntent.PaymentMethodOptions.Card": { | |
| "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" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SetupIntent.PaymentMethodOptions.SepaDebit": { | |
| "properties": { | |
| "mandate_options": { | |
| "$ref": "#/definitions/Stripe.SetupIntent.PaymentMethodOptions.SepaDebit.MandateOptions" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SetupIntent.PaymentMethodOptions.SepaDebit.MandateOptions": { | |
| "type": "object" | |
| }, | |
| "Stripe.SetupIntent.Status": { | |
| "enum": [ | |
| "canceled", | |
| "processing", | |
| "requires_action", | |
| "requires_confirmation", | |
| "requires_payment_method", | |
| "succeeded" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.SetupIntentsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Sigma.ScheduledQueryRunsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Signature": { | |
| "properties": { | |
| "EXPECTED_SCHEME": { | |
| "enum": [ | |
| "v1" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Sku": { | |
| "description": "The Sku object.", | |
| "properties": { | |
| "active": { | |
| "description": "Whether the SKU is available for purchase.", | |
| "type": "boolean" | |
| }, | |
| "attributes": { | |
| "additionalProperties": { | |
| "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.", | |
| "type": "number" | |
| }, | |
| "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" | |
| }, | |
| "deleted": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "image": { | |
| "description": "The URL of an image for this SKU, meant to be displayable to the customer.", | |
| "type": "string" | |
| }, | |
| "inventory": { | |
| "$ref": "#/definitions/Stripe.Sku.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": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "sku" | |
| ], | |
| "type": "string" | |
| }, | |
| "package_dimensions": { | |
| "$ref": "#/definitions/Stripe.Sku.PackageDimensions", | |
| "description": "The dimensions of this SKU for shipping purposes." | |
| }, | |
| "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": "number" | |
| }, | |
| "product": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Product" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The ID of the product this SKU is associated with. The product must be currently active." | |
| }, | |
| "updated": { | |
| "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Sku.Inventory": { | |
| "properties": { | |
| "quantity": { | |
| "description": "The count of inventory available. Will be present if and only if `type` is `finite`.", | |
| "type": "number" | |
| }, | |
| "type": { | |
| "description": "Inventory type. Possible values are `finite`, `bucket` (not quantified), and `infinite`.", | |
| "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`.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Sku.PackageDimensions": { | |
| "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" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SkusResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Source": { | |
| "description": "The Source object.", | |
| "properties": { | |
| "ach_credit_transfer": { | |
| "$ref": "#/definitions/Stripe.Source.AchCreditTransfer" | |
| }, | |
| "ach_debit": { | |
| "$ref": "#/definitions/Stripe.Source.AchDebit" | |
| }, | |
| "acss_debit": { | |
| "$ref": "#/definitions/Stripe.Source.AcssDebit" | |
| }, | |
| "alipay": { | |
| "$ref": "#/definitions/Stripe.Source.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.", | |
| "type": "number" | |
| }, | |
| "au_becs_debit": { | |
| "$ref": "#/definitions/Stripe.Source.AuBecsDebit" | |
| }, | |
| "bancontact": { | |
| "$ref": "#/definitions/Stripe.Source.Bancontact" | |
| }, | |
| "card": { | |
| "$ref": "#/definitions/Stripe.Source.Card" | |
| }, | |
| "card_present": { | |
| "$ref": "#/definitions/Stripe.Source.CardPresent" | |
| }, | |
| "client_secret": { | |
| "description": "The client secret of the source. Used for client-side retrieval using a publishable key.", | |
| "type": "string" | |
| }, | |
| "code_verification": { | |
| "$ref": "#/definitions/Stripe.Source.CodeVerification" | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "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.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "eps": { | |
| "$ref": "#/definitions/Stripe.Source.Eps" | |
| }, | |
| "flow": { | |
| "description": "The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`.", | |
| "type": "string" | |
| }, | |
| "giropay": { | |
| "$ref": "#/definitions/Stripe.Source.Giropay" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "ideal": { | |
| "$ref": "#/definitions/Stripe.Source.Ideal" | |
| }, | |
| "klarna": { | |
| "$ref": "#/definitions/Stripe.Source.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": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "multibanco": { | |
| "$ref": "#/definitions/Stripe.Source.Multibanco" | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "source" | |
| ], | |
| "type": "string" | |
| }, | |
| "owner": { | |
| "$ref": "#/definitions/Stripe.Source.Owner", | |
| "description": "Information about the owner of the payment instrument that may be used or required by particular source types." | |
| }, | |
| "p24": { | |
| "$ref": "#/definitions/Stripe.Source.P24" | |
| }, | |
| "receiver": { | |
| "$ref": "#/definitions/Stripe.Source.Receiver" | |
| }, | |
| "redirect": { | |
| "$ref": "#/definitions/Stripe.Source.Redirect" | |
| }, | |
| "sepa_credit_transfer": { | |
| "$ref": "#/definitions/Stripe.Source.SepaCreditTransfer" | |
| }, | |
| "sepa_debit": { | |
| "$ref": "#/definitions/Stripe.Source.SepaDebit" | |
| }, | |
| "sofort": { | |
| "$ref": "#/definitions/Stripe.Source.Sofort" | |
| }, | |
| "source_order": { | |
| "$ref": "#/definitions/Stripe.Source.SourceOrder" | |
| }, | |
| "statement_descriptor": { | |
| "description": "Extra information about a source. This will appear on your customer's statement every time you charge the source.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "three_d_secure": { | |
| "$ref": "#/definitions/Stripe.Source.ThreeDSecure" | |
| }, | |
| "type": { | |
| "$ref": "#/definitions/Stripe.Source.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." | |
| }, | |
| "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.", | |
| "type": "string" | |
| }, | |
| "wechat": { | |
| "$ref": "#/definitions/Stripe.Source.Wechat" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Source.AchCreditTransfer": { | |
| "properties": { | |
| "account_number": { | |
| "type": "string" | |
| }, | |
| "bank_name": { | |
| "type": "string" | |
| }, | |
| "fingerprint": { | |
| "type": "string" | |
| }, | |
| "refund_account_holder_name": { | |
| "type": "string" | |
| }, | |
| "refund_account_holder_type": { | |
| "type": "string" | |
| }, | |
| "refund_routing_number": { | |
| "type": "string" | |
| }, | |
| "routing_number": { | |
| "type": "string" | |
| }, | |
| "swift_code": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Source.AchDebit": { | |
| "properties": { | |
| "bank_name": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "fingerprint": { | |
| "type": "string" | |
| }, | |
| "last4": { | |
| "type": "string" | |
| }, | |
| "routing_number": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Source.AcssDebit": { | |
| "properties": { | |
| "bank_address_city": { | |
| "type": "string" | |
| }, | |
| "bank_address_line_1": { | |
| "type": "string" | |
| }, | |
| "bank_address_line_2": { | |
| "type": "string" | |
| }, | |
| "bank_address_postal_code": { | |
| "type": "string" | |
| }, | |
| "bank_name": { | |
| "type": "string" | |
| }, | |
| "category": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "fingerprint": { | |
| "type": "string" | |
| }, | |
| "last4": { | |
| "type": "string" | |
| }, | |
| "routing_number": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Source.Alipay": { | |
| "properties": { | |
| "data_string": { | |
| "type": "string" | |
| }, | |
| "native_url": { | |
| "type": "string" | |
| }, | |
| "statement_descriptor": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Source.AuBecsDebit": { | |
| "properties": { | |
| "bsb_number": { | |
| "type": "string" | |
| }, | |
| "fingerprint": { | |
| "type": "string" | |
| }, | |
| "last4": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Source.Bancontact": { | |
| "properties": { | |
| "bank_code": { | |
| "type": "string" | |
| }, | |
| "bank_name": { | |
| "type": "string" | |
| }, | |
| "bic": { | |
| "type": "string" | |
| }, | |
| "iban_last4": { | |
| "type": "string" | |
| }, | |
| "preferred_language": { | |
| "type": "string" | |
| }, | |
| "statement_descriptor": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Source.Card": { | |
| "properties": { | |
| "address_line1_check": { | |
| "type": "string" | |
| }, | |
| "address_zip_check": { | |
| "type": "string" | |
| }, | |
| "brand": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "cvc_check": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "dynamic_last4": { | |
| "type": "string" | |
| }, | |
| "exp_month": { | |
| "type": "number" | |
| }, | |
| "exp_year": { | |
| "type": "number" | |
| }, | |
| "fingerprint": { | |
| "type": "string" | |
| }, | |
| "funding": { | |
| "type": "string" | |
| }, | |
| "iin": { | |
| "type": "string" | |
| }, | |
| "issuer": { | |
| "type": "string" | |
| }, | |
| "last4": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "three_d_secure": { | |
| "type": "string" | |
| }, | |
| "tokenization_method": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Source.CardPresent": { | |
| "properties": { | |
| "application_cryptogram": { | |
| "type": "string" | |
| }, | |
| "application_preferred_name": { | |
| "type": "string" | |
| }, | |
| "authorization_code": { | |
| "type": "string" | |
| }, | |
| "authorization_response_code": { | |
| "type": "string" | |
| }, | |
| "brand": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "cvm_type": { | |
| "type": "string" | |
| }, | |
| "data_type": { | |
| "type": "string" | |
| }, | |
| "dedicated_file_name": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "emv_auth_data": { | |
| "type": "string" | |
| }, | |
| "evidence_customer_signature": { | |
| "type": "string" | |
| }, | |
| "evidence_transaction_certificate": { | |
| "type": "string" | |
| }, | |
| "exp_month": { | |
| "type": "number" | |
| }, | |
| "exp_year": { | |
| "type": "number" | |
| }, | |
| "fingerprint": { | |
| "type": "string" | |
| }, | |
| "funding": { | |
| "type": "string" | |
| }, | |
| "iin": { | |
| "type": "string" | |
| }, | |
| "issuer": { | |
| "type": "string" | |
| }, | |
| "last4": { | |
| "type": "string" | |
| }, | |
| "pos_device_id": { | |
| "type": "string" | |
| }, | |
| "pos_entry_mode": { | |
| "type": "string" | |
| }, | |
| "read_method": { | |
| "type": "string" | |
| }, | |
| "reader": { | |
| "type": "string" | |
| }, | |
| "terminal_verification_results": { | |
| "type": "string" | |
| }, | |
| "transaction_status_information": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Source.CodeVerification": { | |
| "properties": { | |
| "attempts_remaining": { | |
| "description": "The number of attempts remaining to authenticate the source object with a verification code.", | |
| "type": "number" | |
| }, | |
| "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).", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Source.Eps": { | |
| "properties": { | |
| "reference": { | |
| "type": "string" | |
| }, | |
| "statement_descriptor": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Source.Giropay": { | |
| "properties": { | |
| "bank_code": { | |
| "type": "string" | |
| }, | |
| "bank_name": { | |
| "type": "string" | |
| }, | |
| "bic": { | |
| "type": "string" | |
| }, | |
| "statement_descriptor": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Source.Ideal": { | |
| "properties": { | |
| "bank": { | |
| "type": "string" | |
| }, | |
| "bic": { | |
| "type": "string" | |
| }, | |
| "iban_last4": { | |
| "type": "string" | |
| }, | |
| "statement_descriptor": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Source.Klarna": { | |
| "properties": { | |
| "background_image_url": { | |
| "type": "string" | |
| }, | |
| "client_token": { | |
| "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_delay": { | |
| "type": "number" | |
| }, | |
| "shipping_first_name": { | |
| "type": "string" | |
| }, | |
| "shipping_last_name": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Source.Multibanco": { | |
| "properties": { | |
| "entity": { | |
| "type": "string" | |
| }, | |
| "reference": { | |
| "type": "string" | |
| }, | |
| "refund_account_holder_address_city": { | |
| "type": "string" | |
| }, | |
| "refund_account_holder_address_country": { | |
| "type": "string" | |
| }, | |
| "refund_account_holder_address_line1": { | |
| "type": "string" | |
| }, | |
| "refund_account_holder_address_line2": { | |
| "type": "string" | |
| }, | |
| "refund_account_holder_address_postal_code": { | |
| "type": "string" | |
| }, | |
| "refund_account_holder_address_state": { | |
| "type": "string" | |
| }, | |
| "refund_account_holder_name": { | |
| "type": "string" | |
| }, | |
| "refund_iban": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Source.Owner": { | |
| "properties": { | |
| "address": { | |
| "$ref": "#/definitions/Stripe.Address", | |
| "description": "Owner's address." | |
| }, | |
| "email": { | |
| "description": "Owner's email address.", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "description": "Owner's full name.", | |
| "type": "string" | |
| }, | |
| "phone": { | |
| "description": "Owner's phone number (including extension).", | |
| "type": "string" | |
| }, | |
| "verified_address": { | |
| "$ref": "#/definitions/Stripe.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." | |
| }, | |
| "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.", | |
| "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.", | |
| "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.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Source.P24": { | |
| "properties": { | |
| "reference": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Source.Receiver": { | |
| "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.", | |
| "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": "number" | |
| }, | |
| "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": "number" | |
| }, | |
| "amount_returned": { | |
| "description": "The total amount that was returned to the customer. The amount returned is expressed in the source's currency.", | |
| "type": "number" | |
| }, | |
| "refund_attributes_method": { | |
| "description": "Type of refund attribute method, one of `email`, `manual`, or `none`.", | |
| "type": "string" | |
| }, | |
| "refund_attributes_status": { | |
| "description": "Type of refund attribute status, one of `missing`, `requested`, or `available`.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Source.Redirect": { | |
| "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`.", | |
| "type": "string" | |
| }, | |
| "return_url": { | |
| "description": "The URL you provide to redirect the customer to after they authenticated their payment.", | |
| "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).", | |
| "type": "string" | |
| }, | |
| "url": { | |
| "description": "The URL provided to you to redirect a customer to as part of a `redirect` authentication flow.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Source.SepaCreditTransfer": { | |
| "properties": { | |
| "bank_name": { | |
| "type": "string" | |
| }, | |
| "bic": { | |
| "type": "string" | |
| }, | |
| "iban": { | |
| "type": "string" | |
| }, | |
| "refund_account_holder_address_city": { | |
| "type": "string" | |
| }, | |
| "refund_account_holder_address_country": { | |
| "type": "string" | |
| }, | |
| "refund_account_holder_address_line1": { | |
| "type": "string" | |
| }, | |
| "refund_account_holder_address_line2": { | |
| "type": "string" | |
| }, | |
| "refund_account_holder_address_postal_code": { | |
| "type": "string" | |
| }, | |
| "refund_account_holder_address_state": { | |
| "type": "string" | |
| }, | |
| "refund_account_holder_name": { | |
| "type": "string" | |
| }, | |
| "refund_iban": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Source.SepaDebit": { | |
| "properties": { | |
| "bank_code": { | |
| "type": "string" | |
| }, | |
| "branch_code": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "fingerprint": { | |
| "type": "string" | |
| }, | |
| "last4": { | |
| "type": "string" | |
| }, | |
| "mandate_reference": { | |
| "type": "string" | |
| }, | |
| "mandate_url": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Source.Sofort": { | |
| "properties": { | |
| "bank_code": { | |
| "type": "string" | |
| }, | |
| "bank_name": { | |
| "type": "string" | |
| }, | |
| "bic": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "iban_last4": { | |
| "type": "string" | |
| }, | |
| "preferred_language": { | |
| "type": "string" | |
| }, | |
| "statement_descriptor": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Source.SourceOrder": { | |
| "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": "number" | |
| }, | |
| "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.", | |
| "type": "string" | |
| }, | |
| "items": { | |
| "description": "List of items constituting the order.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.Source.SourceOrder.Item" | |
| }, | |
| "type": "array" | |
| }, | |
| "shipping": { | |
| "$ref": "#/definitions/Stripe.Source.SourceOrder.Shipping" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Source.SourceOrder.Item": { | |
| "properties": { | |
| "amount": { | |
| "description": "The amount (price) for this order item.", | |
| "type": "number" | |
| }, | |
| "currency": { | |
| "description": "This currency of this order item. Required when `amount` is present.", | |
| "type": "string" | |
| }, | |
| "description": { | |
| "description": "Human-readable description for this order item.", | |
| "type": "string" | |
| }, | |
| "parent": { | |
| "description": "The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU).", | |
| "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": "number" | |
| }, | |
| "type": { | |
| "description": "The type of this order item. Must be `sku`, `tax`, or `shipping`.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Source.SourceOrder.Shipping": { | |
| "properties": { | |
| "address": { | |
| "$ref": "#/definitions/Stripe.Address" | |
| }, | |
| "carrier": { | |
| "description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "description": "Recipient name.", | |
| "type": "string" | |
| }, | |
| "phone": { | |
| "description": "Recipient phone (including extension).", | |
| "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.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Source.ThreeDSecure": { | |
| "properties": { | |
| "address_line1_check": { | |
| "type": "string" | |
| }, | |
| "address_zip_check": { | |
| "type": "string" | |
| }, | |
| "authenticated": { | |
| "type": "boolean" | |
| }, | |
| "brand": { | |
| "type": "string" | |
| }, | |
| "card": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "customer": { | |
| "type": "string" | |
| }, | |
| "cvc_check": { | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "dynamic_last4": { | |
| "type": "string" | |
| }, | |
| "exp_month": { | |
| "type": "number" | |
| }, | |
| "exp_year": { | |
| "type": "number" | |
| }, | |
| "fingerprint": { | |
| "type": "string" | |
| }, | |
| "funding": { | |
| "type": "string" | |
| }, | |
| "iin": { | |
| "type": "string" | |
| }, | |
| "issuer": { | |
| "type": "string" | |
| }, | |
| "last4": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "three_d_secure": { | |
| "type": "string" | |
| }, | |
| "tokenization_method": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Source.Type": { | |
| "enum": [ | |
| "ach_credit_transfer", | |
| "ach_debit", | |
| "acss_debit", | |
| "alipay", | |
| "au_becs_debit", | |
| "bancontact", | |
| "card", | |
| "card_present", | |
| "eps", | |
| "giropay", | |
| "ideal", | |
| "klarna", | |
| "multibanco", | |
| "p24", | |
| "sepa_credit_transfer", | |
| "sepa_debit", | |
| "sofort", | |
| "three_d_secure", | |
| "wechat" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Source.Wechat": { | |
| "properties": { | |
| "prepay_id": { | |
| "type": "string" | |
| }, | |
| "qr_code_url": { | |
| "type": "string" | |
| }, | |
| "statement_descriptor": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SourcesResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.StripeAPIError": { | |
| "description": "API errors cover any other type of problem (e.g., a temporary problem with Stripe's servers),\nand are extremely uncommon.\n\nIt could also be raised in the case that a new error has been introduced in the API,\nbut this version of the library doesn't know how to handle it.", | |
| "properties": { | |
| "charge": { | |
| "type": "string" | |
| }, | |
| "code": { | |
| "description": "For card errors, a short string describing the kind of card error that occurred.", | |
| "type": "string" | |
| }, | |
| "decline_code": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| }, | |
| "doc_url": { | |
| "description": "A URL to more information about the error code reported.", | |
| "type": "string" | |
| }, | |
| "headers": { | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "type": "object" | |
| }, | |
| "message": { | |
| "description": "A human-readable message giving more details about the error. For card errors, these messages can\nbe shown to your users.", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "param": { | |
| "description": "The parameter the error relates to if the error is parameter-specific. You can use this to display a\nmessage near the correct form field, for example.", | |
| "type": "string" | |
| }, | |
| "payment_intent": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent" | |
| }, | |
| "payment_method": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod" | |
| }, | |
| "payment_method_type": { | |
| "type": "string" | |
| }, | |
| "raw": { | |
| }, | |
| "rawType": { | |
| "description": "See the \"error types\" section at https://stripe.com/docs/api/errors", | |
| "enum": [ | |
| "api_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "requestId": { | |
| "type": "string" | |
| }, | |
| "setup_intent": { | |
| "$ref": "#/definitions/Stripe.SetupIntent" | |
| }, | |
| "source": { | |
| "$ref": "#/definitions/Stripe.Source" | |
| }, | |
| "stack": { | |
| "type": "string" | |
| }, | |
| "statusCode": { | |
| "description": "Typically a 4xx or 5xx.", | |
| "type": "number" | |
| }, | |
| "type": { | |
| "enum": [ | |
| "StripeAPIError" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.StripeAuthenticationError": { | |
| "description": "Failure to properly authenticate yourself in the request.", | |
| "properties": { | |
| "charge": { | |
| "type": "string" | |
| }, | |
| "code": { | |
| "description": "For card errors, a short string describing the kind of card error that occurred.", | |
| "type": "string" | |
| }, | |
| "decline_code": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| }, | |
| "doc_url": { | |
| "description": "A URL to more information about the error code reported.", | |
| "type": "string" | |
| }, | |
| "headers": { | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "type": "object" | |
| }, | |
| "message": { | |
| "description": "A human-readable message giving more details about the error. For card errors, these messages can\nbe shown to your users.", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "param": { | |
| "description": "The parameter the error relates to if the error is parameter-specific. You can use this to display a\nmessage near the correct form field, for example.", | |
| "type": "string" | |
| }, | |
| "payment_intent": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent" | |
| }, | |
| "payment_method": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod" | |
| }, | |
| "payment_method_type": { | |
| "type": "string" | |
| }, | |
| "raw": { | |
| }, | |
| "rawType": { | |
| "description": "See the \"error types\" section at https://stripe.com/docs/api/errors", | |
| "enum": [ | |
| "authentication_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "requestId": { | |
| "type": "string" | |
| }, | |
| "setup_intent": { | |
| "$ref": "#/definitions/Stripe.SetupIntent" | |
| }, | |
| "source": { | |
| "$ref": "#/definitions/Stripe.Source" | |
| }, | |
| "stack": { | |
| "type": "string" | |
| }, | |
| "statusCode": { | |
| "description": "Typically a 4xx or 5xx.", | |
| "type": "number" | |
| }, | |
| "type": { | |
| "enum": [ | |
| "StripeAuthenticationError" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.StripeCardError": { | |
| "description": "Card errors are the most common type of error you should expect to handle.\nThey result when the user enters a card that can't be charged for some reason.", | |
| "properties": { | |
| "charge": { | |
| "type": "string" | |
| }, | |
| "code": { | |
| "description": "For card errors, a short string describing the kind of card error that occurred.", | |
| "type": "string" | |
| }, | |
| "decline_code": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| }, | |
| "doc_url": { | |
| "description": "A URL to more information about the error code reported.", | |
| "type": "string" | |
| }, | |
| "headers": { | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "type": "object" | |
| }, | |
| "message": { | |
| "description": "A human-readable message giving more details about the error. For card errors, these messages can\nbe shown to your users.", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "param": { | |
| "description": "The parameter the error relates to if the error is parameter-specific. You can use this to display a\nmessage near the correct form field, for example.", | |
| "type": "string" | |
| }, | |
| "payment_intent": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent" | |
| }, | |
| "payment_method": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod" | |
| }, | |
| "payment_method_type": { | |
| "type": "string" | |
| }, | |
| "raw": { | |
| }, | |
| "rawType": { | |
| "description": "See the \"error types\" section at https://stripe.com/docs/api/errors", | |
| "enum": [ | |
| "card_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "requestId": { | |
| "type": "string" | |
| }, | |
| "setup_intent": { | |
| "$ref": "#/definitions/Stripe.SetupIntent" | |
| }, | |
| "source": { | |
| "$ref": "#/definitions/Stripe.Source" | |
| }, | |
| "stack": { | |
| "type": "string" | |
| }, | |
| "statusCode": { | |
| "description": "Typically a 4xx or 5xx.", | |
| "type": "number" | |
| }, | |
| "type": { | |
| "enum": [ | |
| "StripeCardError" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.StripeConnectionError": { | |
| "description": "The library cannot connect to Stripe.\nThis can happen for a variety of reasons,\nsuch as loss of network connectivity or a bad TLS certificate.", | |
| "properties": { | |
| "charge": { | |
| "type": "string" | |
| }, | |
| "code": { | |
| "description": "For card errors, a short string describing the kind of card error that occurred.", | |
| "type": "string" | |
| }, | |
| "decline_code": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| }, | |
| "doc_url": { | |
| "description": "A URL to more information about the error code reported.", | |
| "type": "string" | |
| }, | |
| "headers": { | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "type": "object" | |
| }, | |
| "message": { | |
| "description": "A human-readable message giving more details about the error. For card errors, these messages can\nbe shown to your users.", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "param": { | |
| "description": "The parameter the error relates to if the error is parameter-specific. You can use this to display a\nmessage near the correct form field, for example.", | |
| "type": "string" | |
| }, | |
| "payment_intent": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent" | |
| }, | |
| "payment_method": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod" | |
| }, | |
| "payment_method_type": { | |
| "type": "string" | |
| }, | |
| "raw": { | |
| }, | |
| "rawType": { | |
| "$ref": "#/definitions/Stripe.RawErrorType", | |
| "description": "See the \"error types\" section at https://stripe.com/docs/api/errors" | |
| }, | |
| "requestId": { | |
| "type": "string" | |
| }, | |
| "setup_intent": { | |
| "$ref": "#/definitions/Stripe.SetupIntent" | |
| }, | |
| "source": { | |
| "$ref": "#/definitions/Stripe.Source" | |
| }, | |
| "stack": { | |
| "type": "string" | |
| }, | |
| "statusCode": { | |
| "description": "Typically a 4xx or 5xx.", | |
| "type": "number" | |
| }, | |
| "type": { | |
| "enum": [ | |
| "StripeConnectionError" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.StripeError": { | |
| "properties": { | |
| "charge": { | |
| "type": "string" | |
| }, | |
| "code": { | |
| "description": "For card errors, a short string describing the kind of card error that occurred.", | |
| "type": "string" | |
| }, | |
| "decline_code": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| }, | |
| "doc_url": { | |
| "description": "A URL to more information about the error code reported.", | |
| "type": "string" | |
| }, | |
| "headers": { | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "type": "object" | |
| }, | |
| "message": { | |
| "description": "A human-readable message giving more details about the error. For card errors, these messages can\nbe shown to your users.", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "param": { | |
| "description": "The parameter the error relates to if the error is parameter-specific. You can use this to display a\nmessage near the correct form field, for example.", | |
| "type": "string" | |
| }, | |
| "payment_intent": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent" | |
| }, | |
| "payment_method": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod" | |
| }, | |
| "payment_method_type": { | |
| "type": "string" | |
| }, | |
| "raw": { | |
| }, | |
| "rawType": { | |
| "$ref": "#/definitions/Stripe.RawErrorType", | |
| "description": "See the \"error types\" section at https://stripe.com/docs/api/errors" | |
| }, | |
| "requestId": { | |
| "type": "string" | |
| }, | |
| "setup_intent": { | |
| "$ref": "#/definitions/Stripe.SetupIntent" | |
| }, | |
| "source": { | |
| "$ref": "#/definitions/Stripe.Source" | |
| }, | |
| "stack": { | |
| "type": "string" | |
| }, | |
| "statusCode": { | |
| "description": "Typically a 4xx or 5xx.", | |
| "type": "number" | |
| }, | |
| "type": { | |
| "enum": [ | |
| "StripeAPIError", | |
| "StripeAuthenticationError", | |
| "StripeCardError", | |
| "StripeConnectionError", | |
| "StripeError", | |
| "StripeIdempotencyError", | |
| "StripeInvalidGrantError", | |
| "StripeInvalidRequestError", | |
| "StripePermissionError", | |
| "StripeRateLimitError", | |
| "StripeSignatureVerificationError", | |
| "generate" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.StripeIdempotencyError": { | |
| "description": "Idempotency errors occur when an `Idempotency-Key` is re-used on a request that does not match the first request's API endpoint and parameters.", | |
| "properties": { | |
| "charge": { | |
| "type": "string" | |
| }, | |
| "code": { | |
| "description": "For card errors, a short string describing the kind of card error that occurred.", | |
| "type": "string" | |
| }, | |
| "decline_code": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| }, | |
| "doc_url": { | |
| "description": "A URL to more information about the error code reported.", | |
| "type": "string" | |
| }, | |
| "headers": { | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "type": "object" | |
| }, | |
| "message": { | |
| "description": "A human-readable message giving more details about the error. For card errors, these messages can\nbe shown to your users.", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "param": { | |
| "description": "The parameter the error relates to if the error is parameter-specific. You can use this to display a\nmessage near the correct form field, for example.", | |
| "type": "string" | |
| }, | |
| "payment_intent": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent" | |
| }, | |
| "payment_method": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod" | |
| }, | |
| "payment_method_type": { | |
| "type": "string" | |
| }, | |
| "raw": { | |
| }, | |
| "rawType": { | |
| "description": "See the \"error types\" section at https://stripe.com/docs/api/errors", | |
| "enum": [ | |
| "idempotency_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "requestId": { | |
| "type": "string" | |
| }, | |
| "setup_intent": { | |
| "$ref": "#/definitions/Stripe.SetupIntent" | |
| }, | |
| "source": { | |
| "$ref": "#/definitions/Stripe.Source" | |
| }, | |
| "stack": { | |
| "type": "string" | |
| }, | |
| "statusCode": { | |
| "description": "Typically a 4xx or 5xx.", | |
| "type": "number" | |
| }, | |
| "type": { | |
| "enum": [ | |
| "StripeIdempotencyError" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.StripeInvalidGrantError": { | |
| "description": "InvalidGrantError is raised when a specified code doesn't exist, is\nexpired, has been used, or doesn't belong to you; a refresh token doesn't\nexist, or doesn't belong to you; or if an API key's mode (live or test)\ndoesn't match the mode of a code or refresh token.", | |
| "properties": { | |
| "charge": { | |
| "type": "string" | |
| }, | |
| "code": { | |
| "description": "For card errors, a short string describing the kind of card error that occurred.", | |
| "type": "string" | |
| }, | |
| "decline_code": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| }, | |
| "doc_url": { | |
| "description": "A URL to more information about the error code reported.", | |
| "type": "string" | |
| }, | |
| "headers": { | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "type": "object" | |
| }, | |
| "message": { | |
| "description": "A human-readable message giving more details about the error. For card errors, these messages can\nbe shown to your users.", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "param": { | |
| "description": "The parameter the error relates to if the error is parameter-specific. You can use this to display a\nmessage near the correct form field, for example.", | |
| "type": "string" | |
| }, | |
| "payment_intent": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent" | |
| }, | |
| "payment_method": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod" | |
| }, | |
| "payment_method_type": { | |
| "type": "string" | |
| }, | |
| "raw": { | |
| }, | |
| "rawType": { | |
| "description": "See the \"error types\" section at https://stripe.com/docs/api/errors", | |
| "enum": [ | |
| "invalid_grant" | |
| ], | |
| "type": "string" | |
| }, | |
| "requestId": { | |
| "type": "string" | |
| }, | |
| "setup_intent": { | |
| "$ref": "#/definitions/Stripe.SetupIntent" | |
| }, | |
| "source": { | |
| "$ref": "#/definitions/Stripe.Source" | |
| }, | |
| "stack": { | |
| "type": "string" | |
| }, | |
| "statusCode": { | |
| "description": "Typically a 4xx or 5xx.", | |
| "type": "number" | |
| }, | |
| "type": { | |
| "enum": [ | |
| "StripeInvalidGrantError" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.StripeInvalidRequestError": { | |
| "description": "Invalid request errors arise when your request has invalid parameters.", | |
| "properties": { | |
| "charge": { | |
| "type": "string" | |
| }, | |
| "code": { | |
| "description": "For card errors, a short string describing the kind of card error that occurred.", | |
| "type": "string" | |
| }, | |
| "decline_code": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| }, | |
| "doc_url": { | |
| "description": "A URL to more information about the error code reported.", | |
| "type": "string" | |
| }, | |
| "headers": { | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "type": "object" | |
| }, | |
| "message": { | |
| "description": "A human-readable message giving more details about the error. For card errors, these messages can\nbe shown to your users.", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "param": { | |
| "description": "The parameter the error relates to if the error is parameter-specific. You can use this to display a\nmessage near the correct form field, for example.", | |
| "type": "string" | |
| }, | |
| "payment_intent": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent" | |
| }, | |
| "payment_method": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod" | |
| }, | |
| "payment_method_type": { | |
| "type": "string" | |
| }, | |
| "raw": { | |
| }, | |
| "rawType": { | |
| "description": "See the \"error types\" section at https://stripe.com/docs/api/errors", | |
| "enum": [ | |
| "invalid_request_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "requestId": { | |
| "type": "string" | |
| }, | |
| "setup_intent": { | |
| "$ref": "#/definitions/Stripe.SetupIntent" | |
| }, | |
| "source": { | |
| "$ref": "#/definitions/Stripe.Source" | |
| }, | |
| "stack": { | |
| "type": "string" | |
| }, | |
| "statusCode": { | |
| "description": "Typically a 4xx or 5xx.", | |
| "type": "number" | |
| }, | |
| "type": { | |
| "enum": [ | |
| "StripeInvalidRequestError" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.StripePermissionError": { | |
| "description": "Access was attempted on a resource that wasn't allowed.", | |
| "properties": { | |
| "charge": { | |
| "type": "string" | |
| }, | |
| "code": { | |
| "description": "For card errors, a short string describing the kind of card error that occurred.", | |
| "type": "string" | |
| }, | |
| "decline_code": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| }, | |
| "doc_url": { | |
| "description": "A URL to more information about the error code reported.", | |
| "type": "string" | |
| }, | |
| "headers": { | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "type": "object" | |
| }, | |
| "message": { | |
| "description": "A human-readable message giving more details about the error. For card errors, these messages can\nbe shown to your users.", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "param": { | |
| "description": "The parameter the error relates to if the error is parameter-specific. You can use this to display a\nmessage near the correct form field, for example.", | |
| "type": "string" | |
| }, | |
| "payment_intent": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent" | |
| }, | |
| "payment_method": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod" | |
| }, | |
| "payment_method_type": { | |
| "type": "string" | |
| }, | |
| "raw": { | |
| }, | |
| "rawType": { | |
| "$ref": "#/definitions/Stripe.RawErrorType", | |
| "description": "See the \"error types\" section at https://stripe.com/docs/api/errors" | |
| }, | |
| "requestId": { | |
| "type": "string" | |
| }, | |
| "setup_intent": { | |
| "$ref": "#/definitions/Stripe.SetupIntent" | |
| }, | |
| "source": { | |
| "$ref": "#/definitions/Stripe.Source" | |
| }, | |
| "stack": { | |
| "type": "string" | |
| }, | |
| "statusCode": { | |
| "description": "Typically a 4xx or 5xx.", | |
| "type": "number" | |
| }, | |
| "type": { | |
| "enum": [ | |
| "StripePermissionError" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.StripeRateLimitError": { | |
| "description": "Too many requests hit the API too quickly.", | |
| "properties": { | |
| "charge": { | |
| "type": "string" | |
| }, | |
| "code": { | |
| "description": "For card errors, a short string describing the kind of card error that occurred.", | |
| "type": "string" | |
| }, | |
| "decline_code": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| }, | |
| "doc_url": { | |
| "description": "A URL to more information about the error code reported.", | |
| "type": "string" | |
| }, | |
| "headers": { | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "type": "object" | |
| }, | |
| "message": { | |
| "description": "A human-readable message giving more details about the error. For card errors, these messages can\nbe shown to your users.", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "param": { | |
| "description": "The parameter the error relates to if the error is parameter-specific. You can use this to display a\nmessage near the correct form field, for example.", | |
| "type": "string" | |
| }, | |
| "payment_intent": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent" | |
| }, | |
| "payment_method": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod" | |
| }, | |
| "payment_method_type": { | |
| "type": "string" | |
| }, | |
| "raw": { | |
| }, | |
| "rawType": { | |
| "description": "See the \"error types\" section at https://stripe.com/docs/api/errors", | |
| "enum": [ | |
| "rate_limit_error" | |
| ], | |
| "type": "string" | |
| }, | |
| "requestId": { | |
| "type": "string" | |
| }, | |
| "setup_intent": { | |
| "$ref": "#/definitions/Stripe.SetupIntent" | |
| }, | |
| "source": { | |
| "$ref": "#/definitions/Stripe.Source" | |
| }, | |
| "stack": { | |
| "type": "string" | |
| }, | |
| "statusCode": { | |
| "description": "Typically a 4xx or 5xx.", | |
| "type": "number" | |
| }, | |
| "type": { | |
| "enum": [ | |
| "StripeRateLimitError" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.StripeResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.StripeSignatureVerificationError": { | |
| "description": "The signature verification for a webhook failed.", | |
| "properties": { | |
| "charge": { | |
| "type": "string" | |
| }, | |
| "code": { | |
| "description": "For card errors, a short string describing the kind of card error that occurred.", | |
| "type": "string" | |
| }, | |
| "decline_code": { | |
| "type": "string" | |
| }, | |
| "detail": { | |
| }, | |
| "doc_url": { | |
| "description": "A URL to more information about the error code reported.", | |
| "type": "string" | |
| }, | |
| "headers": { | |
| "additionalProperties": { | |
| "type": "string" | |
| }, | |
| "type": "object" | |
| }, | |
| "message": { | |
| "description": "A human-readable message giving more details about the error. For card errors, these messages can\nbe shown to your users.", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "param": { | |
| "description": "The parameter the error relates to if the error is parameter-specific. You can use this to display a\nmessage near the correct form field, for example.", | |
| "type": "string" | |
| }, | |
| "payment_intent": { | |
| "$ref": "#/definitions/Stripe.PaymentIntent" | |
| }, | |
| "payment_method": { | |
| "$ref": "#/definitions/Stripe.PaymentMethod" | |
| }, | |
| "payment_method_type": { | |
| "type": "string" | |
| }, | |
| "raw": { | |
| }, | |
| "rawType": { | |
| "$ref": "#/definitions/Stripe.RawErrorType", | |
| "description": "See the \"error types\" section at https://stripe.com/docs/api/errors" | |
| }, | |
| "requestId": { | |
| "type": "string" | |
| }, | |
| "setup_intent": { | |
| "$ref": "#/definitions/Stripe.SetupIntent" | |
| }, | |
| "source": { | |
| "$ref": "#/definitions/Stripe.Source" | |
| }, | |
| "stack": { | |
| "type": "string" | |
| }, | |
| "statusCode": { | |
| "description": "Typically a 4xx or 5xx.", | |
| "type": "number" | |
| }, | |
| "type": { | |
| "enum": [ | |
| "StripeSignatureVerificationError" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Subscription": { | |
| "description": "The Subscription object.", | |
| "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.", | |
| "type": "number" | |
| }, | |
| "automatic_tax": { | |
| "$ref": "#/definitions/Stripe.Subscription.AutomaticTax" | |
| }, | |
| "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.", | |
| "type": "number" | |
| }, | |
| "billing_thresholds": { | |
| "$ref": "#/definitions/Stripe.Subscription.BillingThresholds", | |
| "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period" | |
| }, | |
| "cancel_at": { | |
| "description": "A date in the future at which the subscription will automatically get canceled", | |
| "type": "number" | |
| }, | |
| "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 reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.", | |
| "type": "number" | |
| }, | |
| "collection_method": { | |
| "$ref": "#/definitions/Stripe.Subscription.CollectionMethod", | |
| "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." | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "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.", | |
| "type": "number" | |
| }, | |
| "current_period_start": { | |
| "description": "Start of the current period that the subscription has been invoiced for.", | |
| "type": "number" | |
| }, | |
| "customer": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Customer" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedCustomer" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the customer who owns the subscription." | |
| }, | |
| "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`.", | |
| "type": "number" | |
| }, | |
| "default_payment_method": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.PaymentMethod" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source)." | |
| }, | |
| "default_source": { | |
| "anyOf": [ | |
| { | |
| "description": "The resulting source of [a Connect platform debiting a connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account).", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "object": { | |
| "enum": [ | |
| "account" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.AlipayAccount" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.BankAccount" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.BitcoinReceiver" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Card" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.Source" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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 `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_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": "#/definitions/Stripe.TaxRate" | |
| }, | |
| "type": "array" | |
| }, | |
| "discount": { | |
| "$ref": "#/definitions/Stripe.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." | |
| }, | |
| "ended_at": { | |
| "description": "If the subscription has ended, the date the subscription ended.", | |
| "type": "number" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "items": { | |
| "$ref": "#/definitions/Stripe.ApiList<Stripe.SubscriptionItem>", | |
| "description": "List of subscription items, each with an attached price." | |
| }, | |
| "latest_invoice": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Invoice" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The most recent invoice this subscription has generated." | |
| }, | |
| "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": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "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`.", | |
| "type": "number" | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "subscription" | |
| ], | |
| "type": "string" | |
| }, | |
| "pause_collection": { | |
| "$ref": "#/definitions/Stripe.Subscription.PauseCollection", | |
| "description": "If specified, payment collection for this subscription will be paused." | |
| }, | |
| "payment_settings": { | |
| "$ref": "#/definitions/Stripe.Subscription.PaymentSettings", | |
| "description": "Payment settings passed on to invoices created by the subscription." | |
| }, | |
| "pending_invoice_item_interval": { | |
| "$ref": "#/definitions/Stripe.Subscription.PendingInvoiceItemInterval", | |
| "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." | |
| }, | |
| "pending_setup_intent": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.SetupIntent" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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)." | |
| }, | |
| "pending_update": { | |
| "$ref": "#/definitions/Stripe.Subscription.PendingUpdate", | |
| "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." | |
| }, | |
| "schedule": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.SubscriptionSchedule" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The schedule attached to the subscription" | |
| }, | |
| "start_date": { | |
| "description": "Date when the subscription was first created. The date might differ from the `created` date due to backdating.", | |
| "type": "number" | |
| }, | |
| "status": { | |
| "$ref": "#/definitions/Stripe.Subscription.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." | |
| }, | |
| "transfer_data": { | |
| "$ref": "#/definitions/Stripe.Subscription.TransferData", | |
| "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." | |
| }, | |
| "trial_end": { | |
| "description": "If the subscription has a trial, the end of that trial.", | |
| "type": "number" | |
| }, | |
| "trial_start": { | |
| "description": "If the subscription has a trial, the beginning of that trial.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Subscription.AutomaticTax": { | |
| "properties": { | |
| "enabled": { | |
| "description": "Whether Stripe automatically computes tax on this subscription.", | |
| "type": "boolean" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Subscription.BillingThresholds": { | |
| "properties": { | |
| "amount_gte": { | |
| "description": "Monetary threshold that triggers the subscription to create an invoice", | |
| "type": "number" | |
| }, | |
| "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`.", | |
| "type": "boolean" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Subscription.CollectionMethod": { | |
| "enum": [ | |
| "charge_automatically", | |
| "send_invoice" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Subscription.PauseCollection": { | |
| "properties": { | |
| "behavior": { | |
| "$ref": "#/definitions/Stripe.Subscription.PauseCollection.Behavior", | |
| "description": "The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`." | |
| }, | |
| "resumes_at": { | |
| "description": "The time after which the subscription will resume collecting payments.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Subscription.PauseCollection.Behavior": { | |
| "enum": [ | |
| "keep_as_draft", | |
| "mark_uncollectible", | |
| "void" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Subscription.PaymentSettings": { | |
| "properties": { | |
| "payment_method_options": { | |
| "$ref": "#/definitions/Stripe.Subscription.PaymentSettings.PaymentMethodOptions", | |
| "description": "Payment-method-specific configuration to provide to invoices created by the subscription." | |
| }, | |
| "payment_method_types": { | |
| "description": "The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice's default payment method, the subscription's default payment method, the customer's default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).", | |
| "items": { | |
| "enum": [ | |
| "ach_credit_transfer", | |
| "ach_debit", | |
| "au_becs_debit", | |
| "bacs_debit", | |
| "bancontact", | |
| "boleto", | |
| "card", | |
| "fpx", | |
| "giropay", | |
| "ideal", | |
| "sepa_credit_transfer", | |
| "sepa_debit", | |
| "sofort", | |
| "wechat_pay" | |
| ], | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Subscription.PaymentSettings.PaymentMethodOptions": { | |
| "properties": { | |
| "bancontact": { | |
| "$ref": "#/definitions/Stripe.Subscription.PaymentSettings.PaymentMethodOptions.Bancontact", | |
| "description": "This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription." | |
| }, | |
| "card": { | |
| "$ref": "#/definitions/Stripe.Subscription.PaymentSettings.PaymentMethodOptions.Card", | |
| "description": "This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Subscription.PaymentSettings.PaymentMethodOptions.Bancontact": { | |
| "properties": { | |
| "preferred_language": { | |
| "$ref": "#/definitions/Stripe.Subscription.PaymentSettings.PaymentMethodOptions.Bancontact.PreferredLanguage", | |
| "description": "Preferred language of the Bancontact authorization page that the customer is redirected to." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Subscription.PaymentSettings.PaymentMethodOptions.Bancontact.PreferredLanguage": { | |
| "enum": [ | |
| "de", | |
| "en", | |
| "fr", | |
| "nl" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Subscription.PaymentSettings.PaymentMethodOptions.Card": { | |
| "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. 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" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Subscription.PendingInvoiceItemInterval": { | |
| "properties": { | |
| "interval": { | |
| "$ref": "#/definitions/Stripe.Subscription.PendingInvoiceItemInterval.Interval", | |
| "description": "Specifies invoicing frequency. Either `day`, `week`, `month` or `year`." | |
| }, | |
| "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": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Subscription.PendingInvoiceItemInterval.Interval": { | |
| "enum": [ | |
| "day", | |
| "month", | |
| "week", | |
| "year" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Subscription.PendingUpdate": { | |
| "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.", | |
| "type": "number" | |
| }, | |
| "expires_at": { | |
| "description": "The point after which the changes reflected by this update will be discarded and no longer applied.", | |
| "type": "number" | |
| }, | |
| "subscription_items": { | |
| "description": "List of subscription items, each with an attached plan, that will be set if the update is applied.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.SubscriptionItem" | |
| }, | |
| "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.", | |
| "type": "number" | |
| }, | |
| "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.", | |
| "type": "boolean" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Subscription.Status": { | |
| "enum": [ | |
| "active", | |
| "canceled", | |
| "incomplete", | |
| "incomplete_expired", | |
| "past_due", | |
| "trialing", | |
| "unpaid" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.Subscription.TransferData": { | |
| "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.", | |
| "type": "number" | |
| }, | |
| "destination": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Account" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The account where funds from the payment will be transferred to upon payment success." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SubscriptionItem": { | |
| "description": "The SubscriptionItem object.", | |
| "properties": { | |
| "billing_thresholds": { | |
| "$ref": "#/definitions/Stripe.SubscriptionItem.BillingThresholds", | |
| "description": "Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period" | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "deleted": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "metadata": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "subscription_item" | |
| ], | |
| "type": "string" | |
| }, | |
| "plan": { | |
| "$ref": "#/definitions/Stripe.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.\n\nPlans define the base price, currency, and billing cycle for recurring purchases of products.\n[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.\n\nFor example, you might have a single \"gold\" product that has plans for $10/month, $100/year, €9/month, and €90/year.\n\nRelated 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)." | |
| }, | |
| "price": { | |
| "$ref": "#/definitions/Stripe.Price", | |
| "description": "Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products.\n[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.\n\nFor example, you might have a single \"gold\" product that has prices for $10/month, $100/year, and €9 once.\n\nRelated 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)." | |
| }, | |
| "quantity": { | |
| "description": "The [quantity](https://stripe.com/docs/subscriptions/quantities) of the plan to which the customer should be subscribed.", | |
| "type": "number" | |
| }, | |
| "subscription": { | |
| "description": "The `subscription` this `subscription_item` belongs to.", | |
| "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": "#/definitions/Stripe.TaxRate" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SubscriptionItem.BillingThresholds": { | |
| "properties": { | |
| "usage_gte": { | |
| "description": "Usage threshold that triggers the subscription to create an invoice", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SubscriptionItemsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.SubscriptionSchedule": { | |
| "description": "The SubscriptionSchedule object.", | |
| "properties": { | |
| "canceled_at": { | |
| "description": "Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "completed_at": { | |
| "description": "Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "current_phase": { | |
| "$ref": "#/definitions/Stripe.SubscriptionSchedule.CurrentPhase", | |
| "description": "Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`." | |
| }, | |
| "customer": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Customer" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedCustomer" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the customer who owns the subscription schedule." | |
| }, | |
| "default_settings": { | |
| "$ref": "#/definitions/Stripe.SubscriptionSchedule.DefaultSettings" | |
| }, | |
| "end_behavior": { | |
| "$ref": "#/definitions/Stripe.SubscriptionSchedule.EndBehavior", | |
| "description": "Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` and `cancel`." | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "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": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "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": "#/definitions/Stripe.SubscriptionSchedule.Phase" | |
| }, | |
| "type": "array" | |
| }, | |
| "released_at": { | |
| "description": "Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "released_subscription": { | |
| "description": "ID of the subscription once managed by the subscription schedule (if it is released).", | |
| "type": "string" | |
| }, | |
| "status": { | |
| "$ref": "#/definitions/Stripe.SubscriptionSchedule.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)." | |
| }, | |
| "subscription": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Subscription" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the subscription managed by the subscription schedule." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SubscriptionSchedule.CurrentPhase": { | |
| "properties": { | |
| "end_date": { | |
| "description": "The end of this phase of the subscription schedule.", | |
| "type": "number" | |
| }, | |
| "start_date": { | |
| "description": "The start of this phase of the subscription schedule.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SubscriptionSchedule.DefaultSettings": { | |
| "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 during this phase of the schedule.", | |
| "type": "number" | |
| }, | |
| "automatic_tax": { | |
| "$ref": "#/definitions/Stripe.SubscriptionSchedule.DefaultSettings.AutomaticTax" | |
| }, | |
| "billing_cycle_anchor": { | |
| "$ref": "#/definitions/Stripe.SubscriptionSchedule.DefaultSettings.BillingCycleAnchor", | |
| "description": "Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle)." | |
| }, | |
| "billing_thresholds": { | |
| "$ref": "#/definitions/Stripe.SubscriptionSchedule.DefaultSettings.BillingThresholds", | |
| "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period" | |
| }, | |
| "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" | |
| ], | |
| "type": "string" | |
| }, | |
| "default_payment_method": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.PaymentMethod" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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." | |
| }, | |
| "invoice_settings": { | |
| "$ref": "#/definitions/Stripe.SubscriptionSchedule.DefaultSettings.InvoiceSettings", | |
| "description": "The subscription schedule's default invoice settings." | |
| }, | |
| "transfer_data": { | |
| "$ref": "#/definitions/Stripe.SubscriptionSchedule.DefaultSettings.TransferData", | |
| "description": "The account (if any) the associated 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." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SubscriptionSchedule.DefaultSettings.AutomaticTax": { | |
| "properties": { | |
| "enabled": { | |
| "description": "Whether Stripe automatically computes tax on invoices created during this phase.", | |
| "type": "boolean" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SubscriptionSchedule.DefaultSettings.BillingCycleAnchor": { | |
| "enum": [ | |
| "automatic", | |
| "phase_start" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.SubscriptionSchedule.DefaultSettings.BillingThresholds": { | |
| "properties": { | |
| "amount_gte": { | |
| "description": "Monetary threshold that triggers the subscription to create an invoice", | |
| "type": "number" | |
| }, | |
| "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`.", | |
| "type": "boolean" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SubscriptionSchedule.DefaultSettings.InvoiceSettings": { | |
| "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`.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SubscriptionSchedule.DefaultSettings.TransferData": { | |
| "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.", | |
| "type": "number" | |
| }, | |
| "destination": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Account" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The account where funds from the payment will be transferred to upon payment success." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SubscriptionSchedule.EndBehavior": { | |
| "enum": [ | |
| "cancel", | |
| "none", | |
| "release", | |
| "renew" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.SubscriptionSchedule.Phase": { | |
| "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": "#/definitions/Stripe.SubscriptionSchedule.Phase.AddInvoiceItem" | |
| }, | |
| "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.", | |
| "type": "number" | |
| }, | |
| "automatic_tax": { | |
| "$ref": "#/definitions/Stripe.SubscriptionSchedule.Phase.AutomaticTax" | |
| }, | |
| "billing_cycle_anchor": { | |
| "description": "Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).", | |
| "enum": [ | |
| "automatic", | |
| "phase_start" | |
| ], | |
| "type": "string" | |
| }, | |
| "billing_thresholds": { | |
| "$ref": "#/definitions/Stripe.SubscriptionSchedule.Phase.BillingThresholds", | |
| "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period" | |
| }, | |
| "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" | |
| ], | |
| "type": "string" | |
| }, | |
| "coupon": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Coupon" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedCoupon" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the coupon to use during this phase of the subscription schedule." | |
| }, | |
| "default_payment_method": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.PaymentMethod" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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." | |
| }, | |
| "default_tax_rates": { | |
| "description": "The default tax rates to apply to the subscription during this phase of the subscription schedule.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.TaxRate" | |
| }, | |
| "type": "array" | |
| }, | |
| "end_date": { | |
| "description": "The end of this phase of the subscription schedule.", | |
| "type": "number" | |
| }, | |
| "invoice_settings": { | |
| "$ref": "#/definitions/Stripe.SubscriptionSchedule.Phase.InvoiceSettings", | |
| "description": "The invoice settings applicable during this phase." | |
| }, | |
| "items": { | |
| "description": "Subscription items to configure the subscription to during this phase of the subscription schedule.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.SubscriptionSchedule.Phase.Item" | |
| }, | |
| "type": "array" | |
| }, | |
| "proration_behavior": { | |
| "$ref": "#/definitions/Stripe.SubscriptionSchedule.Phase.ProrationBehavior", | |
| "description": "If the subscription schedule will prorate when transitioning to this phase. Possible values are `create_prorations` and `none`." | |
| }, | |
| "start_date": { | |
| "description": "The start of this phase of the subscription schedule.", | |
| "type": "number" | |
| }, | |
| "transfer_data": { | |
| "$ref": "#/definitions/Stripe.SubscriptionSchedule.Phase.TransferData", | |
| "description": "The account (if any) the associated 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." | |
| }, | |
| "trial_end": { | |
| "description": "When the trial ends within the phase.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SubscriptionSchedule.Phase.AddInvoiceItem": { | |
| "properties": { | |
| "price": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Price" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedPrice" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the price used to generate the invoice item." | |
| }, | |
| "quantity": { | |
| "description": "The quantity of the invoice item.", | |
| "type": "number" | |
| }, | |
| "tax_rates": { | |
| "description": "The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.", | |
| "items": { | |
| "$ref": "#/definitions/Stripe.TaxRate" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SubscriptionSchedule.Phase.AutomaticTax": { | |
| "properties": { | |
| "enabled": { | |
| "description": "Whether Stripe automatically computes tax on invoices created during this phase.", | |
| "type": "boolean" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SubscriptionSchedule.Phase.BillingThresholds": { | |
| "properties": { | |
| "amount_gte": { | |
| "description": "Monetary threshold that triggers the subscription to create an invoice", | |
| "type": "number" | |
| }, | |
| "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`.", | |
| "type": "boolean" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SubscriptionSchedule.Phase.InvoiceSettings": { | |
| "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`.", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SubscriptionSchedule.Phase.Item": { | |
| "properties": { | |
| "billing_thresholds": { | |
| "$ref": "#/definitions/Stripe.SubscriptionSchedule.Phase.Item.BillingThresholds", | |
| "description": "Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period" | |
| }, | |
| "plan": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Plan" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedPlan" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the plan to which the customer should be subscribed." | |
| }, | |
| "price": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Price" | |
| }, | |
| { | |
| "$ref": "#/definitions/Stripe.DeletedPrice" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the price to which the customer should be subscribed." | |
| }, | |
| "quantity": { | |
| "description": "Quantity of the plan to which the customer should be subscribed.", | |
| "type": "number" | |
| }, | |
| "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": "#/definitions/Stripe.TaxRate" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SubscriptionSchedule.Phase.Item.BillingThresholds": { | |
| "properties": { | |
| "usage_gte": { | |
| "description": "Usage threshold that triggers the subscription to create an invoice", | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SubscriptionSchedule.Phase.ProrationBehavior": { | |
| "enum": [ | |
| "always_invoice", | |
| "create_prorations", | |
| "none" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.SubscriptionSchedule.Phase.TransferData": { | |
| "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.", | |
| "type": "number" | |
| }, | |
| "destination": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Account" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "The account where funds from the payment will be transferred to upon payment success." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.SubscriptionSchedule.Status": { | |
| "enum": [ | |
| "active", | |
| "canceled", | |
| "completed", | |
| "not_started", | |
| "released" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.SubscriptionSchedulesResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.SubscriptionsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.TaxCode": { | |
| "description": "The TaxCode object.", | |
| "properties": { | |
| "description": { | |
| "description": "A detailed description of which types of products the tax code represents.", | |
| "type": "string" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "description": "A short name for the tax code.", | |
| "type": "string" | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "tax_code" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.TaxCodesResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.TaxDeductedAtSource": { | |
| "description": "The TaxDeductedAtSource object.", | |
| "properties": { | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "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.", | |
| "type": "number" | |
| }, | |
| "period_start": { | |
| "description": "The start of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period.", | |
| "type": "number" | |
| }, | |
| "tax_deduction_account_number": { | |
| "description": "The TAN that was supplied to Stripe when TDS was assessed", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.TaxId": { | |
| "description": "The TaxId object.", | |
| "properties": { | |
| "country": { | |
| "description": "Two-letter ISO code representing the country of the tax ID.", | |
| "type": "string" | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "customer": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Customer" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the customer." | |
| }, | |
| "deleted": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "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": { | |
| "$ref": "#/definitions/Stripe.TaxId.Type", | |
| "description": "Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `us_ein`, or `za_vat`. Note that some legacy tax IDs have type `unknown`" | |
| }, | |
| "value": { | |
| "description": "Value of the tax ID.", | |
| "type": "string" | |
| }, | |
| "verification": { | |
| "$ref": "#/definitions/Stripe.TaxId.Verification", | |
| "description": "Tax ID verification information." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.TaxId.Type": { | |
| "enum": [ | |
| "ae_trn", | |
| "au_abn", | |
| "au_arn", | |
| "br_cnpj", | |
| "br_cpf", | |
| "ca_bn", | |
| "ca_gst_hst", | |
| "ca_pst_bc", | |
| "ca_pst_mb", | |
| "ca_pst_sk", | |
| "ca_qst", | |
| "ch_vat", | |
| "cl_tin", | |
| "es_cif", | |
| "eu_vat", | |
| "gb_vat", | |
| "hk_br", | |
| "id_npwp", | |
| "il_vat", | |
| "in_gst", | |
| "jp_cn", | |
| "jp_rn", | |
| "kr_brn", | |
| "li_uid", | |
| "mx_rfc", | |
| "my_frp", | |
| "my_itn", | |
| "my_sst", | |
| "no_vat", | |
| "nz_gst", | |
| "ru_inn", | |
| "ru_kpp", | |
| "sa_vat", | |
| "sg_gst", | |
| "sg_uen", | |
| "th_vat", | |
| "tw_vat", | |
| "unknown", | |
| "us_ein", | |
| "za_vat" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.TaxId.Verification": { | |
| "properties": { | |
| "status": { | |
| "$ref": "#/definitions/Stripe.TaxId.Verification.Status", | |
| "description": "Verification status, one of `pending`, `verified`, `unverified`, or `unavailable`." | |
| }, | |
| "verified_address": { | |
| "description": "Verified address.", | |
| "type": "string" | |
| }, | |
| "verified_name": { | |
| "description": "Verified name.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.TaxId.Verification.Status": { | |
| "enum": [ | |
| "pending", | |
| "unavailable", | |
| "unverified", | |
| "verified" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.TaxRate": { | |
| "description": "The TaxRate object.", | |
| "properties": { | |
| "active": { | |
| "description": "Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.", | |
| "type": "boolean" | |
| }, | |
| "country": { | |
| "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).", | |
| "type": "string" | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "description": { | |
| "description": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.", | |
| "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.", | |
| "type": "string" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "inclusive": { | |
| "description": "This specifies if the tax rate is inclusive or exclusive.", | |
| "type": "boolean" | |
| }, | |
| "jurisdiction": { | |
| "description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer's invoice.", | |
| "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": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "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" | |
| }, | |
| "state": { | |
| "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, \"NY\" for New York, United States.", | |
| "type": "string" | |
| }, | |
| "tax_type": { | |
| "description": "The high-level tax type, such as `vat` or `sales_tax`.", | |
| "enum": [ | |
| "gst", | |
| "hst", | |
| "pst", | |
| "qst", | |
| "sales_tax", | |
| "vat" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.TaxRatesResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Terminal.ConnectionTokensResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Terminal.LocationsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Terminal.ReadersResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.TokensResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Topup": { | |
| "description": "The Topup object.", | |
| "properties": { | |
| "amount": { | |
| "description": "Amount transferred.", | |
| "type": "number" | |
| }, | |
| "balance_transaction": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.BalanceTransaction" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "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." | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "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.", | |
| "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.", | |
| "type": "number" | |
| }, | |
| "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).", | |
| "type": "string" | |
| }, | |
| "failure_message": { | |
| "description": "Message to user further explaining reason for top-up failure if available.", | |
| "type": "string" | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "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": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "topup" | |
| ], | |
| "type": "string" | |
| }, | |
| "source": { | |
| "$ref": "#/definitions/Stripe.Source", | |
| "description": "`Source` objects allow you to accept a variety of payment methods. They\nrepresent a customer's payment instrument, and can be used with the Stripe API\njust like a `Card` object: once chargeable, they can be charged, or can be\nattached to customers.\n\nRelated guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers)." | |
| }, | |
| "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.", | |
| "type": "string" | |
| }, | |
| "status": { | |
| "$ref": "#/definitions/Stripe.Topup.Status", | |
| "description": "The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`." | |
| }, | |
| "transfer_group": { | |
| "description": "A string that identifies this top-up as part of a group.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.Topup.Status": { | |
| "enum": [ | |
| "canceled", | |
| "failed", | |
| "pending", | |
| "reversed", | |
| "succeeded" | |
| ], | |
| "type": "string" | |
| }, | |
| "Stripe.TopupsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Transfer": { | |
| "description": "The Transfer object.", | |
| "properties": { | |
| "amount": { | |
| "description": "Amount in %s to be transferred.", | |
| "type": "number" | |
| }, | |
| "amount_reversed": { | |
| "description": "Amount in %s reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).", | |
| "type": "number" | |
| }, | |
| "balance_transaction": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.BalanceTransaction" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "Balance transaction that describes the impact of this transfer on your account balance." | |
| }, | |
| "created": { | |
| "description": "Time that this record of the transfer was first created.", | |
| "type": "number" | |
| }, | |
| "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.", | |
| "type": "string" | |
| }, | |
| "destination": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Account" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the Stripe account the transfer was sent to." | |
| }, | |
| "destination_payment": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Charge" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer." | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "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": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "object": { | |
| "description": "String representing the object's type. Objects of the same type share the same value.", | |
| "enum": [ | |
| "transfer" | |
| ], | |
| "type": "string" | |
| }, | |
| "reversals": { | |
| "$ref": "#/definitions/Stripe.ApiList<Stripe.TransferReversal>", | |
| "description": "A list of reversals that have been applied to the transfer." | |
| }, | |
| "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": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Charge" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance." | |
| }, | |
| "source_type": { | |
| "description": "The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`.", | |
| "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.", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.TransferReversal": { | |
| "description": "The TransferReversal object.", | |
| "properties": { | |
| "amount": { | |
| "description": "Amount, in %s.", | |
| "type": "number" | |
| }, | |
| "balance_transaction": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.BalanceTransaction" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "Balance transaction that describes the impact on your account balance." | |
| }, | |
| "created": { | |
| "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", | |
| "type": "number" | |
| }, | |
| "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": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Refund" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "Linked payment refund for the transfer reversal." | |
| }, | |
| "id": { | |
| "description": "Unique identifier for the object.", | |
| "type": "string" | |
| }, | |
| "metadata": { | |
| "$ref": "#/definitions/Stripe.Metadata", | |
| "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format." | |
| }, | |
| "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": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Refund" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the refund responsible for the transfer reversal." | |
| }, | |
| "transfer": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/definitions/Stripe.Transfer" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "description": "ID of the transfer that was reversed." | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Stripe.TransfersResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.WebhookEndpointsResource": { | |
| "type": "object" | |
| }, | |
| "Stripe.Webhooks": { | |
| "properties": { | |
| "signature": { | |
| "$ref": "#/definitions/Stripe.Signature" | |
| } | |
| }, | |
| "type": "object" | |
| } | |
| }, | |
| "properties": { | |
| "StripeResource": { | |
| "$ref": "#/definitions/Stripe.StripeResource" | |
| }, | |
| "accountLinks": { | |
| "$ref": "#/definitions/Stripe.AccountLinksResource" | |
| }, | |
| "accounts": { | |
| "$ref": "#/definitions/Stripe.AccountsResource", | |
| "description": "Top Level Resources" | |
| }, | |
| "applePayDomains": { | |
| "$ref": "#/definitions/Stripe.ApplePayDomainsResource" | |
| }, | |
| "applicationFees": { | |
| "$ref": "#/definitions/Stripe.ApplicationFeesResource" | |
| }, | |
| "balance": { | |
| "$ref": "#/definitions/Stripe.BalanceResource" | |
| }, | |
| "balanceTransactions": { | |
| "$ref": "#/definitions/Stripe.BalanceTransactionsResource" | |
| }, | |
| "billingPortal": { | |
| "description": "Namespaced Resources", | |
| "properties": { | |
| "configurations": { | |
| "$ref": "#/definitions/Stripe.BillingPortal.ConfigurationsResource" | |
| }, | |
| "sessions": { | |
| "$ref": "#/definitions/Stripe.BillingPortal.SessionsResource" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "charges": { | |
| "$ref": "#/definitions/Stripe.ChargesResource" | |
| }, | |
| "checkout": { | |
| "properties": { | |
| "sessions": { | |
| "$ref": "#/definitions/Stripe.Checkout.SessionsResource" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "countrySpecs": { | |
| "$ref": "#/definitions/Stripe.CountrySpecsResource" | |
| }, | |
| "coupons": { | |
| "$ref": "#/definitions/Stripe.CouponsResource" | |
| }, | |
| "creditNotes": { | |
| "$ref": "#/definitions/Stripe.CreditNotesResource" | |
| }, | |
| "customers": { | |
| "$ref": "#/definitions/Stripe.CustomersResource" | |
| }, | |
| "disputes": { | |
| "$ref": "#/definitions/Stripe.DisputesResource" | |
| }, | |
| "ephemeralKeys": { | |
| "$ref": "#/definitions/Stripe.EphemeralKeysResource" | |
| }, | |
| "errors": { | |
| "properties": { | |
| "StripeAPIError": { | |
| "description": "API errors cover any other type of problem (e.g., a temporary problem with Stripe's servers),\nand are extremely uncommon.\n\nIt could also be raised in the case that a new error has been introduced in the API,\nbut this version of the library doesn't know how to handle it.", | |
| "properties": { | |
| "prepareStackTrace": { | |
| "description": "Optional override for formatting stack traces", | |
| "type": "object" | |
| }, | |
| "prototype": { | |
| "$ref": "#/definitions/Stripe.StripeAPIError" | |
| }, | |
| "stackTraceLimit": { | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "StripeAuthenticationError": { | |
| "description": "Failure to properly authenticate yourself in the request.", | |
| "properties": { | |
| "prepareStackTrace": { | |
| "description": "Optional override for formatting stack traces", | |
| "type": "object" | |
| }, | |
| "prototype": { | |
| "$ref": "#/definitions/Stripe.StripeAuthenticationError" | |
| }, | |
| "stackTraceLimit": { | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "StripeCardError": { | |
| "description": "Card errors are the most common type of error you should expect to handle.\nThey result when the user enters a card that can't be charged for some reason.", | |
| "properties": { | |
| "prepareStackTrace": { | |
| "description": "Optional override for formatting stack traces", | |
| "type": "object" | |
| }, | |
| "prototype": { | |
| "$ref": "#/definitions/Stripe.StripeCardError" | |
| }, | |
| "stackTraceLimit": { | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "StripeConnectionError": { | |
| "description": "The library cannot connect to Stripe.\nThis can happen for a variety of reasons,\nsuch as loss of network connectivity or a bad TLS certificate.", | |
| "properties": { | |
| "prepareStackTrace": { | |
| "description": "Optional override for formatting stack traces", | |
| "type": "object" | |
| }, | |
| "prototype": { | |
| "$ref": "#/definitions/Stripe.StripeConnectionError" | |
| }, | |
| "stackTraceLimit": { | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "StripeError": { | |
| "properties": { | |
| "prepareStackTrace": { | |
| "description": "Optional override for formatting stack traces", | |
| "type": "object" | |
| }, | |
| "prototype": { | |
| "$ref": "#/definitions/Stripe.StripeError" | |
| }, | |
| "stackTraceLimit": { | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "StripeIdempotencyError": { | |
| "description": "Idempotency errors occur when an `Idempotency-Key` is re-used on a request that does not match the first request's API endpoint and parameters.", | |
| "properties": { | |
| "prepareStackTrace": { | |
| "description": "Optional override for formatting stack traces", | |
| "type": "object" | |
| }, | |
| "prototype": { | |
| "$ref": "#/definitions/Stripe.StripeIdempotencyError" | |
| }, | |
| "stackTraceLimit": { | |
| "type": "number" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "StripeInvalidGrantError": { | |
| "description": "InvalidGrantError is raised when a specified code doesn't exist, is\nexpired, has been used, or doesn't belong to you; a refresh token doesn't\nexist, or doesn't belong to you; or if an API key's mode (live or test)\ndoesn't match the mode of a code or refresh token.", | |
| "properties": { | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment